Phone Number (DID) Management
Overview
With IntelePeer Direct Inward Dialing (DID) APIs, you can manage domestic voice traffic.
Click the subject name to view the associated API request information.
Base URL
All of the following endpoints share the same base URL:
https://customer.intelepeer.com
Example:
GET https://customer.intelepeer.com/_rest/v4/carrier/did

Use Search DID Inventory to locate numbers available to reserve and purchase from IntelePeer. Provides the ability to search and enumerate the IntelePeer inventory.
Method and Endpoint
GET /_rest/v4/carrier/did
Header
- Accept: application/json
- Authorization: xxxxxxxxxxxxxxxxx
- Content-Type: application/json
Field | Type | Description |
---|---|---|
Accept | STRING | application/json |
Authorization | STRING | Authorization token (for more information, see API Authentication) |
Content-Type | STRING | application/json |
Parameters
Field | Type | Description |
---|---|---|
city |
STRING[] |
(optional) The city of the desired numbers. Note: Requires stateProvince |
contains |
E.164 |
(optional) All or part of an endpoint to search for.
|
country | STRING | The ISO-3166 country of the desired numbers. |
like | STRING |
(optional) An alpha-numeric string to search for. Alphabetic characters are translated to numbers as follows: 2 = ABC, 3 = DEF, 4 = GHI, 5 = JKL, 6 = MNO, 7 = PQRS, 8 = TUV, 9 = WXYZ Must be scalar |
sequential |
BOOLEAN |
(optional) Whether or not the desired numbers must be sequential (contiguous).
Allowed values: 0, 1 |
npa | NUMERIC[] | (optional) The NPA (area code) of the desired number(s). |
nxx | NUMERIC[] | (optional) The NXX (local prefix) of the desired number(s). |
page | INTEGER |
(optional) Which page of results to retrieve. Note: When more records are available on the next page, this API returns pageSize + 1 records. Default value: 1 |
pageSize | INTEGER |
(optional) The maximum number of results to return per page. Max: 100 Note: When more records are available on the next page, this API returns pageSize + 1 records. Default value: 100 |
starts-with |
STRING |
(optional) All or part of a number to search for. Must be scalar |
stateProvince | STRING[] | (optional) The state--two character abbreviation--of the desired numbers (for more information, see ISO 3166-2:US) |
NPA-NXX Request
GET /_rest/v4/carrier/did?npa=303&nxx=729
Sequential Request
GET /_rest/v4/carrier/did?stateProvince=CO&sequential=1&pageSize=20
Response Examples and Schema
Success 200
Field | Type | Description |
---|---|---|
endpoints | ARRAY | A list containing the reserved endpoint(s). |
endpoint | NUMERIC | The e.164 representation of the endpoint. |
geo | OBJECT | Geographical information about the endpoint. |
city | STRING | The endpoint’s city. |
country | STRING | The endpoint’s country. |
stateProvince | STRING | (optional) The endpoint’s State/Province. |
media |
OBJECT |
Technical details about the resource's capabilities |
sms |
OBJECT |
Technical details about the resource's SMS capabilities |
rx |
BOOLEAN |
Indicates whether this resource can receive SMS |
tx |
BOOLEAN |
Indicates whether this resource can send (transmit) SMS |
voice |
OBJECT |
Technical details about the endpoint's voice capabilities |
rx |
OBJECT |
Indicates whether this resource can receive voice |
tx |
OBJECT |
Indicates whether this resource can send (transmit) voice |
hasMore | BOOLEAN |
Whether or not more results are available on the next page. Note: Sequential queries always indicate "hasMore": false. |
Success Response
HTTP/1.1 200 OK
{
"endpoints": [
{
"endpoint": "+13037293863",
"type": "LONG",
"geo": {
"city": "AURORA",
"country": "US",
"stateProvince": "CO"
},
"media": {
"sms": {
"rx": true,
"tx": true
},
"voice": {
"rx": true,
"tx": true
}
}
},
{
"endpoint": "+13037293864",
"type": "LONG",
"geo": {
"city": "AURORA",
"country": "US",
"stateProvince": "CO"
},
"media": {
"sms": {
"rx": true,
"tx": true
},
"voice": {
"rx": true,
"tx": true
}
}
}
],
"hasMore": true
}
Error
Name | Type | Description |
---|---|---|
code | INTEGER | Error code |
error | STRING | Error description |
Code 401 Response
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Unauthorized"
}
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Session Expired"
}
Code 406 Response
HTTP/1.1 406 Not Acceptable
{
"code": 406,
"error": "Not Acceptable"
}
Code 422 Response
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "At least one of the following parameters is required: 'npa', 'stateProvince'"
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be scalar."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) boolean."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) integer."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) numeric."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) string."
}

