Create Twilio Channel

curl --request POST \
  --url https://api.syllable.cloud/api/v1/channels/twilio/ \
  --header 'Content-Type: application/json' \
  --header 'Syllable-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "config": {
    "account_sid": "<string>",
    "auth_token": "<string>"
  }
}
'

import requests

url = "https://api.syllable.cloud/api/v1/channels/twilio/"

payload = {
    "name": "<string>",
    "config": {
        "account_sid": "<string>",
        "auth_token": "<string>"
    }
}
headers = {
    "Syllable-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Syllable-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', config: {account_sid: '<string>', auth_token: '<string>'}})
};

fetch('https://api.syllable.cloud/api/v1/channels/twilio/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.syllable.cloud/api/v1/channels/twilio/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'config' => [
        'account_sid' => '<string>',
        'auth_token' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Syllable-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.syllable.cloud/api/v1/channels/twilio/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"config\": {\n    \"account_sid\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Syllable-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.syllable.cloud/api/v1/channels/twilio/")
  .header("Syllable-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"config\": {\n    \"account_sid\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.syllable.cloud/api/v1/channels/twilio/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Syllable-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"config\": {\n    \"account_sid\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "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
    }
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

api

channels

twilio

Create Twilio Channel

curl --request POST \
  --url https://api.syllable.cloud/api/v1/channels/twilio/ \
  --header 'Content-Type: application/json' \
  --header 'Syllable-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "config": {
    "account_sid": "<string>",
    "auth_token": "<string>"
  }
}
'

import requests

url = "https://api.syllable.cloud/api/v1/channels/twilio/"

payload = {
    "name": "<string>",
    "config": {
        "account_sid": "<string>",
        "auth_token": "<string>"
    }
}
headers = {
    "Syllable-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Syllable-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', config: {account_sid: '<string>', auth_token: '<string>'}})
};

fetch('https://api.syllable.cloud/api/v1/channels/twilio/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.syllable.cloud/api/v1/channels/twilio/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'config' => [
        'account_sid' => '<string>',
        'auth_token' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Syllable-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.syllable.cloud/api/v1/channels/twilio/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"config\": {\n    \"account_sid\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Syllable-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.syllable.cloud/api/v1/channels/twilio/")
  .header("Syllable-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"config\": {\n    \"account_sid\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.syllable.cloud/api/v1/channels/twilio/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Syllable-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"config\": {\n    \"account_sid\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "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
    }
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Syllable-API-Key

string

header

required

Body

application/json

Request model for creating a Twilio channel.

name

string

required

The channel name

Example:

"syllable-webchat"

config

TwilioChannelConfigCreate · object

required

The configuration of the channel

Show child attributes

Response

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"

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
  }
}

⌘I