这里会显示出您选择的修订版和当前版本之间的差别。
两侧同时换到之前的修订记录 前一修订版 后一修订版 | 前一修订版 | ||
帮我吧文档:数据接口:客服:客服 [2020/05/06 16:11] admin |
帮我吧文档:数据接口:客服:客服 [2024/05/16 15:47] (当前版本) admin [获取客服签到列表] |
||
---|---|---|---|
行 17: | 行 17: | ||
|QQ |varchar |否 |否 |QQ号码 | | |QQ |varchar |否 |否 |QQ号码 | | ||
|isAdmin |tinyint |否 |否 |是否是管理员:0-非管理员,1-管理员,默认为0| | |isAdmin |tinyint |否 |否 |是否是管理员:0-非管理员,1-管理员,默认为0| | ||
+ | |isStat | ||
|createDT |datetime |是 |否 |创建时间,格式为:2018-02-03 00:00:00 | | |createDT |datetime |是 |否 |创建时间,格式为:2018-02-03 00:00:00 | | ||
+ | |custom_fields |array |是 |否 |自定义字段 | | ||
+ | |||
+ | |||
+ | |||
====JSON示例==== | ====JSON示例==== | ||
行 105: | 行 110: | ||
{ | { | ||
" | " | ||
- | " | + | " |
- | " | + | " |
- | | + | " |
+ | " | ||
+ | " | ||
+ | | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ] | ||
} | } | ||
} | } | ||
行 159: | 行 183: | ||
< | < | ||
curl -v -u {account}: | curl -v -u {account}: | ||
- | -H " | + | -H " |
- | " | + | |
+ | | ||
+ | " | ||
+ | | ||
+ | | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ] | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | ] | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | }' | ||
</ | </ | ||
//说明: // \\ | //说明: // \\ | ||
行 209: | 行 304: | ||
</ | </ | ||
+ | |||
+ | ====删除客服信息==== | ||
+ | < | ||
+ | DELETE / | ||
+ | </ | ||
+ | |||
+ | **调用者权限** | ||
+ | 管理员 | ||
+ | | ||
+ | **调用示例** | ||
+ | |||
+ | < | ||
+ | curl -v -u {account}: | ||
+ | -H " | ||
+ | -X DELETE | ||
+ | </ | ||
+ | **返回值示例** | ||
+ | |||
+ | < | ||
+ | Status: 200 OK | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | |||
+ | ====搜索客服信息==== | ||
+ | < | ||
+ | GET / | ||
+ | </ | ||
+ | **查询参数** | ||
+ | ^名称 ^必需的 ^类型 ^注释 ^ | ||
+ | |query | ||
+ | |sort_by|否 |string |按时间排序,目前支持:createDT-创建时间,updateDT-更新时间| | ||
+ | |sort_order|否 |string |按升序还是降序返回,取值为:asc-升序,desc-降序,默认为降序| | ||
+ | // | ||
+ | |||
+ | query参数说明 | ||
+ | ^搜索内容 ^返回结果 ^ | ||
+ | |query=sPassportName: | ||
+ | |query=name: | ||
+ | |query=sNum: | ||
+ | |query=mobile: | ||
+ | |||
+ | **调用者权限** | ||
+ | 管理员 | ||
+ | | ||
+ | **调用示例** | ||
+ | < | ||
+ | curl https:// | ||
+ | -H " | ||
+ | -v -u {account}: | ||
+ | </ | ||
+ | |||
+ | **返回值示例** | ||
+ | < | ||
+ | Status: 200 OK | ||
+ | { | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ====恢复删除的客服==== | ||
+ | < | ||
+ | PUT / | ||
+ | </ | ||
+ | **请求参数** | ||
+ | ^名称 ^必需的 ^类型 ^注释 ^ | ||
+ | |isStat|是 |int |客服是否生效0: | ||
+ | |||
+ | **调用示例** | ||
+ | < | ||
+ | curl -v -u {account}: | ||
+ | </ | ||
+ | |||
+ | |||
+ | **返回值示例** | ||
+ | < | ||
+ | Status: 200 OK | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | |||
+ | ====开通呼叫中心权限==== | ||
+ | **请求参数** | ||
+ | ^名称 ^必需的 ^类型 ^注释 ^ | ||
+ | |sId | ||
+ | |mType | ||
+ | |state | ||
+ | |||
+ | |||
+ | **请求地址** | ||
+ | < | ||
+ | PUT / | ||
+ | </ | ||
+ | |||
+ | **调用者权限** | ||
+ | 管理员 | ||
+ | |||
+ | **调用示例** | ||
+ | < | ||
+ | curl https:// | ||
+ | -H " | ||
+ | -d ' | ||
+ | </ | ||
+ | |||
+ | **返回值示例** | ||
+ | < | ||
+ | Status: 200 OK | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | **当客服ID不存在时返回** | ||
+ | < | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ====查看客服状态==== | ||
+ | **请求参数** | ||
+ | ^名称 ^必需的 ^类型 ^注释 ^ | ||
+ | |plate | ||
+ | |||
+ | **请求地址** | ||
+ | < | ||
+ | GET / | ||
+ | </ | ||
+ | |||
+ | **调用者权限** | ||
+ | < | ||
+ | | ||
+ | **调用示例** | ||
+ | < | ||
+ | curl -X GET -v -u {account}: | ||
+ | </ | ||
+ | |||
+ | **返回参数** | ||
+ | ^名称 ^类型 ^注释 ^ | ||
+ | |sId | ||
+ | |plate | ||
+ | |state | ||
+ | |||
+ | |||
+ | **返回值示例** | ||
+ | < | ||
+ | Status: 200 OK | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | |||
+ | </ | ||
+ | |||
+ | |||
+ | ====修改客服状态==== | ||
+ | **请求参数** | ||
+ | ^名称 ^必需的 ^类型 ^注释 ^ | ||
+ | |plate | ||
+ | |state | ||
+ | |||
+ | **请求地址** | ||
+ | < | ||
+ | PUT / | ||
+ | </ | ||
+ | |||
+ | **调用者权限** | ||
+ | < | ||
+ | | ||
+ | **调用示例** | ||
+ | < | ||
+ | curl https:// | ||
+ | -H " | ||
+ | -d '{ | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | }' \ | ||
+ | -v -u {account}: | ||
+ | </ | ||
+ | |||
+ | **返回参数** | ||
+ | ^名称 ^类型 ^注释 ^ | ||
+ | |sId | ||
+ | |plate | ||
+ | |state | ||
+ | |||
+ | |||
+ | **返回值示例** | ||
+ | < | ||
+ | Status: 200 OK | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | |||
+ | </ | ||
+ | |||
+ | |||
+ | |||
+ | ====获取客服签到列表==== | ||
+ | |||
+ | **请求地址** | ||
+ | < | ||
+ | GET / | ||
+ | </ | ||
+ | |||
+ | **查询参数** | ||
+ | ^名称 ^必需的 ^类型 ^注释 ^ | ||
+ | |created_start |否 |string |按创建时间筛选,开始时间| | ||
+ | |created_end |否 |string |按创建时间筛选,结束时间| | ||
+ | |created_order |否 |string |按创建时间排序,取值为:asc-升序,desc-降序| | ||
+ | |sId |否 |int |按客服id进行筛选| | ||
+ | |page |否 |int |分页获取,默认为1| | ||
+ | |per_page |否 |int |每页大小,默认为100| | ||
+ | // | ||
+ | |||
+ | **调用者权限** | ||
+ | < | ||
+ | |||
+ | | ||
+ | **调用示例** | ||
+ | < | ||
+ | curl --location --request GET ' | ||
+ | --header ' | ||
+ | --header ' | ||
+ | </ | ||
+ | |||
+ | **返回参数** | ||
+ | ^名称 ^类型 ^注释 ^ | ||
+ | |name | ||
+ | |sNum | ||
+ | |remark | ||
+ | |attachments | ||
+ | |tags | ||
+ | |checkinTime | ||
+ | |clockingPoint | ||
+ | **返回值示例** | ||
+ | < | ||
+ | Status: 200 OK | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | |||
+ | </ | ||
+ | |||
+ | |||
+ | ====创建客服签到==== | ||
+ | |||
+ | **请求地址** | ||
+ | < | ||
+ | POST / | ||
+ | </ | ||
+ | |||
+ | **查询参数** | ||
+ | ^名称 ^必需的 ^类型 ^注释 ^ | ||
+ | |remark | ||
+ | |attachments |否 |array |签到附件(最多9个附件)| | ||
+ | |tags | ||
+ | |checkinTime | ||
+ | |current | ||
+ | current参数说明: | ||
+ | ^名称 ^必需的 ^类型 ^注释 ^ | ||
+ | |address | ||
+ | |landmark | ||
+ | |latitude | ||
+ | |longitude | ||
+ | |||
+ | **调用者权限** | ||
+ | < | ||
+ | |||
+ | | ||
+ | **调用示例** | ||
+ | < | ||
+ | curl --location --request POST ' | ||
+ | --header ' | ||
+ | --header ' | ||
+ | --data-raw '{ | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | }' | ||
+ | |||
+ | </ | ||
+ | |||
+ | **返回参数** | ||
+ | ^名称 ^类型 ^注释 ^ | ||
+ | |name | ||
+ | |sNum | ||
+ | |remark | ||
+ | |attachments | ||
+ | |tags | ||
+ | |checkinTime | ||
+ | |clockingPoint | ||
+ | **返回值示例** | ||
+ | < | ||
+ | Status: 200 OK | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | |||
+ | |||
+ | </ | ||
+ | |||
+ | |||
+ | ====获取客服排班列表==== | ||
+ | |||
+ | **请求地址** | ||
+ | < | ||
+ | GET / | ||
+ | </ | ||
+ | |||
+ | **查询参数** | ||
+ | ^名称 ^必需的 ^类型 ^注释 ^ | ||
+ | |startDT | ||
+ | |endDT | ||
+ | |||
+ | |||
+ | **调用者权限** | ||
+ | < | ||
+ | |||
+ | | ||
+ | **调用示例** | ||
+ | < | ||
+ | curl --location ' | ||
+ | --header ' | ||
+ | --header ' | ||
+ | </ | ||
+ | |||
+ | |||
+ | **返回参数** | ||
+ | ^名称 ^类型 ^注释 ^ | ||
+ | |sid |int |客服id | ||
+ | |date | ||
+ | |schedules | ||
+ | schedules参数 | ||
+ | ^名称 ^类型 ^注释 ^ | ||
+ | |dutyId | ||
+ | |name | ||
+ | |remark | ||
+ | |start_time | ||
+ | |start_time | ||
+ | |||
+ | **返回值示例** | ||
+ | < | ||
+ | Status: 200 OK | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | [ | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ] | ||
+ | ] | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | |||
+ | |||
+ | </ | ||
+ | |||
+ | |||
+ | ====新增客服排班==== | ||
+ | |||
+ | **请求地址** | ||
+ | < | ||
+ | POST / | ||
+ | </ | ||
+ | |||
+ | **请求参数** | ||
+ | ^名称 ^必需的 ^类型 ^注释 ^ | ||
+ | |sid |是 |int | ||
+ | |date | ||
+ | |schedules | ||
+ | schedules参数内容 | ||
+ | ^名称 ^必需的 ^类型 ^注释 ^ | ||
+ | |name | ||
+ | |remark | ||
+ | |start_time | ||
+ | |end_time | ||
+ | |url |否 |string | ||
+ | |||
+ | **调用者权限** | ||
+ | < | ||
+ | |||
+ | | ||
+ | **调用示例** | ||
+ | < | ||
+ | curl --location --request POST ' | ||
+ | --header ' | ||
+ | --header ' | ||
+ | --data-raw '{ | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ] | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | ] | ||
+ | }}' | ||
+ | |||
+ | </ | ||
+ | |||
+ | |||
+ | **返回参数** | ||
+ | ^名称 ^类型 ^注释 ^ | ||
+ | |sid |int |客服id | ||
+ | |date | ||
+ | |schedules | ||
+ | schedules参数 | ||
+ | ^名称 ^类型 ^注释 ^ | ||
+ | |dutyId | ||
+ | |name | ||
+ | |remark | ||
+ | |start_time | ||
+ | |start_time | ||
+ | |url |string |点击排班后的跳转链接 | | ||
+ | |||
+ | **返回值示例** | ||
+ | < | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ] | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | } | ||
+ | |||
+ | |||
+ | </ | ||
+ | |||
+ | |||
+ | |||
+ | ====更新客服排班==== | ||
+ | |||
+ | **请求地址** | ||
+ | < | ||
+ | PUT / | ||
+ | </ | ||
+ | |||
+ | 说明: | ||
+ | ①修改接口只支持单条修改。 | ||
+ | ②不可修改排班的客服和日期,如果需要修改这两个参数需要删除原有的排班,创建一个新排班。 | ||
+ | |||
+ | **请求参数** | ||
+ | ^名称 ^必需的 ^类型 ^注释 ^ | ||
+ | |name | ||
+ | |remark | ||
+ | |start_time | ||
+ | |end_time | ||
+ | |url |否 |string |点击排班后的跳转链接 | ||
+ | |||
+ | |||
+ | **调用者权限** | ||
+ | < | ||
+ | |||
+ | | ||
+ | **调用示例** | ||
+ | < | ||
+ | curl --location --request PUT ' | ||
+ | --header ' | ||
+ | --header ' | ||
+ | --data '{ | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | }' | ||
+ | |||
+ | </ | ||
+ | |||
+ | |||
+ | **返回参数** | ||
+ | ^名称 ^类型 ^注释 ^ | ||
+ | |sid |int |客服id | ||
+ | |date | ||
+ | |schedules | ||
+ | schedules参数 | ||
+ | ^名称 ^类型 ^注释 ^ | ||
+ | |dutyId | ||
+ | |name | ||
+ | |remark | ||
+ | |start_time | ||
+ | |start_time | ||
+ | |||
+ | **返回值示例** | ||
+ | < | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | |||
+ | </ | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ====删除客服排班==== | ||
+ | |||
+ | **请求地址** | ||
+ | < | ||
+ | DELETE | ||
+ | </ | ||
+ | |||
+ | 说明:①只能删除单条 | ||
+ | |||
+ | **调用者权限** | ||
+ | < | ||
+ | | ||
+ | **调用示例** | ||
+ | < | ||
+ | curl --location --request DELETE ' | ||
+ | --header ' | ||
+ | |||
+ | </ | ||
+ | |||
+ | |||
+ | **返回参数** | ||
+ | ^名称 ^类型 ^注释 ^ | ||
+ | |sid |int |客服id | ||
+ | |date | ||
+ | |schedules | ||
+ | schedules参数 | ||
+ | ^名称 ^类型 ^注释 ^ | ||
+ | |dutyId | ||
+ | |name | ||
+ | |remark | ||
+ | |start_time | ||
+ | |start_time | ||
+ | |||
+ | **返回值示例** | ||
+ | < | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | |||
+ | </ | ||
+ | |||
+ | |||
+ | ====错误状态码==== | ||
+ | ^错误码 ^注释 ^ | ||
+ | |10011 | ||
+ | |10012 | ||
+ | |10013 |