查询指定 DID 号码

查询指定 DID 号码的信息。

请求 URL

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

请求参数

路径参数
参数 是否必填 类型 说明
didId 是 Long DID 号码的 ID。
注： 可使用 查询所有 DID 号码 接口查询号码 ID。
请求头
参数 是否必填 类型 说明
Authorization 是 String 在请求头中传递访问 Token。

格式：Bearer {access_token}。

响应参数

参数 类型 说明
data Object <Details> 详情。
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。
Details
参数 类型 说明
id Integer DID 号码的 ID。
did String DID 号码。
didName String DID 号码名称。
creator String DID 号码创建者。
trunkIds Array<Integer> 与 DID 号码关联的中继 ID 列表。
cloudPbxId String 分配了 DID 号码的云 PBX 的 ID。

示例

请求示例

查询 DID 号码 (ID: 11) 的信息。

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

响应示例

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
}