Get Available DID by SID

This request returns data for a rentable phone number, targeted by secure ID.

get	/phonenumber/available_dids/{did_sid}

Sample

A sample GET request to get an available DID, targeted by secure ID:

curl -X GET \
'https://api.carrierx.com/core/v2/phonenumber/available_dids/07e3dee3-2f0d-4254-b635-21334ccde8b9' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 status code with a serialized copy of the DID object:

{
    "active_capabilities": 4,
    "attributes": {},
    "callback_url": null,
    "campaign_sid": null,
    "capabilities": 7,
    "classification_sid": "17f4d954-d635-4cda-912b-c2a2fa3a6860",
    "country_code": "USA",
    "did_group_sid": null,
    "did_sid": "07e3dee3-2f0d-4254-b635-21334ccde8b9",
    "in_country_format": "(516) 206-5573",
    "international_format": "+1 516-206-5573",
    "lata": null,
    "locality": "NEW YORK",
    "lrn_sid": null,
    "name": "N/A",
    "ocn": "251F",
    "partner_sid": null,
    "phonenumber": "15162065573",
    "porting_pin": null,
    "price": "0.6",
    "state": "NY",
    "status": "available",
    "string_key_1": null,
    "string_key_2": null,
    "transformations": [],
    "trunk_group_sid": null
}

This request is enabled for Field Filtering.

Required Scopes

To get information about rentable numbers the partner must have one of the following scopes enabled:

• phonenumber.manage
• phonenumber.read

Path Arguments

Parameter	Data Type	Description
did_sid required	string	The secure ID of the DID.