Add Twilio Number

Purchase a Twilio number and associate it with a channel.

POST/api/v1/channels/twilio/{channel_id}/numbers

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

Path parameters

channel_id integer path required

Request body

application/json

body TwilioNumberAddRequest required

2 fields

friendly_namestringrequired

Friendly name for the Twilio number

area_codestringrequired

Area code for the Twilio number

Request example

{
  "friendly_name": "string",
  "area_code": "string"
}

Responses

200Successful Response

application/json

response TwilioNumberAddResponse required

1 field

phone_numberstringrequired

The purchased Twilio phone number

Response example

{
  "phone_number": "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"
    }
  ]
}

Code examples

import { SyllableSDK } from "syllable-sdk";

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

async function run() {
  const result = await syllableSDK.channels.twilio.numbers.add({
    channelId: 314558,
    twilioNumberAddRequest: {
      friendlyName: "Support Line",
      areaCode: "804",
    },
  });

  console.log(result);
}

run();

import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLE_API_KEY", ""),
) as ss_client:

    res = ss_client.channels.twilio.numbers.add(channel_id=314558, twilio_number_add_request={
        "friendly_name": "Support Line",
        "area_code": "804",
    })

    # Handle response
    print(res)

curl --request POST \
  --url 'https://api.syllable.cloud/api/v1/channels/twilio/%7Bchannel_id%7D/numbers' \
  --header 'content-type: application/json' \
  --data '{
  "friendly_name": "string",
  "area_code": "string"
}'