查询所有客户

查询所有客户的信息。

请求 URL

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

请求参数

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

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

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

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

响应参数

参数 类型 说明
data Object <Details> 详情。
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。
Details
参数 类型 说明
pageSize Integer 每页显示几项查询结果。
pageNumber Integer 当前显示第几页。
total Integer 客户总数。
list Array <Customer_Info> 客户的信息列表。
Customer_Info
参数 类型 说明
customerId Long 客户 ID。
firstName String 名称。
lastName String 姓氏。
company String 公司名称。
email String 邮箱。
businessNumber String 公司电话号码。
mobileNumber String 手机号码。
homeNumber String 家庭电话号码。
faxNumber String 传真号码。
zipCode String 邮政编码。
street String 街道。
city String 城市。
state String 省份。
country String 国家。
remark String 备注。

示例

请求示例

查询所有客户信息：
  • 每页显示 3 条记录。
  • 显示第 1 页。
  • 查询结果根据客户 ID 升序排序。
GET /dm/open_api/v1/customers?pageSize=3&pageNumber=1&sort=customerId HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwicmVmcmVzaFZlcnNpb24iOjE2MzkwMTIwODh9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjM5MDEzODg4LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI3MGI3N2NiOC03MzZjLTQxODctYjM2Yy0xNjM0MzNlZWJjNWEiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9._I0umqPvrMKnL1tlkragMjkuGWcYg1SAoTimfyKl7i8
响应示例
HTTP/1.1 200 OK
{
  "data": {
    "pageSize": 3,
    "pageNumber": 1,
    "total": 364,
    "list": [
      {
        "customerId": 50086120,
        "firstName": "Leo",
        "lastName": "Ball",
        "company": "Example company",
        "email": "leo@example.com",
        "businessNumber": "136160XXXXX",
        "zipCode": "361000",
        "city": "Xiamen",
        "state": "Fujian",
        "country": "China"
      },
      {
        "customerId": 50086121,
        "firstName": "Naomi",
        "lastName": "Nicholas",
        "company": "Example company",
        "email": "naomi@example.com",
        "mobileNumber":"139111XXXXX"
      },
      {
        "customerId": 50086122,
        "firstName": "Ashley",
        "lastName": "Gardner",
        "company": "Example company",
        "email": "ashley@example.com",
        "faxNumber":"001-111-1111"
      }
    ]
  },
  "requestId": "bff89f41bb695e5abb84c45972d24716",
  "status": "Success",
  "time": 1664248965
}