Bring your own SIP trunk

POSThttps://server.heyrik.com/api/v1/phone-numbers

Headers

AuthorizationstringRequired

Use Bearer $HEYRIK_API_KEY with an account-scoped API key. Keep the key on your server.

Get your API key

Parameters 7

Fields documented for this operation. See the request example for placement and structure.

namestringRequired

Label.

phone_numberstringRequired

E.164, e.g. +919876543210.

sip_hoststringRequired

Your carrier's SIP host.

sip_usernamestring

Digest username, if the trunk authenticates.

sip_passwordstring

Digest password. Stored encrypted.

directionstring

inbound | outbound | both (default).

agent_idstring

Answering agent — can also be set later via PATCH.

Response

No response example is documented for this operation yet.

Error reference

POST/phone-numbers

cURL

curl -X POST https://server.heyrik.com/api/v1/phone-numbers \
  -H "Authorization: Bearer $HEYRIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Main line",
    "phone_number": "+919876543210",
    "sip_host": "sip.your-carrier.example.com",
    "sip_username": "acme",
    "sip_password": "…",
    "direction": "both",
    "agent_id": "agc_9f2a1c30"
  }'

Illustrative examples · No live request is sent