删除客户

删除一个或多个客户。

限制条件

无法删除与云 PBX 关联的用户。

请求 URL

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

请求参数

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

格式：Bearer {access_token}。
请求体
参数 是否必填 类型 说明
customerIds 是 Array <Long> 要删除的客户的 ID。
注：

响应参数

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

示例

请求示例

删除客户 A (ID：50429525) 和客户 B (ID：50429524)。
DELETE /dm/open_api/v1/customers HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQyNzI1OTR9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0Mjc0Mzk0LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJlNmMzYWRkMi1kYzQ0LTQ2ZmEtYjE0ZS0wM2VjNmYwZTI3ZGEiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.HzH9Gz2pVKeAi9fFFvNTlYltvDVjWSUxbCBPHwaHRL
Content-Type: application/json
{
   "customerIds":[50429525,50429524]
}
响应示例
HTTP/1.1 200 OK
{
  "requestId": "15eba94d-c5b2-47c4-bdcc-109322195bea",
  "status": "Success",
  "time": 1664270677
}