查询所有 DID 号码

查询所有 DID 号码的信息。

请求 URL

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

请求参数

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

格式：Bearer {access_token}。
查询参数
参数 是否必填 类型 说明
pageNumber 否 Integer 定义显示第几个页面。
  • 默认值：1
pageSize 否 Integer 定义每页显示几项查询结果。
  • 默认值：10
  • 最大值：50
search 否 String 搜索关键字。

响应参数

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

示例

请求示例

查询 DID 号码列表。
  • 每页返回 3 条记录。
  • 显示第一页记录。
  • 搜索 DID 名称 London Support Tier 2。
GET /dm/open_api/v1/did_management?pageSize=3&pageNumber=1&search=London Support Tier 2 HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer ******

响应示例

HTTP/1.1 200 OK
{
    "data": {
        "pageSize": 3,
        "pageNumber": 1,
        "total": 10,
        "list": [
            {
                "id": 11,
                "did": "+4410001100010",
                "didName": "London Support Tier 2",
                "creator": "Leo Ball",
                "trunkIds": [
                    2,
                    3,
                    6679,
                    6680,
                    6682
                ],
                "cloudPbxId": "4768"
            },
            {
                "id": 10,
                "did": "+4410001100009",
                "didName": "London Support Tier 2",
                "creator": "Leo Ball",
                "trunkIds": [
                    2,
                    3,
                    6679,
                    6680
                ],
                "cloudPbxId": "4768"
            },
            {
                "id": 9,
                "did": "+4410001100008",
                "didName": "London Support Tier 2",
                "creator": "Leo Ball",
                "trunkIds": [
                    2,
                    3,
                    6679,
                    6680
                ],
                "cloudPbxId": "4768"
            }
        ]
    },
    "requestId": "636fc9504d20bb9912521ed44ee1f580",
    "status": "Success",
    "time": 1747021072
}