With IntelePeer Direct Inward Dialing (DID) APIs you can manage domestic voice traffic.
Search and identify your unique DID numbers and then hold onto them with Reserve DID Number. Like a shopping cart, reserving allows you to hold them before someone else buys them.
Method and Endpoint
POST /_rest/v4/carrier/did/reservations
Header
- Accept: application/json
- Authorization: xxxxxxxxxxxxxxxxx
- Content-Type: application/json
Field | Type | Description |
---|---|---|
Accept | STRING | application/json |
Authorization | STRING | Authorization token (for more information, see Atmosphere API Authentication) |
Content-Type | STRING | application/json |
Parameters
Field | Type | Description |
---|---|---|
endpoints | E.164 | The endpoints to reserve. |
reservationID | STRING |
(optional) A Universally Unique Identifier (UUID) to associate with the reserved endpoints (for more information, see Universally Unique Identifier). |
Request
{
"endpoints": [
"+12127293863",
"1-2127293875"
]
}
Request with Explicit Reservation ID
{
"endpoints": [
"+14082737937",
"+14082737938",
"1-4082737939"
],
"reservationID": "F78793B1-7E84-11E6-B908-52540029234D"
}
Response Examples and Schema
Success 200
Field | Type | Description |
---|---|---|
expirationDate | DateTime | The ISO 8601 date the reservation expires. |
reservedDate | DateTime | The ISO 8601 date the reservation was created. |
reservationID | STRING | The Universally Unique Identifier (UUID) associated with the endpoint(s) (for more information, see Universally Unique Identifier). |
endpoints | ARRAY | A list containing the reserved endpoint(s). |
endpoint | NUMERIC | The e.164 representation of the endpoint. |
geo | OBJECT | Geographical information about the endpoint. |
city | STRING | The endpoint’s city. |
country | STRING | The endpoint’s country. |
STRING | The endpoint’s State/Province. |
Success Response
HTTP / 1.1 200 OK
{
"expirationDate": "2016-11-10T19:03:54Z",
"reservationID": "3BDBD2D9-A774-11E6-A562-52540029234D",
"reservedDate": "2016-11-10T18:33:54Z",
"endpoints": [
{
"endpoint": "+14082737937",
"geo": {
"city": "San Jose",
"country": "US",
"stateProvince": "CA"
}
},
{
"endpoint": "+14082737938",
"geo": {
"city": "San Jose",
"country": "US",
"stateProvince": "CA"
}
},
{
"endpoint": "+14082737939",
"geo": {
"city": "San Jose",
"country": "US",
"stateProvince": "CA"
}
}
]
}
Error
Name | Type | Description |
---|---|---|
code | INTEGER | Error code |
error | STRING | Error description |
Code 401 Response
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Unauthorized"
}
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Session Expired"
}
Code 406 Response
HTTP/1.1 406 Not Acceptable
{
"code": 406,
"error": "Not Acceptable"
}
Code 409 Response
HTTP/1.1 409 Unprocessable Entity
{
"code": 409,
"error": "Number(s) not available."
}
Code 422 Response
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter is required."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) array."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter is required for each Number object."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The 'countryCode' parameter must match one of the following values: 1"
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The 'number' parameter must be 10 numeric digits."
}

Search and identify DID numbers you currently have placed a hold on (reserved) from IntelePeer's inventory.
Method and Endpoint
GET /_rest/v4/carrier/did/reservations/:id
Header
- Accept: application/json
- Authorization: xxxxxxxxxxxxxxxxx
- Content-Type: application/json
Field | Type | Description |
---|---|---|
Accept | STRING | application/json |
Authorization | STRING | Authorization token (for more information, see Atmosphere API Authentication) |
Content-Type | STRING | application/json |
Parameters
Field | Type | Description |
---|---|---|
id | STRING |
(optional) A Universally Unique Identifier (UUID) to associate with the reserved endpoints; for more information, check out Universally Unique Identifier
|
Response Examples and Schema
Success 200
Field | Type | Description |
---|---|---|
expirationDate | DateTime | The ISO 8601 date the reservation expires |
reservedDate | DateTime | The ISO 8601 date the reservation was created |
reservationID | STRING | The Universally Unique Identifier (UUID) associated with the endpoints; for more information, check out Universally Unique Identifier |
endpoints | ARRAY | A list containing the reserved endpoints |
endpoint | NUMERIC | The e.164 representation of the endpoint |
geo | OBJECT | Geographical information about the endpoint. |
city | STRING | The endpoint’s city. |
country | STRING | The endpoint’s country. |
stateProvince | STRING | The endpoint’s State/Province. |
Success Response
HTTP/1.1 200 OK
{
"expirationDate": "2016-11-10T19:03:54Z",
"reservationID": "3BDBD2D9-A774-11E6-A562-52540029234D",
"reservedDate": "2016-11-10T18:33:54Z",
"endpoints": [
{
"endpoint": "+14082737937",
"geo": {
"city": "San Jose",
"country": "US",
"stateProvince": "CA"
}
},
{
"endpoint": "+14082737938",
"geo": {
"city": "San Jose",
"country": "US",
"stateProvince": "CA"
}
},
{
"endpoint": "+14082737939",
"geo": {
"city": "San Jose",
"country": "US",
"stateProvince": "CA"
}
}
]
}
Error
Name | Type | Description |
---|---|---|
code | INTEGER | Error code |
error | STRING | Error description |
Code 401 Response
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Unauthorized"
}
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Session Expired"
}
Code 404 Response
HTTP/1.1 404 Not Found
{
"code": 404,
"error": "Reservation not found: %s"
}
Code 406 Response
HTTP/1.1 406 Not Acceptable
{
"code": 406,
"error": "Not Acceptable"
}

If you no longer need to reserve numbers, you can release numbers in the reservations or delete the entire reservation. The numbers return to IntelePeer's inventory.
Method and Endpoint
DELETE /_rest/v4/carrier/did/reservations/:id
Header
- Accept: application/json
- Authorization: xxxxxxxxxxxxxxxxx
- Content-Type: application/json
Field | Type | Description |
---|---|---|
Accept | STRING | application/json |
Authorization | STRING | Authorization token (for more information, see Atmosphere API Authentication) |
Content-Type | STRING | application/json |
Parameters
Field | Type | Description |
---|---|---|
endpoints |
E.164 |
(optional) |
id | STRING |
The Universally Unique Identifier (UUID) to associate with the reserved endpoints; for more information, check out Universally Unique Identifier
|
Response Examples and Schema
Release the Entire Reservation
Note: The numbers return to the IntelePeer inventory.
DELETE /_rest/v4/carrier/did/reservations/0F85813F-7E8B-11E6-B908-52540029234D
Release 1 Endpoint from the Reservation
Note: The numbers return to the IntelePeer inventory.
DELETE /_rest/v4/carrier/did/reservations/0F85813F-7E8B-11E6-B908-52540029234D
{
"endpoints": "+12127293863"
}
Success Response
HTTP/1.1 204 No Content
Error
Name | Type | Description |
---|---|---|
code | INTEGER | Error code |
error | STRING | Error description |
Code 401 Response
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Unauthorized"
}
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Session Expired"
}
Code 406 Response
HTTP/1.1 406 Not Acceptable
{
"code": 406,
"error": "Not Acceptable"
}
Code 422 Response
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The 'id' parameter is required."
}

