Create a SIP trunk

Create a new SIP trunk for call transfers. Passwords are stored securely in Vault.

Authorization

BearerAuth

AuthorizationBearer <token>

API key authentication. Get your key from the dashboard.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Trunk display name (required)

provider*string

SIP provider name (required)

address*string

SIP server address (required)

auth_username?string

Authentication username

auth_password?string

Authentication password (stored securely)

numbers?array<string>

Associated phone numbers

transport?string

Transport protocol (default: udp)

Value in"udp" | "tcp" | "tls"

Response Body

`application/json`

curl -X POST "https://example.com/sip-trunks" \  -H "Content-Type: application/json" \  -d '{    "name": "Main Office PBX",    "provider": "Twilio",    "address": "sip.twilio.com"  }'

{
  "trunk": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "Main Office PBX",
    "provider": "Twilio",
    "address": "sip.twilio.com",
    "auth_username": "string",
    "numbers": [
      "string"
    ],
    "transport": "udp",
    "is_active": true,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "Invalid API key",
  "message": "string"
}

{
  "error": "Invalid API key",
  "message": "string"
}

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

`application/json`

`application/json`

`application/json`