查询指定客户

查询指定客户的详细信息。

请求 URL

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

请求参数

路径参数

参数 是否必填 类型 描述
customerId 是 long 客户 ID。
注： 可使用 查询所有客户 或 查询云 PBX 的客户 接口查询客户 ID。
请求头
参数 是否必填 类型 描述
Authorization 是 String 在请求头中传递访问 Token。

格式：Bearer {access_token}。

响应参数

参数 类型 描述
data Object <Details> 详情。
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。
Details
参数 类型 描述
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 备注。

示例

查询指定客户 (ID: 50086120) 的信息。

请求示例

GET /dm/open_api/v1/customers/50086120 HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQyNDg4ODV9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0MjUwNjg1LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJiZmQ5MjU3MC00NTA0LTQ4YzYtOWM0NS00OTNjZThkYTUwOTYiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.CqUd1N3O2tng0fFCUZPouJl5VeGRYSPTA7pw7ISbRT8
响应示例
HTTP/1.1 200 OK
{
  "data": {
        "customerId": 50086120,
        "firstName": "Leo",
        "lastName": "Ball",
        "company": "Example company",
        "email": "leo@example.com"
        "businessNumber": "123123123",
        "mobileNumber": "1234567890",
        "homeNumber": "123123123",
        "faxNumber": "1234567890",
        "zipCode": "249000",
        "street": "10F Jervois Road",
        "city": "Singapore",
        "state": " ",
        "country": "Singapore",
        "remark": "fake-info"
  },
  "requestId": "b996f86a9d83c8383583883955f60b17",
  "status": "Success",
  "time": 1664250039 
}