After finding, or finding and reserving, your unique DID numbers use Purchase DID Numbers to buy them.
Note: For information on current 911 legislation, check out Understand 911 Compliance Changes.
Method and Endpoint
POST /_rest/v4/my/did/orders
Header
- Accept: application/json
- Authorization: xxxxxxxxxxxxxxxxx
- Content-Type: application/json
Field | Type | Description |
---|---|---|
Accept | STRING | application/json |
Authorization | STRING | Authorization token (for more information, see Atmosphere API Authentication) |
Content-Type | STRING | application/json |
Parameters
Field | Type | Description |
---|---|---|
country | STRING |
(optional) The ISO-3166 country code for the desired endpoint(s) Note: All API orders are currently restricted to US
Default value: US |
STRING | (optional) An email address to notify about changes in the order’s status | |
endpoints | ARRAY |
An array of reserved numbers to order (see Search and Reserve)
|
notes | STRING | (optional) Notes regarding the fulfilment of this order |
npa | STRING |
(optional) The NPA from which to order numbers Mutually exclusive with numbers, reservations, and stateProvince Requires country |
packageID | INTEGER | The target packageID to order numbers for |
quantity | INTEGER |
(optional) The quantity of numbers to order Mutually exclusive with numbers and reservations Requires country If US or CA, requires npa or stateProvince Other countries require city, and may support geographic and/or national numbers |
referenceID | STRING | (optional) A non-empty string indicating your reference ID or code |
reservations | STRING[] |
(optional) An array of reservation IDs (see Search and Reserve)
|
sequential | BOOLEAN |
(optional) true to require all of this order's numbers to be in sequence. May incur additional charges.
|
stateProvince | STRING |
For North America, the two-digit state/province abbreviation from which to order numbers; other countries provide full province name
|
serviceName | STRING | The name of the service location. |
serviceAddress | OBJECT | The service address. |
address1 | STRING | The first line of the service address. |
address2 | STRING | (optional) The second line of the service address. |
city | STRING | The city of the service address. |
stateProvince | STRING | (optional) The state or province of the service address |
postalCode | STRING | (optional) The postal code of the service address |
country | STRING | The ISO-3166 country code for this address |
billingName | STRING | (optional) The name of the billing location |
billingAddress | OBJECT |
(optional) The billing addess. If omitted, serviceAddress will be used in place of billingAddress. Note:If any of the billingAddress parameters are provided, the following parameters are also required: billingName, billingAddress.address1, billingAddress.city, billingAddress.country |
address1 | STRING | (optional) The first line of the billing address |
address2 | STRING | (optional) The second line of the billing address |
city |
STRING | (optional) The city of the billing address |
stateProvince |
STRING | (optional) The state or province of the billing address |
postalCode |
STRING | (optional) The postal code (postal code) of the billling address |
Order by NPA
{
"country": "US",
"npa": "619",
"packageID": 1234567,
"quantity": 5,
"serviceName": "ABC Signs",
"serviceAddress": {
"address1": "1234 Main St",
"city": "Springfield",
"stateProvince": "IL",
"postalCode": "62701",
"country": "US"
}
}
Order by Reserved Numbers
{
"endpoints": [
"+17207998000",
"+13037998099"
],
"packageID": 1234567,
"billingName": "ABC Signs",
"billingAddress": {
"address1": "1234 Main St",
"city": "Springfield",
"stateProvince": "IL",
"postalCode": "62701",
"country": "US"
},
"serviceName": "Signs 'R' Us",
"serviceAddress": {
"address1": "4475 2nd Ave",
"city": "Aurora",
"stateProvince": "CO",
"postalCode": "80013",
"country": "US"
}
}
Order by Reservation IDs
{
"reservations": [
"ae62b6bd-cf20-11e7-b207-525400807a6d",
"baa7fe27-cf20-11e7-b207-525400807a6d",
"c5c7b9d6-cf20-11e7-b207-525400807a6d"
],
"packageID": 1234567,
"serviceName": "Diaspora Direct",
"serviceAddress": {
"address1": "10715 Beaufort St",
"city": "Denver",
"stateProvince": "CO",
"postalCode": "80244",
"country": "US"
}
}
Response Example and Schema
Success 200
Field | Type | Description |
---|---|---|
accountID | INTEGER | The account ID for which the order was placed, if applicable |
batchIDs | INTEGER[] | The ID associated with this portion of the order (batch). |
completed |
DateTime |
The ISO 8601 date the order was completed. Value can be null if a completed date is not available. |
created |
DateTime |
The ISO 8601 date the order was placed |
orderID | INTEGER | The overall ID associated with this order. |
packageID | INTEGER | The package ID for which the order was placed, if applicable |
referenceID | STRING | The customer key associated to this order. Can be null if empty |
source | STRING |
The source type, where the order originated from
|
status | STRING |
The order status
|
type | STRING |
The order type
|
Success Response
HTTP / 1.1 200 OK
{
"accountID": 1006568,
"batchIDs": [
800024
],
"completed": null,
"created": "2019-02-10T20:46:12Z",
"orderID": 800240,
"packageID": 31615,
"referenceID": null,
"source": "API",
"status": "PENDING",
"type": "DID Purchase"
}
Error
Name | Type | Description |
---|---|---|
code | INTEGER | Error code |
error | STRING | Error description |
Code 401 Response
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Unauthorized"
}
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Session Expired"
}
Code 402 Response
HTTP/1.1 402 Payment Required
{
"code": 402,
"error": "Order blocked; trial limit realized. Limit: %d seats."
}
Code 406 Response
HTTP/1.1 406 Not Acceptable
{
"code": 406,
"error": "Not Acceptable"
}
Code 422 Response
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter is required."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be scalar."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) boolean."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) integer."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) numeric."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) string."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%' parameter is required for each Number object."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The 'countryCode' parameter must match one of the following values: 1"
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The 'number' parameter must be 10 numeric digits."
}

