YesDev / WebAPI / 获取客户列表(用于分组下的客户名单管理)

获取客户列表(用于分组下的客户名单管理)

接口描述: 获取客户列表

HTTP/HTTPS
请求协议
GET/POST
请求方式
UTF-8
编码格式
JSON
返回格式

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
app_key字符串可选app_key,团队代码
sign字符串可选-动态签名,签名算法请联系我们技术客服获取
group_id字符串必须-最小:1分组ID,未分组传0
customer_name字符串可选-客户名称
customer_level字符串可选-客户等级
order_status字符串可选-排序字段:1-创建时间,2-客户名称,3-客户等级,4-创建人;5-反馈统计
order_status_sort字符串可选-排序:0-降序;1-升序
page整型可选1最小:1当前页数
perpage整型可选100最小:1每页多少条
charge_ids字符串可选-创建人ID,支持多选,用英文逗号分割

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
app_key 可选
sign 可选
group_id 必须
customer_name 可选
customer_level 可选
order_status 可选
order_status_sort 可选
page 可选
perpage 可选
charge_ids 可选

客户端请求示例

# 暂无示例,可添加示例文件:./src/view/docs/demos/Platform.Customer_Customer.GetCustomerList.json

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
410权限不足
500表示服务端内部错误

本文档生成时间:2024-04-27 17:01:40 联系我们开通接入OpenAPI