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

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.

 

 

Request

{

    "endpoints": [

        "+12127293863",

        "1-21272"

    ]

}

 

Request with explicit reservation ID

{

    "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 will expire.

 

reservedDate

DateTime

The ISO 8601 date the reservation was created.

 

reservationID

String

The Universally Unique Identifier (UUID) associated with the endpoint(s). (see Universally unique identifier)

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"

}
Response example and schema 

 

Error 

 

Name

Type

Description

code

 

Integer

Error code

error

String

Error description

HTTP/1.1 400 Bad Request

{

"code": 400,

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

}
HTTP/1.1 401 Unauthorized

{

"code": 401,

"error": "Unauthorized"

}




HTTP/1.1 401 Unauthorized

{

"code": 401,

"error": "Session Expired"

}
HTTP/1.1 406 Not Acceptable

{

      "code": 406,

      "error": "Not Acceptable"

}
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 'endpoints' parameter must be a number(s) in E.164 format."

}