Get Available DID

Description

Returns a single Available DID from DIDWW inventory.

Note

Available DID request is not enabled by default. To enable this feature, please contact our Customer Service or Sales Departments.

Request

HTTP Method: GET

URI Path: /v3/available_dids/

URI Query Parameters:

Name	Type	Is Required?	Description
id	string	Yes	Unique ID number of the Available DID.
include	string	Optional	Inclusion

Includes:

Value	Description
did_group	DID Group Object
did_group.stock_keeping_units	Stock Keeping Unit Object

Examples

Simple requestInclude did_groupInclude did_group.stock_keeping_units

http

GET /v3/available_dids/5265f3a0-0446-46f1-ae1a-f09946e80a9a HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

curl

curl -i -X GET https://api.didww.com/v3/available_dids/5265f3a0-0446-46f1-ae1a-f09946e80a9a -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"

response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
   "data": {
     "id": "5265f3a0-0446-46f1-ae1a-f09946e80a9a",
     "type": "available_dids",
     "attributes": {
       "number": "19254349408"
     },
     "relationships": {
       "did_group": {
         "links": {
           "self": "https://api.didww.com/v3/available_dids/5265f3a0-0446-46f1-ae1a-f09946e80a9a/relationships/did_group",
           "related": "https://api.didww.com/v3/available_dids/5265f3a0-0446-46f1-ae1a-f09946e80a9a/did_group"
         }
       }
     }
   },
     "meta": {
         "api_version": "2017-09-18"
     }
 }

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized