Get Twilio Channel By Id

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

Typescript (SDK)

TypeScript

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.channels.twilio.getById({
    channelId: 627671,
  });

  console.log(result);
}

run();

200

{
  "name": "<string>",
  "id": 123,
  "supported_modes": "chat,voice",
  "is_system_channel": true,
  "config": {
    "telephony": {
      "interruptibility": "dtmf_only",
      "overall_input_timeout": 20,
      "passive_input_start": 0.5,
      "passive_speech_input_enabled": true,
      "pre_input_timeout": 1.2
    }
  }
}

Authorizations

Syllable-API-Key · string · header · required

Path Parameters

channel_id · integer · required

Response

200

application/json

Successful Response

name · string · required

The channel name

Example:

"syllable-webchat"

channel_service · enum<string> · required

The service that facilitates communication on the channel

Available options: sip, twilio, email, webchat, africastalking, whatsapp

Example:

"webchat"

id · integer · required

The channel ID

supported_modes · string | null

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

Example:

"chat,voice"

is_system_channel · boolean · default: true

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

Example:

false

config · ChannelConfigView · object | null

Configuration for the channel

Show child attributes

Example:

{
  "telephony": {
    "interruptibility": "dtmf_only",
    "overall_input_timeout": 20,
    "passive_input_start": 0.5,
    "passive_speech_input_enabled": true,
    "pre_input_timeout": 1.2
  }
}