Phone Numbers

Link SIP Trunk

Registers a bring-your-own number with SIP trunk credentials for workspace routing.

post/v1/organization-phone-numbers/sip-trunks

Request

  • Base URL: https://api.dialnexa.com
  • URL: https://api.dialnexa.com/v1/organization-phone-numbers/sip-trunks
  • Auth: HTTP bearer

Request body

phoneNumberstring required

Phone number in E.164 form with the leading plus, for example +14155552671. It must be a valid number for its country.

terminationUristring required

SIP termination host[:port]; must not use a sip: URI prefix

authMode'userpass' | 'ip'

How the provider authorizes this trunk. 'userpass' requires sipTrunkUserName and sipTrunkPassword; 'ip' requires both to be omitted and expects the provider to have whitelisted our signaling IP.

sipTrunkUserNamestring

SIP authentication username. Required for authMode=userpass, forbidden for ip.

sipTrunkPasswordstring

SIP authentication password stored encrypted. Required for authMode=userpass and forbidden for authMode=ip.

nicknamestring

Display nickname for this trunk

Example request

{
  "phoneNumber": "+14155552671",
  "terminationUri": "31974861099010243.zt.plivo.com:5060"
}

Response

SIP trunk linked successfully.

successtrue required
errorfalse required
statusCodeinteger required
messagestring required
timestampstring date-time required

Example response

{
  "statusCode": 201,
  "message": "Success",
  "data": {
    "id": "phn_mfk3p8z2c4v6bn",
    "country_iso": "1",
    "phone_number": 4155552671,
    "termination_uri": "31974861099010243.zt.plivo.com:5060"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.