Use DID_Management to enumerate and search your Direct Inward Dialing (DID) inventory of numbers.
Note: Identifies those numbers with CNAM.
For information on current 911 legislation, check out Understand 911 Compliance Changes.
Method and Endpoint
GET /_rest/v4/my/did
Header
- Accept: application/json
- Authorization: xxxxxxxxxxxxxxxxx
- Content-Type: application/json
Field | Type | Description |
---|---|---|
Accept | STRING | application/json |
Authorization | STRING | Authorization token (for more information, see Atmosphere API Authentication) |
Content-Type | STRING | application/json |
Parameters
Field | Type | Description |
---|---|---|
contains |
STRING |
(optional) An alpha-numeric string to search for
|
country |
STRING |
The ISO-3166 country code of the desired endpoint(s) Note: Must be scalar |
endpoint |
STRING[] |
(optional) The e.164 number(s) to list Note: Mutually exclusive with contains and starts-with |
hasCpaas |
BOOLEAN |
(optional) Whether or not the desired endpoints have been configured for SmartFlows
|
label | STRING | (optional) The label of the desired number(s) |
packageID | INTEGER | (optional) The package ID of the desired number(s). |
page | INTEGER |
(optional) Which page of results to retrieve. Note: When more records are available on the next page, this API returns pageSize + 1 records. Default value: 1 |
pageSize | INTEGER |
(optional) The maximum number of results to return per page. Max: 100 Note: When more records are available on the next page, this API returns pageSize + 1 records. Default value: 100 |
starts-with | STRING |
(optional) An endpoint string to search for
|
stateProvince | STRING[] | (optional) The state of the desired number(s); for more information, see ISO 3166-2:US |
type |
STRING |
(optional) The number's type, indicating if it's a short code or a long code
|
Search for SmartFlows-enabled Numbers
GET /_rest/v4/my/did?hasCpaas=1
Search Multiple Packages
GET /_rest/v4/my/did?packageID[]=78314&packageID[]=24188
Search Numbers in Maryland
GET /_rest/v4/my/did?stateProvince=MD
Response Example and Schema
Success 200
Field | Type | Description |
---|---|---|
endpoints | OBJECT[] | An array of results (numbers) matching the specified filters |
accountID | INTEGER | The account ID to which this number is assigned |
cnam |
STRING |
CNAM label associated with the number; if there is no label, returns no value; in the IntelePeer Customer Portal, CNAM labels are set by using the Manage pages for the appropriate numbers |
hasCnam |
BOOLEAN |
Identifies there is a CNAM label associated with the number; TRUE means there is a label associated with the number |
endpoint | NUMERIC | The e.164 representation of the number |
hasCpaas | BOOLEAN | The number's SmartFlows status |
label | STRING | (optional) The number's label |
orderID | INTEGER | The order ID which purchased or ported the number into inventory |
packageID | INTEGER | The package ID to which this number is assigned |
type | STRING |
The number's type, indicating if it is a short code or a long code.
|
geo | OBJECT | An object containing geographical data about the number |
country | STRING | The number's ISO-3166 country code |
stateProvince | STRING | (optional) The 2-letter abbreviation for the number's state or province |
media | OBJECT | An object containing technical configuration details |
sms | OBJECT | An object containing technical details about the number's SMS configuration |
rx | OBJECT | (optional) An object containing the number's SMS receiving (rx) configuration |
tx | OBJECT[] | (optional) An array of objects containing the number's SMS sending (tx) configurations |
voice | OBJECT | An object containing technical details about the number's voice configuration |
rx | OBJECT | (optional) An object containing the number's voice receiving (rx) configuration |
tx | OBJECT[] | (optional) An array of objects containing the number's voice sending (tx) configurations |
hasMore |
BOOLEAN |
Indicates if there are results available on the next page |
Success Response
HTTP/1.1 200 OK
[
{
"endpoints": [
{
"accountID": 1004318,
"cnam": "",
"hasCnam": false,
"endpoint": "+13037293863",
"hasCpaas": false,
"label": "Head office",
"packageID": 30744,
"type": "LONG",
"geo": {
"country": "US",
"stateProvince": "CO"
},
"media": {
"sms": null,
"voice": {
"rx": {
"provider": "IntelePeer",
"service": "SIP",
"ns": "intelepeer.sip",
"config": {}
},
"tx": [
{
"provider": "IntelePeer",
"service": "SIP",
"ns": "intelepeer.sip",
"config": {}
}
]
}
}
},
{
"accountID": 1004318,
"endpoint": "1-10801",
"hasCpaas": true,
"label": "Automated Messaging",
"packageID": 30744,
"type": "SHORT",
"geo": {
"country": "US",
"stateProvince": "CO"
},
"media": {
"sms": {
"rx": {
"provider": "IntelePeer",
"service": "SmartFlows",
"ns": "intelepeer.cpaas",
"config": {
"webhook": "cpaas://api.intelepeer.com"
}
},
"tx": [
{
"provider": "IntelePeer",
"service": "SMS",
"ns": "intelepeer.sms",
"config": {}
},
{
"provider": "IntelePeer",
"service": "SmartFlows",
"ns": "intelepeer.cpaas",
"config": {}
}
]
},
"voice": null
}
}
],
"hasMore": false
}
]
Error
Name | Type | Description |
---|---|---|
code | INTEGER | Error code |
error | STRING | Error description |
Code 401 Responses
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Unauthorized"
}
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Session Expired"
}
Code 406 Response
HTTP/1.1 406 Not Acceptable
{
"code": 406,
"error": "Not Acceptable"
}
Code 422 Responses
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be scalar."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) integer."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a non-empty string."
}

