查询所有 YCM 用户

查询所有 YCM 用户的信息。

请求 URL

GET {base_url}/dm/open_api/v2/users

请求参数

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

格式：Bearer {access_token}。
查询参数
表 1.
参数 是否必填 类型 描述
pageSize 否 Integer 定义每页显示几项查询结果。
  • 默认值：10
  • 最大值：50
pageNumber 否 Integer 定义显示第几个页面。
  • 默认值：1
sort 否 String 定义排序字段。

可在排序字段中填入 响应参数，对查询结果进行排序。

示例：
  • userId：查询结果根据用户的 ID 升序排序。
  • -userId：查询结果根据用户的 ID 降序排序。

响应参数

参数 类型 描述
data Object <Details> 详情。
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。
Details
参数 类型 描述
pageSize Integer 每页显示几项查询结果。
pageNumber Integer 当前显示第几页。
total Integer YCM 用户总数量。
list Array <User_Info> YCM 用户的信息列表。
User_Info
参数 类型 描述
userId Long 用户 ID。
company String 公司名称。
firstName String 名称。
lastName String 姓氏。
email String 邮箱。
phone String 电话号码。
mobile String 手机号码。
address String 地址。
remark String 备注。
createdCloudPbx Integer 创建的 PBX 数量。
createdReseller Integer 托管用户创建的经销商数量。
注： 此字段仅在用户类型为 Hosting User 时返回。
userType String 用户类型。
  • My Colleague：我的同事
  • Hosting User：托管用户

示例

请求示例

查询所有 YCM 用户的信息：
  • 每页显示 2 条记录。
  • 显示第 1 页。
  • 查询结果根据用户 ID 升序排序。
GET /dm/open_api/v2/users?pageSize=2&pageNumber=1&sort=userId HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NzM0OSwidmVyc2lvbiI6MTYzODk1OTkwOSwicmVmcmVzaFZlcnNpb24iOjE2Mzg5NjI4NDB9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjM4OTY0NjQwLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJmZjBiNWM1MS03YjBhLTQwYjYtYTRkNS04ZWZkMzY1OGJlZDkiLCJjbGllbnRfaWQiOiJrcDl5eW50bXVlc3VrNWpvV3ZNa1RiQ0J4cU82TEtSaCJ9.RNiea7bNZtBO5QWvnChhK8m-Bcg_qSZY5gods0Gq7z0

响应示例

HTTP/1.1 200 OK
{
  "data": {
    "pageSize": 2,
    "pageNumber": 1,
    "total": 5515,
    "list": [
      {
        "userId": 3587,
        "company": "Yeastar",
        "firstName": "Leo",
        "lastName": "Ball",
        "email": "leo@example.com",
        "phone": "13988888888",
        "address": "USA",
        "createdCloudPbx": 10,
        "createdReseller": 3,
        "userType": "Hosting User"
      },
      {
        "userId": 3598,
        "company": "Yeastar",
        "firstName": "Wayne",
        "lastName": "William",
        "email": "wayne@example.com",
        "phone": "13911111111",
        "address": "USA",
        "createdCloudPbx": 20,
        "createdReseller": 3,
        "userType": "Hosting User"
      }
    ]
  },
  "requestId": "6fb77cb84c8e8207e10e7387f0ee16a7",
  "status": "Success",
  "time": 1664429119
}