Query the Assigned DID Numbers of a Cloud PBX

Query the assigned DID numbers of a specific Cloud PBX.

Request URL

GET {base_url}/dm/open_api/v1/did_management/{cloudPbxId}/did

Request parameters

Path parameter
Parameter Required Type Description
cloudPbxId Yes Long The ID of the desired Cloud PBX.
Note: You can query the Cloud PBX ID using Query All the Cloud PBXs.
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
didIds Array<Integer> The ID list of the DID numbers assigned to the Cloud PBX.

Example

Request example

Query the assigned DID numbers of a Cloud PBX (ID: 4768).

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

Response example

HTTP/1.1 200 OK
{
    "data": {
        "didIds": [
            2,
            3,
            2,
            3,
            11,
            10,
            9,
            8,
            3
        ]
    },
    "requestId": "79b3d480a015726f3dd8cdf12e9c9d4a",
    "status": "Success",
    "time": 1747027117
}