Move telephone (DID) numbers to a different package / route profile.
Method and Endpoint
POST /_rest/v4/my/did/package
Header
- Accept: application/json
- Authorization: xxxxxxxxxxxxxxxxx
- Content-Type: application/json
Field | Type | Description |
---|---|---|
Accept | STRING | application/json |
Authorization | STRING | Authorization token (for more information, see API Authentication) |
Content-Type | STRING | application/json |
Parameters
Field | Type | Description |
---|---|---|
email (optional) | STRING | An email address to notify about changes in this order’s status |
endpoints | ARRAY | An array of reserved numbers to order; each item is in the e164 format: "+17207998099" |
notes (optional) | STRING | Notes regarding the fulfilment of this order |
packageID |
INTEGER |
The target packageID to order numbers for |
referenceID (optional) | STRING | A non-empty string indicating your reference ID or code |
Request Example
POST /_rest/v4/my/did/package
{
"packageID": 1234567,
"endpoints": [
"+17205558000",
"+13035558099"
]
}
Success 200 Fields
Field | Type | Description |
---|---|---|
accountID | INTEGER | The account ID for which the order was placed, if applicable |
batchID | INTEGER | The IDs of the batches associated to this order |
completed | DATETIME | The ISO 8601 date the order was completed; the value can be null if a completed date is not available |
created |
INTEGER |
The ISO 8601 date the order was placed |
orderID |
INTEGER |
The order ID |
packageID |
INTEGER |
The package ID for which the order was placed, if applicable |
referenceID (optional) | STRING | The customer key associated with this order; can be null if empty |
source |
STRING |
The source type where the order originated from Allowed values: API, Portal |
status |
STRING |
The order status. Allowed values: PENDING |
type |
STRING |
The order type. Allowed values: Change Package |
Response Example and Schema
Success 200 Response
HTTP/1.1 200 OK
{
"accountID": 1006568,
"batchIDs": [
800024
],
"completed": null,
"created": "2019-02-10T20:46:12Z",
"orderID": 800240,
"packageID": 31615,
"referenceID": null,
"source": "API",
"status": "PENDING",
"type": "Change Package"
}
Error
Name | Type | Description |
---|---|---|
code | INTEGER | Error code |
error | STRING | Error description |
Code 401 Response
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Unauthorized"
}
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Session Expired"
}
Code 406 Response
HTTP/1.1 406 Not Acceptable
{
"code": 406,
"error": "Not Acceptable"
}
Code 422 Response
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter is required."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be scalar."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) integer."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) string."
}

Manage the ability to display a caller’s name with the Caller Name (CNAM) service.
Use Add CNAM to join or change the service to a list of numbers.
Method and Endpoint
POST /_rest/v3/my/did/cnam
Header
- Accept: application/json
- Authorization: xxxxxxxxxxxxxxxxx
- Content-Type: application/json
Field | Type | Description |
---|---|---|
Accept | STRING | application/json |
Authorization | STRING | Authorization token (for more information, see Atmosphere API Authentication) |
Content-Type | STRING | application/json |
Parameters
Field | Type | Description |
---|---|---|
numbers | ARRAY |
An array of reserve numbers on which to operate. Each item is in the following form: { "countryCode": "1", "number": "2125550001" } |
cnam | STRING | The cnam label to see. Only 15 letters, numbers, or spaces allowed. |
email (optional) |
STRING |
Use this field to include a single email address to notify about changes in this order’s status. |
emails (optional) | STRING |
Use this field if you want to include multiple email addresses to notify about changes in this order’s status. Format: ["email1@example.com", "email2@example.com", "email3@example.com"], |
notes (optional) | STRING | Notes regarding the fulfilment of this order. |
referenceID (optional) | STRING | A non-empty string indicating your reference ID or code. |
Request
{
"cnam": "joeTel",
"email": "admin@example.com",
"emails": ["joem@example.com", "jillg@example.com", "alb@example.com"],
"numbers": [
{
"countryCode": "1",
"number": "9195551212"
}
]
}
Response Example and Schema
Success 200
Field | Type |
---|---|
OrderID | INTEGER |
Success Response
{
"orderID": 1429590,
"referenceID": "",
"batches": [
{
"batchID": 1193699,
"status": "None",
"statusCode": "NONE",
"numbers": [
{
"callerID": null,
"cnam": "QUEUED",
"countryCode": "1",
"directoryListing": null,
"e164": "+19195551212",
"e911": null,
"e911Address": null,
"network": null,
"number": "9195551212"
}
]
}
]
}
Error
Name | Type | Description |
---|---|---|
code | INTEGER | Error code |
error | STRING | Error description |
Code 401 Response
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Unauthorized"
}
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Session Expired"
}
Code 406 Response
HTTP/1.1 406 Not Acceptable
{
"code": 406,
"error": "Not Acceptable"
}
Code 422 Response
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter is required."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) array."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) string."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The 'numbers' parameter must contain unique numbers."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The 'cnam' parameter must consist of letters, numbers, or spaces."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The 'cnam' parameter must be 15 characters or less."
}

