Reserve DID Number

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 think on them before someone else buys them.

Endpoints and Methods

POST /_rest/v4/carrier/did/reservations

Parameters

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

Path

Field Type Description
Country (optional) STRING The country abbreviation associated with the endpoint(s).
endpoints E.164 The endpoints to reserve.
reservationID (optional) STRING

A Universally Unique Identifier (UUID) to associate with the reserved endpoints (for more information, see Universally Unique Identifier).

Request

Copy
{

    "endpoints": [

        "+12127293863",

        "1-21272"

    ]

}

Request with Explicit Reservation ID

Copy
{

    "endpoints": [

        "+14082737937",

        "+14082737938",

        "1-40824"

    ],

    "reservationID": "F78793B1-7E84-11E6-B908-52540029234D"

}

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 The endpoint’s State/Province.
type STRING The endpoint’s type: SHORT or LONG code.
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).

Success Response

Copy
HTTP/1.1 200 OK

{

"endpoints": [

      {

           "endpoint": "+14082737937",

           "geo": {

                 "city": "San Jose",

                 "country": "US",

                 "stateProvince": "CA"

           },

           "type": "LONG"

      },

      {

           "endpoint": "+14082737938",

           "geo": {

                 "city": "San Jose",

                 "country": "US",

                 "stateProvince": "CA"

           },

           "type": "LONG"

      },

      {

           "endpoint": "+14082737939",

            "geo": {

                  "city": "San Jose",

                  "country": "US",

                  "stateProvince": "CA"

            },

            "type": "LONG"

      }

      ],

  "expirationDate": "2016-11-10T19:03:54Z",

  "reservationID": "3BDBD2D9-A774-11E6-A562-52540029234D",

  "reservedDate": "2016-11-10T18:33:54Z"

}

Error

Name Type Description
code INTEGER Error code
error STRING Error description

Code 400 Response

Copy
HTTP/1.1 400 Bad Request

{

"code": 400,

"error": "Number(s) not available."

}

Code 401 Response

Copy
HTTP/1.1 401 Unauthorized

{

"code": 401,

"error": "Unauthorized"

}

 

Copy
HTTP/1.1 401 Unauthorized

{

"code": 401,

"error": "Session Expired"

}

Code 406 Response

Copy
HTTP/1.1 406 Not Acceptable

{

      "code": 406,

      "error": "Not Acceptable"

}

Code 422 Response

Copy
HTTP/1.1 422 Unprocessable Entity

{

"code": 422,

"error": "The '%s' parameter is required."

}

 

Copy
HTTP/1.1 422 Unprocessable Entity

{

"code": 422,

"error": "The '%s' parameter must be formatted as a(n) array."

}

 

Copy
HTTP/1.1 422 Unprocessable Entity

{

"code": 422,

"error": "The 'endpoints' parameter must be a number(s) in E.164 format."

}