Sign in
channels.twilio

Get Twilio Channel By Id

get/api/v1/channels/twilio/{channel_id}

Path parameters

channel_idinteger required

Response

Successful Response

namestring required

The channel name

channel_service'sip' | 'twilio' | 'email' | 'webchat' | 'africastalking' | 'whatsapp' required

The communication service for a channel.

supported_modesstring nullable

The comma-delimited list of supported modes for the channel, which defines the possible communication methods for channel targets linked to it.

is_system_channelboolean

Whether the channel is a built-in system channel (i.e., is not customizable)

idinteger required

The channel ID

Example response

{
  "name": "syllable-webchat",
  "supported_modes": "chat,voice",
  "config": {
    "telephony": {
      "sip_configuration": {
        "sip_endpoints": [
          {
            "host": "10.0.0.1",
            "port": "5060",
            "transport": "tcp"
          },
          {
            "host": "pbx.example.com",
            "port": "5071",
            "transport": "tls"
          }
        ],
        "call_info_placement": "uri_parameters"
      }
    },
    "email": {
      "sending_domain": "mail.example.com"
    },
    "credentials": {
      "account_sid_last_four": "1234"
    }
  }
}

Changes

Changed in 2 of the 97 revisions of this API.2

  • d8d2392b570d1See the full diff
    • ○

      added the optional property config/anyOf[subschema #1: ChannelConfigView]/telephony/anyOf[subschema #1: TelephonyConfigurations]/sip_configuration/anyOf[subschema #1: SipConfiguration]/call_info_placement to the response with the 200 status

      response-optional-property-added

  • f5f340f22eef1See the full diff
    • ○

      added the optional property config/anyOf[subschema #1: ChannelConfigView]/telephony/anyOf[subschema #1: TelephonyConfigurations]/sip_configuration to the response with the 200 status

      response-optional-property-added

Of the 97 revisions, 1 has no diff computed.