查询指定中继可用的 DID 号码

查询与指定中继关联的、可用的 DID 号码。

请求 URL

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

请求参数

请求头
参数 是否必填 类型 说明
Authorization 是 String 在请求头中传递访问 Token。

格式：Bearer {access_token}。
查询参数
根据需要发送不同的请求参数。
查询可分配给的云 PBX 的 DID 号码
参数 是否必填 类型 说明
trunkId 是 Integer 共享中继的 ID。
注： 可使用 查询可用共享中继 查询中继 ID。
cloudPbxId 是 Integer 云 PBX 的 ID。
注： 可使用查询所有云 PBX 查询云 PBX 的 ID。
查询可分配给下级用户的 DID 号码
参数 是否必填 类型 说明
trunkId 是 Integer 共享中继的 ID。
注： 可使用 查询可用共享中继 查询中继 ID。
userId 是 Long 查询下级用户的 ID。
注： 可使用 查询所有下级用户 查询用户的 ID。

响应参数

参数 类型 说明
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 号码名称。

示例

  • 请求示例 1

    查询可分配给指定云 PBX (ID：358868) 的、与指定中继 (ID：112129) 关联的 DID 号码。

    GET /dm/open_api/v1/did_management/usable?trunkId=112129&cloudPbxId=358868 HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer ******

    响应示例 1

    HTTP/1.1 200 OK
{
    "data": [
        {
            "id": 1186852,
            "did": "83"
        },
        {
            "id": 1186853,
            "did": "84"
        }
    ],
    "requestId": "d62bdba9c44c08d9d39fcde1403721c5",
    "status": "Success",
    "time": 1766639052
}

  • 请求示例 2

    查询可分配给指定下级用户 (ID：359054) 的、与指定中继 (ID：112129) 关联的 DID 号码。

    GET dm/open_api/v1/did_management/usable?trunkId=112129&userId=359054 HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer ******

    响应示例 2

    HTTP/1.1 200 OK
{
    "data": [
        {
            "id": 1186856,
            "did": "87"
        },
        {
            "id": 1186857,
            "did": "88"
        },
        {
            "id": 1186858,
            "did": "89"
        },
        {
            "id": 1186859,
            "did": "90"
        },
        {
            "id": 1186860,
            "did": "500"
        },
        {
            "id": 1186861,
            "did": "501"
        }
    ],
    "requestId": "25aa1ec145fcb32012ebf0b271f4ed88",
    "status": "Success",
    "time": 1766642449
}