Remove the Caller Name (CNAM) service from a list of numbers.
Note: For information on current 911 legislation, check out Understand 911 Compliance Changes.
Method and Endpoint
DELETE /_rest/v3/my/did/cnam
Headers
- Accept: application/json
- Authorization: xxxxxxxxxxxxxxxxx
- Content-Type: application/json
Field | Type | Description |
---|---|---|
Accept | STRING | application/json |
Authorization | STRING | Authorization token (for more information, see Atmosphere API Authentication) |
Content-Type | STRING | application/json |
Parameters
Field | Type | Description |
---|---|---|
numbers | ARRAY |
An array of reserve numbers on which to operate. Each item is in the following form: { "countryCode": "1", "number": "2125550001" } |
email (optional) | STRING |
An email address to notify about changes in this order’s status. |
notes (optional) | STRING | Notes regarding the fulfilment of the order. |
referenceID (optional) | STRING | A non-empty string indicating your reference ID or code. |
Request
{
"numbers": [
{
"countryCode": "1",
"number": "2125550001"
},
{
"countryCode": "1",
"number": "2125550002"
}
]
}
Response Example and Schema
Success 200
Field | Type |
---|---|
OrderID | INTEGER |
Success Response
HTTP/1.1 200 OK
{
"OrderID": 31542
}
Error
Name | Type | Description |
---|---|---|
code | INTEGER | Error code |
error | STRING | Error description |
Code 401 Response
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Unauthorized"
}
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Session Expired"
}
Code 406 Response
HTTP/1.1 406 Not Acceptable
{
"code": 406,
"error": "Not Acceptable"
}
Code 422 Response
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter is required."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) array."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) string."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The 'numbers' parameter must contain unique numbers."
}
Request
{
"serviceBusiness": "ABC Printing",
"serviceUser": "Ted Dillon",
"serviceUserTitle": "VP IT",
"locationName": "AZ Fastening",
"address1": "8050 NW 64TH ST",
"city": "MIAMI",
"state": "FL",
"zip": "33166",
"numbers": [
{
"countryCode": "1",
"number": "2125550001"
},
{
"countryCode": "1",
"number": "2125550002"
}
]
}
Response Example and Schema
Success 200
Field | Type | Description |
---|---|---|
order | OBJECT | A complex object identifying batch-specific and number provisioning details. |
orderID | INTEGER | The overall ID associated with this order. |
batches | ARRAY | An array of “batch” objects with associated number provisioning details. |
batchID | INTEGER | The ID associated with this portion of the order (batch). |
numbers | ARRAY | An array of objects specifying the numbers and provisioning attributes associated with this particular batch. |
callerID (optional) | STRING |
The provisioning status of caller ID lookup service, if ordered/applicable (see network for value descriptions). Allowed values: PENDING, PROVISIONED, QUEUED |
Cnam (optional) | STRING |
The provisioning status of Caller ID Registration (CNAM) service, if ordered/applicable (see network for value descriptions). Allowed values: PENDING, PROVISIONED, QUEUED |
countryCode | NUMERIC | The number’s country code. |
directoryListing (optional) | STRING |
The provisioning status of Directory Listing service, if ordered/applicable (see network for value descriptions). Allowed values: PENDING, PROVISIONED, QUEUED |
e164 | NUMERIC | The e.164 representation of the number. |
E911 (optional) | STRING |
The provisioning status of 911 service, if ordered/applicable (see network for value descriptions). Allowed values: PENDING, PROVISIONED, QUEUED |
e911Address (optional) | OBJECT | If the order is adding or changing 911 service, this is the associated address. |
name | STRING | The name/label of the 911 registration address. |
address1 | STRING | The first line of the 911 registration address. |
address2 | STRING | The second line of the 911 registration address. |
city | STRING | The city of the 911 registration address. |
state | STRING | The state of the 911 registration address. |
network | STRING |
The number’s provisioning status. Allowed values: PENDING, PROVISIONED, QUEUED
|
number | OBJECT | The number. |
Success Response
HTTP / 1.1 200 OK
{
"orderID": 12345,
"batches": [
{
"batchID": 23456,
"numbers": [
{
"callerID": null,
"cnam": null,
"countryCode": "1",
"directoryListing": null,
"e164": "+12125550001",
"e911": "QUEUED",
"e911Address": {
"location": "AZ Fastening",
"address1": "8050 NW 64TH ST",
"address2": null,
"city": "MIAMI",
"state": "FL",
"zip": "33166"
},
"network": null,
"number": "2125550001"
},
{
"callerID": null,
"cnam": null,
"countryCode": "1",
"directoryListing": null,
"e164": "+12125550002",
"e911": "QUEUED",
"e911Address": {
"location": "AZ Fastening",
"address1": "8050 NW 64TH ST",
"address2": null,
"city": "MIAMI",
"state": "FL",
"zip": "33166"
},
"network": null,
"number": "2125550002"
}
]
}
]
}
Error
Name | Type | Description |
---|---|---|
code | INTEGER | Error code |
error | STRING | Error description |
Code 401 Response
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Unauthorized"
}
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Session Expired"
}
Code 404 Response
HTTP/1.1 404 Not Found
{
"code": 404,
"error": "Location not recognized."
}
HTTP/1.1 404 Not Found
{
"code": 404,
"error": "Validation does not match: %s."
}
Code 406 Response
HTTP/1.1 406 Not Acceptable
{
"code": 406,
"error": "Not Acceptable"
}
Code 409 Response
HTTP/1.1 409 Conflict
{
"code": 409,
"error": "One or more numbers are not assigned to this account."
}
HTTP/1.1 409 Conflict
{
"code": 409,
"error": "One or more numbers are part of an active order: %d"
}
HTTP/1.1 409 Conflict
{
"code": 409,
"error": "One or more numbers do not have service: %s"
}
HTTP/1.1 409 Conflict
{
"code": 409,
"error": "One or more numbers are already pending disconnect: %s"
}
Code 422 Response
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be scalar."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) string."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%' parameter is required for each Number object."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The 'countryCode' parameter must match one of the following values: 1"
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The 'number' parameter must be 10 numeric digits."
}

Overview

