Query a Specific DID Number

Request URL

GET {base_url}/dm/open_api/v1/did_management/{didId}

Request parameters

Path parameter


Parameter	Required	Type	Description
didId	Yes	Long	The ID of the DID number. Note: You can query the DID number ID using Query All the DID Numbers.

Headers


Parameter	Required	Type	Description
Authorization	Yes	String	Pass the access token in the header. Format: Bearer `{access_token}`.

Response parameters


Parameter	Type	Description
data	Object <Details>	The detailed information.
requestId	String	The unique ID of the request, which can be used to quickly locate the request.
status	String	Request result: `Success` `Failed`
time	Long	The response time. Note: The YCM API response returns a timestamp, you can convert the timestamp to detailed date and time as needed. For more information, see Convert Timestamp to Local Date and Time.

Details


Parameter	Type	Description
id	Integer	The unique ID of the DID number.
did	String	DID number.
didName	String	The name of the DID number.
creator	String	The creator who adds the DID number.
trunkIds	Array<Integer>	The list of trunk IDs to which the DID number is associated.
cloudPbxId	String	The ID of the PBX instance to which the DID number is assigned.

Example

Request example

Query the information of a DID number (ID: 11).

GET /dm/open_api/v1/did_management/11 HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer ******

Response example

HTTP/1.1 200 OK
{
    "data": {
        "id": 11,
        "did": "+4410001100010",
        "didName": "London Support Tier 2",
        "creator": "Leo Ball",
        "trunkIds": [
            2,
            3,
            6679,
            6680,
            6682
        ],
        "cloudPbxId": "4768"
    },
    "requestId": "a59c6e4460d07126919f9a6466738211",
    "status": "Success",
    "time": 1747026629
}