API docs by Redocly

Numbers API (v2.1.6)

Download OpenAPI specification:Download

E-mail: support@voicetel.com License: Apache 2.0

Telephone number management

Numbers

Number-management endpoints.

Add Numbers

Assigns telephone numbers to the account. Account balance must cover the monthly DID rate multiplied by the number of DIDs being added.

Authorizations:
apikey
Request Body schema: application/json
required

Body for add numbers.

apikey
required
string
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "apikey": "Your API Key",
  • "numbers": [ ]
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "message": "Numbers added",
  • "statusCode": "200",
  • "numbers": [ ]
}

Enable or Disable Inbound CNAM

Enables or disables inbound Caller ID Name (CNAM) lookup for one or more numbers.

Authorizations:
apikey
Request Body schema: application/json
required

Body for enable or disable inbound cnam.

apikey
required
string
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "apikey": "Your API Key",
  • "numbers": [ ]
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "message": "CNAM results",
  • "statusCode": "200",
  • "numbers": [ ]
}

Disconnect Numbers

Removes numbers from the account and returns them to the available pool. Numbers currently porting cannot be disconnected.

Authorizations:
apikey
Request Body schema: application/json
required

Body for disconnect numbers.

apikey
required
string
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "apikey": "Your API Key",
  • "numbers": [ ]
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "message": "Numbers removed",
  • "statusCode": "200",
  • "numbers": [ ]
}

Remove Call Forward

Removes call forwarding from one or more numbers.

Authorizations:
apikey
Request Body schema: application/json
required

Body for remove call forward.

apikey
required
string
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "apikey": "Your API Key",
  • "numbers": [ ]
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "foward": [ ],
  • "message": "Foward results",
  • "statusCode": "200"
}

Set Call Forward

Enables call forwarding on one or more numbers to a destination number.

Authorizations:
apikey
Request Body schema: application/json
required

Body for set call forward.

apikey
required
string
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "apikey": "Your API Key",
  • "numbers": [ ]
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "foward": [ ],
  • "message": "Foward results",
  • "statusCode": "200"
}

Set LIDB / Outbound Caller ID Name

Sets the outbound Caller ID Name (CNAM/LIDB) for one or more numbers. Updates the database and the routing network. The number must be on the account.

Authorizations:
apikey
Request Body schema: application/json
required

Body for set lidb / outbound caller id name.

apikey
required
string
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "apikey": "Your API Key",
  • "numbers": [ ]
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "message": "Numbers modified",
  • "statusCode": "200",
  • "numbers": [ ]
}

List Numbers

Returns telephone numbers on the account with their route and gateway IP. Optionally filter by route ID or number.

Authorizations:
apikey
Request Body schema: application/json
required

Body for list numbers.

apikey
required
string
number
integer

Filter by number (partial match).

route
integer

Filter by gateway route ID.

Responses

Request samples

Content type
application/json
{
  • "apikey": "Your API Key",
  • "number": 2015551234,
  • "route": 1000
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "numbers": [ ],
  • "statusCode": "200"
}

Move Numbers

Moves one or more numbers to a different account with a specified route.

Authorizations:
apikey
Request Body schema: application/json
required

Body for move numbers.

apikey
required
string
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "apikey": "Your API Key",
  • "numbers": [ ]
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "message": "Move results",
  • "statusCode": "200",
  • "numbers": [ ]
}

Remove Numbers

Deletes numbers from the account entirely. Numbers currently porting cannot be removed.

Authorizations:
apikey
Request Body schema: application/json
required

Body for remove numbers.

apikey
required
string
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "apikey": "Your API Key",
  • "numbers": [ ]
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "message": "Numbers removed",
  • "statusCode": "200",
  • "numbers": [ ]
}

Route Numbers

Sets the gateway route for one or more numbers.

Authorizations:
apikey
Request Body schema: application/json
required

Body for route numbers.

apikey
required
string
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "apikey": "Your API Key",
  • "numbers": [ ]
}

Response samples

Content type
application/json
{
  • "status": "Success",
  • "message": "Route results",
  • "statusCode": "200",
  • "numbers": [ ]
}

Set Number Translations

Sets the inbound DNIS translation for one or more numbers.

Authorizations:
apikey
Request Body schema: application/json
required

Body for set number translations.

apikey
required
string
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "apikey": "Your API Key",
  • "numbers": [ ]
}

Response samples

Content type
application/json
{
  • "translation": [ ],
  • "status": "Success",
  • "message": "Translation results",
  • "statusCode": "200"
}