Method and Endpoint
PUT /_rest/v4/my/translations
Headers
- Accept: application/json
- Authorization: xxxxxxxxxxxxxxxxx
- Content-Type: application/json
Field | Type | Description |
---|---|---|
Accept | STRING | application/json |
Authorization | STRING | Authorization token (for more information, see API Authentication) |
Content-Type | STRING | application/json |
Parameters
Field | Type | Description |
---|---|---|
destination (optional) | NUMERIC/E.164 | The [called] number to which the [dialed] numbers will be translated. When type = 'DNIS', destination may be any numeric string between 4 and 10 digits inclusive. When type = 'Forward', destination must be provided in E.164 format. When type = 'Forward', destination is currently restricted to the continental US. When type = 'None', destination is not supported. |
failover (optional) | E.164 |
If/when destination is omitted or returns an error status, attempt to forward to this number. When type = 'DNIS', failover must be provided in E.164 format. When type = 'DNIS', failover is currently restricted to the continental US. When type = 'Forward', failover is not supported. When type = 'None', failover must be provided in E.164 format. When type = 'None', failover is currently restricted to the continental US. |
numbers | E.164[] |
The [dialed] numbers that will be translated/forward to destination or failover. numbers is currently restricted to the continental US. Only 400 values may be provided at a time. |
overwrite (optional) | BOOLEAN |
Whether to overwrite any existing records that conflict with numbers. Default value: false. |
type |
STRING |
The type of translation being performed. When type = 'DNIS', destination may be any numeric string between 4 and 10 digits inclusive. When type = 'DNIS', failover is supported in E.164 format. When type = 'Forward', only destination is supported in E.164 format. When type = 'None', only failover is supported in E.164 format. (Failover only) Allowed values: DNIS, Forward, None |
Code Samples
DNIS Example
{
"name": "NY to CO",
"numbers": [
"+12125551001",
"+12125551002",
"+12125551003",
"+12125551004",
"+12125551005"
],
"type": "DNIS",
"destination": "3031009999",
"failover": "+172010055555"
}
Forward Example
{
"name": "NY to CO2",
"numbers": [
"+12124445001",
"+12124445002",
"+12124445003"
],
"type": "Forward",
"destination": "+13031009999"
}
Failover Only Example
{
"name": "NY to CO3",
"numbers": [
"+12127779001",
"+12127779002"
],
"type": "None",
"failover": "+172010055555"
}
Response Examples and Schemas
Success 200
Field | Type | Description |
---|---|---|
destination (optional) | NUMERIC/E.164 | The [called] number that will be translated/forward to |
failover (optional) | E.164 | The [called] number that will handle error codes |
name | STRING | The profile name applied to the configuration |
number | e.164 | The [dialed] number that will be translated/forward |
type | STRING | The type of translation
Allowed values: DNIS , Forward , None |
Success Response
DNIS Response
HTTP/1.1 200 OK
[
{
"destination": "3031009999",
"failover": "+172010055555",
"name": "NY to CO",
"number": "+12125551001",
"type": "DNIS"
},
{
"destination": "3031009999",
"failover": "+172010055555",
"name": "NY to CO",
"number": "+12125551002",
"type": "DNIS"
},
{
"destination": "3031009999",
"failover": "+172010055555",
"name": "NY to CO",
"number": "+12125551003",
"type": "DNIS"
},
{
"destination": "3031009999",
"failover": "+172010055555",
"name": "NY to CO",
"number": "+12125551004",
"type": "DNIS"
},
{
"destination": "3031009999",
"failover": "+172010055555",
"name": "NY to CO",
"number": "+12125551005",
"type": "DNIS"
}
]
Forward Response
HTTP/1.1 200 OK
[
{
"destination": "+13031009999",
"failover": null,
"name": "NY to CO2",
"number": "+12124445001",
"type": "Forward"
},
{
"destination": "+13031009999",
"failover": null,
"name": "NY to CO2",
"number": "+12124445002",
"type": "Forward"
},
{
"destination": "+13031009999",
"failover": null,
"name": "NY to CO2",
"number": "+12124445003",
"type": "Forward"
}
]
Failover Only Response
HTTP/1.1 200 OK
[
{
"destination": null,
"failover": "+172010055555",
"name": "NY to CO3",
"number": "+12127779001",
"type": "None"
},
{
"destination": null,
"failover": "+172010055555",
"name": "NY to CO3",
"number": "+12127779002",
"type": "None"
}
]
Error
Name | Type | Description |
---|---|---|
code | INTEGER | Error code |
error | STRING | Error description |
Code 401 Response
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Unauthorized"
}
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Session Expired"
}
Code 406 Response
HTTP/1.1 406 Not Acceptable
{
"code": 406,
"error": "Not Acceptable"
}
Code 409 Response
HTTP/1.1 409 Conflict
{
"code": 409,
"error": "Number already exists: %s"
}
HTTP/1.1 409 Conflict
{
"code": 409,
"error": "Profile already exists: %s"
}
Code 422 Response
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter is required."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) boolean."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) e.164."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) string."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The 'destination' parameter must be between 4 and 10 digits inclusive."
}
{
"code": 422,
"error": "The 'name' parameter must be 32 characters or less."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The 'numbers' parameter may only contain 400 values or less."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "Translations with type = 'Forward' do not support the 'failover' parameter."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "Translations with type = 'None' do not support the 'destination' parameter."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "Unsupported number: %s. Customer not assigned."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "Unsupported number: %s. Unsupported network."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "Unsupported %s: %s. Number must exist within the continental 48 states."
}

