Phone & voice · Voice

Attach a number to a SIP trunk

Attaches a number to a SIP trunk.

POSThttps://api.pozy.ai/v1/phone-numbers/{id}/sip-trunk
attachNumberToSipTrunk

Guide: SIP trunks

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the telephony resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

NameTypeNotes
idrequiredstring

Request body

application/json, required

  • trunkIdstringrequired

Example

curl -X POST "https://api.pozy.ai/v1/phone-numbers/6bfebd43ddc270f6d2c56fc5/sip-trunk" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "trunkId": "63c129d65b39ac7f72332672"
}'

Response

200 on success

  • attachedboolean
  • phoneNumberstring
  • trunkIdstring
200 response
{
  "attached": true,
  "phoneNumber": "+14155550123",
  "trunkId": "63c129d65b39ac7f72332672"
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Voice