Skip to main content
POST
/
v1
/
channels
/
phone
Create Phone Channel
curl --request POST \
  --url https://{api_endpoint}/api/v1/channels/phone \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "security": {
    "api_key": "<string>",
    "client_secret": "<string>",
    "secure_trunking": false,
    "authentication": false,
    "username": "<string>",
    "password": "<string>",
    "password_is_set": false
  },
  "description": "<string>",
  "service_provider": "sip_trunk",
  "custom_invite_headers": [],
  "put_caller_on_hold_on_transfer": true,
  "send_provisional_response": true,
  "error_handling": {}
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required
Maximum string length: 64
security
PhoneSecurity · object
required
description
string | null
Maximum string length: 1024
service_provider
enum<string>
default:sip_trunk
Available options:
sip_trunk,
genesys_audio_connector
custom_invite_headers
CustomInviteHeader · object[] | null
put_caller_on_hold_on_transfer
boolean | null
default:true
send_provisional_response
boolean | null
default:true
error_handling
PhoneErrorHandling · object

Response

Successful Response