Skip to main content
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>",
  "description": "<string>",
  "service_provider": "sip_trunk",
  "custom_invite_headers": [
    {
      "name": "<string>"
    }
  ],
  "put_caller_on_hold_on_transfer": true,
  "send_provisional_response": true,
  "security": {
    "api_key": "<string>",
    "client_secret": "<string>",
    "secure_trunking": true,
    "authentication": true,
    "username": "<string>",
    "password": "<string>",
    "password_is_set": true
  },
  "error_handling": {}
}'
"<any>"

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 length: 64
​
security
object
required
​
description
string | null
Maximum length: 1024
​
service_provider
enum<string>
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
object

Response

Successful Response

The response is of type any.