Skip to main content
POST
/
phones
Register a new phone
curl --request POST \
  --url https://api.voice-mate.com/v1/phones \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "phone": "<string>",
  "sip_trunk_id": "<string>",
  "name": "<string>",
  "inbound_agent_id": "<string>",
  "outbound_agent_id": "<string>"
}'
{
  "status": "success",
  "phone": {
    "sid": "phone_b30fbf02-83be-4214-9724-f889085ecffb",
    "name": "main_office_phone",
    "number": "+15893858485",
    "sip_trunk": {
      "sid": "sip_1d31b6c1-dcea-425a-a3e1-3a9227a95381",
      "name": "production",
      "system": false
    },
    "inbound_agent_id": "agent_340846df-6fc5-4550-8c8e-590761765548",
    "outbound_agent_id": "agent_340846df-6fc5-4550-8c8e-590761765548",
    "created_at": "2025-05-03T10:43:50.472662Z",
    "updated_at": "2025-05-03T10:43:50.472702Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer auth header. Pass with value 'Bearer {api_key}'. Api key can be found in account Settings -> API Keys page

Body

application/json
​
phone
string
required

E.164 formatted phone number you would like to register

​
sip_trunk_id
string
required

SIP trunk identifier phone will be attached to

​
name
string

Name for the phone

​
inbound_agent_id
string | null

SID of agent that will handle inbound calls

​
outbound_agent_id
string | null

SID of agent that will handle outbound calls

Response

Phone registered

​
status
enum<string>
required
Available options:
success,
error
​
phone
object
required