Menu

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

REST API: TaskChannels

TaskChannels provide a mechanism to separate tasks of different types.

Workers can be specified to have different concurrent capacity for tasks of each type. When MultiTasking is enabled, specify the task type by passing appropriate TaskChannel Unique Name or SID shown below.

Actions


List all TaskChannels

Resource URI

GET /v1/Workspaces/{WorkspaceSid}/TaskChannels

Returns the list of TaskChannels in the Workspace {WorkspaceSid}.

Example

An example that lists all TaskChannels in a workspace

Loading Code Sample...
      
      
      
      


      Create a TaskChannel

      Resource URI

      POST /v1/Workspaces/{WorkspaceSid}/TaskChannels
      

      Creates a TaskChannel in Workspace {WorkspaceSid}.

      Example

      Example for creating a TaskChannel in a Workspace.

      Loading Code Sample...
          
          
          
          
          Required Parameters
          Parameter Description
          FriendlyName A human-readable name for the TaskChannel. Must be unique in this Workspace. (🏢 not PII )
          UniqueName A unique name for the TaskChannel. Must be unique in this Workspace. (🏢 not PII )

          Example: Create a TaskChannel by POSTing the TaskChannel to the Workflow. For example:


          Retrieve a TaskChannel

          Resource URI

          GET /v1/Workspaces/{WorkspaceSid}/TaskChannels/{TaskChannelSid}
          

          Returns a single TaskChannel {TaskChannelSid}.

          Example

          Example for retrieving a TaskChannel in a Workspace.

          Loading Code Sample...
              
              
              
              

              A TaskChannel instance resource is represented by the following properties:

              Field Description
              Sid The unique ID of the TaskChannel
              AccountSid The ID of the account that owns this TaskChannel
              WorkspaceSid The ID of the Workspace that holds this TaskChannel
              FriendlyName The human-readable name for the TaskChannel that is unique within this Workspace.
              UniqueName The unique name of the TaskChannel in this Workspace.
              DateCreated Date this TaskChannel was created, given as ISO 8601 format.
              DateUpdated Date this TaskChannel was updated, given as ISO 8601 format.

              Update a TaskChannel

              Resource URI

              POST /v1/Workspaces/{WorkspaceSid}/TaskChannels/{TaskChannelSid}
              

              Updates a single TaskChannel {TaskChannelSid}.

              Example

              Example for updating a TaskChannel in a Workspace.

              Loading Code Sample...
                  
                  
                  
                  
                  POST Parameters
                  Parameter Description
                  FriendlyName A human-readable name for the TaskChannel. Must be unique in this Workspace. (🏢 not PII )

                  Delete a TaskChannel

                  Resource URI

                  DELETE /v1/Workspaces/{WorkspaceSid}/TaskChannels/{TaskChannelSid}
                  

                  Delete the TaskChannel {TaskChannelSid}.

                  Example

                  Example for delete a TaskChannel in a Workspace.

                  Loading Code Sample...
                      
                      
                      
                      

                      Need some help?

                      We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.

                      Loading Code Sample...