Method and Endpoint
GET /_rest/v4/my/translations
Headers
- Accept: application/json
- Authorization: xxxxxxxxxxxxxxxxx
Field | Type | Description |
---|---|---|
Accept | STRING | application/json |
Authorization | STRING | Authorization token (for more information, see API Authentication) |
Parameters
Field | Type | Description |
---|---|---|
destination (optional | NUMERIC/E.164 |
The [called] number that will be translated/forward to:
|
failover (optional) | E.164 |
The [called] number that will handle error codes.
|
name (optional) | STRING |
The profile name applied to the configuration.
|
numbers (optional) | E.164 |
The [dialed] number(s) that will be translated/forwarded.
|
page (optional) |
INTEGER |
Which page of results to retrieve.
Default value: |
pageSize (optional) |
INTEGER |
The quantity of translations to return per page.
Default value: |
type (optional) |
STRING |
The type of translation Allowed values: |
Request Examples
DNIS Like 803
GET /_rest/v4/my/translations?type=DNIS&destination=803
Specific Forward
Note: The plus symbol must be URI encoded.
GET /_rest/v4/my/translations?type=Forward&destination[]=%2B14021440001&destination[]=%2B14021440002
Number Like 508
Note: The plus symbol must be URI encoded.
GET /_rest/v4/my/translations?numbers=%2B1508
Response Example and Schema
Success 200
Field | Type | Description |
---|---|---|
translations | ARRAY | The list of translations |
destination (optional) | NUMERIC/E.164 | The [called] number that will be translated/forward to |
failover (optional) | E.164 | The [called] number that will handle error codes |
name | STRING | The profile name applied to the configuration |
number | E.164 | The [dialed] number that will be translated/forward |
type | STRING | The type of translation
Allowed values: DNIS , Forward , None |
hasMore | BOOLEAN | Whether or not more results are available on the next page |
Success Response
HTTP/1.1 200 OK
{
"translations": [
{
"destination": "3031009999",
"failover": "+172010055555",
"name": "NY to CO",
"number": "+12125551001",
"type": "DNIS"
},
{
"destination": "+13031009999",
"failover": null,
"name": "NY to CO2",
"number": "+12124445003",
"type": "Forward"
},
{
"destination": null,
"failover": "+172010055555",
"name": "NY to CO3",
"number": "+12127779002",
"type": "None"
},
{
"destination": "3031009999",
"failover": "+172010055555",
"name": "NY to CO",
"number": "+12125551005",
"type": "DNIS"
}
],
"hasMore": true
}
Error
Name | Type | Description |
---|---|---|
code | INTEGER | Error code |
error | STRING | Error description |
Code 401 Response
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Unauthorized"
}
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Session Expired"
}
Code 406 Response
HTTP/1.1 406 Not Acceptable
{
"code": 406,
"error": "Not Acceptable"
}
Code 422 Response
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) boolean."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) e.164."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) string."
}

Method and Endpoint
DELETE /_rest/v4/my/translations
Headers
- Accept: application/json
- Authorization: xxxxxxxxxxxxxxxxx
- Content-Type: application/json
Field | Type | Description |
---|---|---|
Accept | STRING | application/json |
Authorization | STRING | Authorization token (for more information, see API Authentication) |
Content-Type | STRING | application/json |
Parameters
Field | Type | Description |
---|---|---|
numbers | E.164 | The [dialed] numbers that will be removed from translation/forwarding |
Request
{
"numbers": [
"+12125551001",
"+12124445003",
"+12127779002",
"+12125551005"
]
}
Response Example and Schema
Success 200
Field | Type | Description |
---|---|---|
affected | INTEGER | The quantity of translations/forwards removed |
Success Response
Four (4) records matched the specified numbers:
HTTP / 1.1 202
{
"affected": 4
}
No records matched the specified numbers:
HTTP / 1.1 202
{
"affected": 0
}
Error
Name | Type | Description |
---|---|---|
code | INTEGER | Error code |
error | STRING | Error description |
Code 401 Response
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Unauthorized"
}
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Session Expired"
}
Code 406 Response
HTTP/1.1 406 Not Acceptable
{
"code": 406,
"error": "Not Acceptable"
}
Code 422 Response
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) boolean."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) e.164."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) string."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "Unsupported number: %s. Customer not assigned."
}

Use Disconnect DID to disengage a number from your inventory. This releases it back into IntelePeer’s inventory after any applicable quarantine period.
Note: For information on current 911 legislation, check out Understand 911 Compliance Changes.
Method and Endpoint
POST /_rest/v4/my/did/disconnect
Headers
- Accept: application/json
- Authorization: xxxxxxxxxxxxxxxxx
- Content-Type: application/json
Field | Type | Description |
---|---|---|
Accept | STRING | application/json |
Authorization | STRING | Authorization token (for more information, see Atmosphere API Authentication) |
Content-Type | STRING | application/json |
Parameters
Field | Type | Description |
---|---|---|
endpoints | STRING[] | An array of numbers in e.164 format |
STRING |
An email address to notify about changes in this order's status
|
|
notes | STRING |
Notes regarding the fulfillment of this order
|
referenceID | STRING |
A non-empty string indicating your reference ID or code
|
Request
POST /_rest/v4/my/did/disconnect
{
"endpoints": [
"+12125550001",
"+12125550002"
]
}
Response Example and Schema
Success 200
Field | Type | Description |
---|---|---|
accountID | INTEGER | The account ID for which the order was placed, if applicable |
batchIDs | INTEGER[] | The IDs of the batches associated to this order |
completed | DateTime | The ISO 8601 date the order was completed. Value can be null if a completed date is not available |
created | DateTime | The ISO 8601 date the order was placed |
orderID | INTEGER | The order ID |
packageID | INTEGER | The package ID for which the order was placed, if applicable |
reference ID | STRING | The customer key associated to this order. Can be null if empty |
source | STRING |
The source type, where the order originated from
|
status | STRING |
The order status
|
type | STRING |
The order type
|
Success Response
HTTP / 1.1 202
{
"accountID": 1006568,
"batchIDs": [
800024
],
"completed": null,
"created": "2019-02-10T20:46:12Z",
"orderID": 800240,
"packageID": 31615,
"referenceID": null,
"source": "API",
"status": "PENDING",
"type": "DID Return"
}
Error
Name | Type | Description |
---|---|---|
code | INTEGER | Error code |
error | STRING | Error description |
Code 401 Response
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Unauthorized"
}
HTTP/1.1 401 Unauthorized
{
"code": 401,
"error": "Session Expired"
}
Code 409 Response
HTTP/1.1 409 Conflict
{
"code": 409,
"error": "One or more numbers is part of a conflicting order."
}
HTTP/1.1 409 Conflict
{
"code": 409,
"error": "One or more numbers is already pending disconnect."
}
HTTP/1.1 409 Conflict
{
"code": 409,
"error": "One or more numbers is not assigned to this account."
}
Code 422 Response
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter is required."
}
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The '%s' parameter must be formatted as a(n) string."
}