Get External DIDs

This request returns a list of External DIDs registered for the account. External DIDs represent phone numbers managed outside of CarrierX voice infrastructure and are used for SMS/MMS messaging only.

get	/phonenumber/external_dids

Sample

A sample GET request to retrieve External DIDs matching the criteria in the request URL:

curl -X GET \
'https://api.carrierx.com/core/v2/phonenumber/external_dids' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 status code with a list of DID objects:

{
    "count": 1,
    "has_more": true,
    "items": [
        {
            "active_capabilities": 3,
            "attributes": {},
            "callback_url": "https://example.com/sms-callback",
            "campaign_sid": "17f4d954-d635-4cda-912b-c2a2fa3a6860",
            "capabilities": 3,
            "classification_sid": "6a7b1e41-8f55-4a5a-9d42-7e0e9f2a9d11",
            "country_code": "SWE",
            "external_did_sid": "e8df62d5-07a3-4189-a67e-87585067c5fe",
            "id": 8421,
            "in_country_format": "070-098 76 54",
            "international_format": "+46 70 098 76 54",
            "locality": "STOCKHOLM",
            "lrn_sid": "9d2a1e4c-7c6e-4f90-bb0a-8a4f7a0e5d21",
            "name": "SE External DID",
            "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
            "phonenumber": "46700987654",
            "state": null,
            "status": "assigned",
            "string_key_1": null,
            "string_key_2": null,
            "underlying_carrier_sid": "40a8c9cf-8b08-4c21-a3e3-952c65ee892d"
        }
    ],
    "limit": 1,
    "offset": 0,
    "pagination": {
        "next": "https://api.carrierx.com/core/v2/phonenumber/dids?limit=1&offset=1"
    },
    "total": 1
}

This request is enabled for Pagination, Result Filtering, and Field Filtering.

Required Scopes

To get information about Partner objects, the partner must have one of the following scopes enabled:

• phonenumber.manage
• phonenumber.read

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.