Class: Channel

Channel

A Channel distinguishes Tasks into specific types (e.g. Default, Chat, SMS, Video, Voice)


Properties:
Name Type Description
accountSid string

The sid of the Twilio account

assignedTasks number

The number of Tasks assigned to this Channel

available boolean

If the Worker should be assigned Tasks of this Channel type

availableCapacityPercentage number

The current available capacity of this Worker to handle Tasks of this Channel type

capacity number

The number of Tasks that a Worker can handle of this Channel type

lastReservedTime Date

The date when the Channel last saw a Task

dateCreated Date

The date this Channel was created

dateUpdated Date

The date this Channel was last updated

sid string

The sid of this Activity

taskChannelSid string

The sid of the TaskChannel associated to this Worker Channel

taskChannelUniqueName string

The friendly name of this Channel

workerSid string

The sid of the Worker owning this Channel

workspaceSid string

The sid of the Workspace owning this Activity

Fires:

Extends

  • EventEmitter

Members


<readonly> accountSid :string

Type:
  • string

<readonly> assignedTasks :number

Type:
  • number

<readonly> available :boolean

Type:
  • boolean

<readonly> availableCapacityPercentage :number

Type:
  • number

<readonly> capacity :number

Type:
  • number

<readonly> dateCreated :Date

Type:
  • Date

<readonly> dateUpdated :Date

Type:
  • Date

<readonly> lastReservedTime :Date

Type:
  • Date

<readonly> sid :string

Type:
  • string

<readonly> taskChannelSid :string

Type:
  • string

<readonly> taskChannelUniqueName :string

Type:
  • string

<readonly> workerSid :string

Type:
  • string

<readonly> workspaceSid :string

Type:
  • string

Events


availabilityUpdated

The availability of this Channel was updated

Parameters:
Name Type Description
channel Channel

The Channel whose availability was updated


capacityUpdated

The capacity of this Channel was updated

Parameters:
Name Type Description
channel Channel

The Channel whose capacity was updated