Import SIP trunk
Import a phone number associated with a SIP trunk.
Reseller keys only: act as one of your clients by its user id. Omit it to act on your own account. [How acting for a client works](/docs/reseller/your-clients/acting-as-clients).
Phone number in E.164 format (starting with +).
SIP server hostname or IP.
Name for this SIP trunk (must be unique within your account).
Optional friendly name for the imported number.
curl -X POST 'https://omnidim.io/api/v1/phone_number/import/sip' \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "user_id": 1234, "phone_number": "+12025550123", "sip_host": "sip.yourprovider.com", "sip_port": 5060 }'
{ "success": true, "message": "SIP trunk registered successfully", "id": 3360 }
BearerAuthAuthorizationBearer <token>Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
application/jsonuser_id?ClientUserIdReseller keys only: act as one of your clients by its user id. Omit it to act on your own account. How acting for a client works.
phone_number*stringPhone number in E.164 format (starting with +).
sip_host*stringSIP server hostname or IP.
sip_trunk_name*stringName for this SIP trunk (must be unique within your account).
name?stringOptional friendly name for the imported number.
sip_port?integerSIP server port.
5060sip_username?stringSIP authentication username.
sip_password?stringSIP authentication password.
passwordsip_dial_prefix?stringDigits added in front of every number dialed through this trunk. See sip_strip_country_code for how it combines with the country code.
sip_strip_country_code?booleanWhen true, the country code is removed from every number dialed through this trunk. When omitted and sip_dial_prefix is set, the country code is removed, so send false to keep it.
sip_strip_plus?booleanWhen true, strips the leading + from the dialed number.
Response body
application/jsonSIP trunk imported.
application/jsonsuccess?booleanmessage?stringid?integerID of the newly imported phone number record. Use this with /phone_number/attach.
Was this page helpful?
Import Exotel number
Import an Exotel number by providing your Exotel credentials.
List WhatsApp numbers
The WhatsApp numbers your API key can see, oldest first. Use it to find a number id, then pass that id to the other routes. Each number carries capabilities, which says what it can send. Archived numbers are left out.
