TWtwilio
FlexV1InteractionChannel

Fetch a Channel for an Interaction.

Changed on

Fetch a Channel for an Interaction.

get/v1/Interactions/{InteractionSid}/Channels/{Sid}

Request

  • Base URL
    https://flex-api.twilio.com
  • URL
    https://flex-api.twilio.com/v1/Interactions/{InteractionSid}/Channels/{Sid}
  • Auth
    HTTP basic

Path parameters

InteractionSidstring required

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

Sidstring required

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

Response

OK

sidstring nullable

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

interaction_sidstring nullable

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

type'voice' | 'sms' | 'email' | 'web' | 'whatsapp' | 'chat' | 'messenger' | 'gbm'

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

status'setup' | 'active' | 'failed' | 'closed' | 'inactive' | 'pause' | 'transfer'

The status of this channel.

error_codeinteger nullable

The Twilio error code for a failed channel.

error_messagestring nullable

The error message for a failed channel.

urlstring uri nullable
linksobject nullable

Changes

  • v1d40b4b62cccaRevision changes
    • warning

      added the new transfer enum value to the response property for the response status

  • v15e836d70ffe8Revision changes
    • warning

      added the new pause enum value to the response property for the response status