API Reference
API Reference

Get Channels

GET/api/v1/channels/

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Query parameters

page integer | null query optional

The page number from which to start (0-based)

Default 0Minimum 0Example 0
limit integer query optional

The maximum number of items to return

Default 25Minimum 0Example 25
search_fields enum<string>[] query optional

String names of fields to search. Correspond by index to search field values

Default []Example name
Item schema
itemsenum<string>required

Names of channel fields supported for filtering/sorting on list endpoint.

Allowed values ["id","name","name_exact","channel_service","supported_modes","config"]
search_field_values string[] query optional

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

Default []Example Some Object Name
Item schema
itemsstringrequired
order_by enum<string> | null query optional

The field whose value should be used to order the results

Allowed values ["id","name","name_exact","channel_service","supported_modes","config"]Example name
order_by_direction enum<string> | null query optional

The direction in which to order the results

Allowed values ["asc","desc"]
fields enum<string>[] | null query optional

The fields to include in the response

Default []Example []
Item schema
itemsenum<string>required

Names of channel fields supported for filtering/sorting on list endpoint.

Allowed values ["id","name","name_exact","channel_service","supported_modes","config"]
start_datetime string | null query optional

The start datetime for filtering results

Example 2023-01-01T00:00:00Z
end_datetime string | null query optional

The end datetime for filtering results

Example 2024-01-01T00:00:00Z

Responses

200Successful Response

application/json

response ListResponse_Channel_ required
5 fields
itemsChannel[]required

List of items returned from the query

Item schema
itemsChannelrequired
6 fields
namestringrequired

The channel name

channel_serviceenum<string>required

The service that facilitates communication on the channel

Allowed values ["sip","twilio","email","webchat","africastalking","whatsapp"]
supported_modesstring | nulloptional

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

is_system_channelbooleanoptional

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

Default true
idintegerrequired

The channel ID

configChannelConfigView | nulloptional

Configuration for the channel

3 options
telephonyTelephonyConfigurations | nulloptional

Telephony configurations to be applied to targets belonging to the channel. Only applies to voice supported channels.

11 options
pre_input_timeoutnumber | nulloptional

Pre input silence threshold

Minimum 0Maximum 10
post_speech_input_timeoutnumber | nulloptional

Post speech silence timeout to determine input as ended.

Minimum 0Maximum 10
post_dtmf_input_timeoutnumber | nulloptional

Post dtmf silence timeout to determine input as ended.

Minimum 0Maximum 10
overall_input_timeoutnumber | nulloptional

Total input timeout

Minimum 0Maximum 300
output_paddingnumber | nulloptional

Number of seconds to start listening to user input before assistant speech ends

Minimum -5Maximum 5
interruptibilitystring | nulloptional

Interruptibility setting for user input.Valid values: none, dtmf_only, speech_only, all

passive_speech_input_enabledboolean | nulloptional

Whether passive speech input is enabled (input while assistant is speaking)

passive_input_startnumber | nulloptional

Waiting time to start passive input (in seconds) after start of assistant speech

Minimum 0Maximum 5
async_enabledboolean | nulloptional

Whether asynchronous mode is enabled for the conversation

Default true
transfer_leg_voicemail_detection_enabledboolean | nulloptional

Whether transfer leg voicemail detection is enabled

sip_configurationSipConfiguration | nulloptional

SIP routing configuration applied when transferring calls on this channel

3 options
sip_transfer_modeenum<string> | nulloptional

How to perform the SIP transfer, INVITE or REFER.

Allowed values ["refer","invite"]
sip_endpointsSipEndpoint[] | nulloptional

List of SIP endpoints to attempt for the transfer.

Item schema
itemsSipEndpointrequired

A single SIP endpoint to attempt for a transfer.

3 fields
hoststringrequired

SIP endpoint host (IP address or hostname).

portstring | nulloptional

SIP endpoint port.

transportenum<string> | nulloptional

SIP transport protocol, e.g. tcp, tls or udp.

Allowed values ["tls","tcp","udp"]
call_info_placementstring | nulloptional

Where to place call information during a transfer. Supported values are uri_parameters, to_parameters, from_parameters, or sip_header:<header-name>.

emailEmailConfigurations | nulloptional

Email configurations for email channels. Only applies to email channels.

1 options
sending_domainstringrequired

The domain to use for sending emails. Must be authenticated in SendGrid.

credentialsobject | nulloptional

Exposed credentials for the channel - currently just account_sid_last_four for Twilio channels

1 options
{key}stringoptional
pageintegerrequired

The page number of the results (0-based)

page_sizeintegerrequired

The number of items returned per page

total_pagesinteger | nulloptional

The total number of pages of results given the indicated page size

total_countinteger | nulloptional

The total number of items returned from the query

Response example
{
  "items": [
    {
      "name": "string",
      "channel_service": "string",
      "supported_modes": "string",
      "is_system_channel": true,
      "id": 0,
      "config": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_pages": "string",
  "total_count": "string"
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}