Move phonenumber back to Available in Inventory

This API example will move the number back to available in the domain's invenetory

Path Params
string
required
length ≤ 64
Defaults to ~

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Body Params
string
required

This is the main phonenumber setting. Should be a formated in a e164 format with country count and number. US domestic numbers should be similiar to 18005551234

string
enum
Defaults to yes

This allows any added configurations to specify a hostname. Default to "yes"

Allowed:
string
enum

This is the application that the call will be routed using. It works in partnership with dial-rule-translation-destination-user and dial-rule-translation-destination-host to forward to a next destination.

string

This is the application parameter field that can be used for additional settings based on the dial-rule-application. Default is empty string.

string
required

This is the forward destination the call will be sent to in partnership with the application (dial-rule-application) and host (dial-rule-translation-destination-host). This might be a user, queue or offnet number depending on the application.

string
Defaults to [*]

This is the forward destination host the call will be sent to in partnership with the application (dial-rule-application) and user (dial-rule-translation-destination-user). This might be the domain name or a connection name if trying to route offnet.

string
Defaults to [*]

This field will allow customization of the source "name" often used for teh caller id name or the the descriptive quoted value outside of the sip uri. Defaults to [] but you can add a prefix for example with something like this, sales_[]

string

This is a description of the number/rule that can be used for defintion or tracking purposes.

Responses

Language
Credentials
Bearer
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json