Get External DID by SID

This request returns data for an External DID, targeted by secure ID. External DIDs support SMS/MMS messaging only.

Sample

A sample GET request to get data for an External DID, targeted by secure ID:

curl -X GET \
'https://api.carrierx.com/core/v2/phonenumber/external_dids/f448e2c3-88c1-4cd1-8cf2-3567c16e0794' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

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

{
    "active_capabilities": 3,
    "attributes": {},
    "callback_url": null,
    "campaign_sid": null,
    "capabilities": 3,
    "classification_sid": "6a7b1e41-8f55-4a5a-9d42-7e0e9f2a9d11",
    "country_code": "SWE",
    "external_did_sid": "f448e2c3-88c1-4cd1-8cf2-3567c16e0794",
    "id": 8422,
    "in_country_format": "(070) 098-7654",
    "international_format": "+46 70-098-7654",
    "lata": null,
    "locality": "STOCKHOLM",
    "lrn_sid": null,
    "name": "SE External DID",
    "ocn": null,
    "ocn_block": null,
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "phonenumber": "+46700987654",
    "provider_sid": "319ddc05-657f-4867-ba99-5ec70bf1096f",
    "state": null,
    "status": "assigned",
    "string_key_1": null,
    "string_key_2": null,
    "underlying_carrier_sid": "40a8c9cf-8b08-4c21-a3e3-952c65ee892d",
}

This request is enabled for Field Filtering.

Required Scopes

To get information about an external DID object, the partner must have one of the following scopes enabled:

• phonenumber.manage
• phonenumber.read

Path Arguments

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

Query Arguments

Parameter	Data Type	Description
with_related	boolean	Determines if the partner information related to the phone number should be shown. Values accepted in this field are true and false. The default value is false.