客服系统接口文档
- 客服系统接口文档
- 商户分组信息
- 用户与客服系统建立连接
- 自定义推送url
商户分组信息
- 请求URL
客服系统域名/api/group/[business_id]
微擎版
微擎域名/addons/zjhj_cs/public/index.php/api/group/[business_id]
- 请求方式
GET
- 请求参数
| 请求参数 | 参数类型 | 参数说明 |
|---|---|---|
| business_id | Integer,不可为空 | 客服系统ID |
- 返回参数
| 返回参数 | 参数类型 | 参数说明 |
|---|---|---|
| code | Integer | 执行结果code |
| message | String | 执行结果 |
| errorCode | Integer | 错误码 |
- 返回示例
{
code: 0,
msg: [
{
id: 11,
groupname: "test1"
},
{
id: 12,
groupname: "多商户分组1"
}
]
}
用户与客服系统建立连接
- 请求URL
客服系统域名/index/index/home?visiter_id=&visiter_name=&avatar=&business_id=&groupid=&product=
微擎版
微擎域名/addons/zjhj_cs/public/index.php/index/index/home?visiter_id=&visiter_name=&avatar=&business_id=&groupid=&product=
- 请求方式
GET
- 请求参数
| 请求参数 | 参数类型 | 参数说明 |
|---|---|---|
| visiter_id | String,可为空 | 用户ID |
| visiter_name | String,可为空 | 用户昵称 |
| avatar | String,可为空 | 用户头像 |
| business_id | Integer,不可为空 | 客服系统ID |
| groupid | Integer,可为空 | 分组ID 从 商户分组信息 获取 |
| product | JSON 可为空 | {"pid":1,"title":" Apple MacBook Air ","img":"http://www.wolive.cc/assets/images/pro.jpg","info":"13.3英寸笔记本电脑 银色(2017款Core i5 处理器/8GB内存/128GB闪存 MQD32CH/A)","price":"￥7588.00","url":"http://www.wolive.cc/demo/index/product1"} |
自定义推送url
- 推送URL用户自定义
- 推送参数
| 请求参数 | 参数说明 |
|---|---|
| visiter_id | 用户ID |
| content | 发送聊天内容 |
| business_id | 客服系统ID |
| service_id | 客服ID |
| direction | 发送方向 to_visiter 或 to_service |
| timestamp | 时间戳 |
| group | 客服分组 |
| state | 访客状态 online 或 offline |
| service_name | 客服昵称 |
| service_url | 客服链接 |
- 返回参数
对接方自定义