Update an existing Interaction Channel.

POST /v1/Interactions/{InteractionSid}/Channels/{Sid}
Account sid auth token

Update an existing Interaction Channel.

Path parameters

  • InteractionSid string Required

    The unique string created by Twilio to identify an Interaction resource, prefixed with KD.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^KD[0-9a-fA-F]{32}$.

  • Sid string Required

    The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^UO[0-9a-fA-F]{32}$.

application/x-www-form-urlencoded

Body

  • Status string Required

    Values are closed or inactive.

  • Routing

    It changes the state of associated tasks. Routing status is required, When the channel status is set to inactive. Allowed Value for routing status is closed. Otherwise Optional, if not specified, all tasks will be set to wrapping.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • sid string | null

      The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^UO[0-9a-fA-F]{32}$.

    • interaction_sid string | null

      The unique string created by Twilio to identify an Interaction resource, prefixed with KD.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^KD[0-9a-fA-F]{32}$.

    • type string

      The Interaction Channel's type. Can be: sms, email, chat, whatsapp, web, messenger, or gbm. Note: These can be different from the task channel type specified in the Routing attributes. Task channel type corresponds to channel capacity while this channel type is the actual media type

      Values are voice, sms, email, web, whatsapp, chat, messenger, or gbm.

    • status string

      The status of this channel.

      Values are setup, active, failed, closed, or inactive.

    • error_code integer | null

      The Twilio error code for a failed channel.

    • error_message string | null

      The error message for a failed channel.

    • url string(uri) | null
    • links object(uri-map) | null
POST /v1/Interactions/{InteractionSid}/Channels/{Sid} 
curl \
 --request POST 'https://flex-api.twilio.com/v1/Interactions/{InteractionSid}/Channels/{Sid}' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Status=closed'
Request examples 
{"Status"=>"closed"}
{"Status"=>"closed"}
{"Status"=>"inactive", "Routing"=>"{\"status\":\"closed\"}"}
Response examples (200) 
{
  "sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",
  "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",
  "type": "chat",
  "links": {
    "invites": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Invites",
    "transfers": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Transfers",
    "participants": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants"
  },
  "status": "closed",
  "error_code": 19025,
  "error_message": "Channel validation error",
  "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
{
  "sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",
  "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",
  "type": "chat",
  "links": {
    "invites": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Invites",
    "transfers": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Transfers",
    "participants": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants"
  },
  "status": "failed",
  "error_code": 19025,
  "error_message": "Channel validation error",
  "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
{
  "sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",
  "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",
  "type": "email",
  "links": {
    "invites": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Invites",
    "transfers": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Transfers",
    "participants": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants"
  },
  "status": "inactive",
  "error_code": null,
  "error_message": "",
  "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}