向日葵坐席
向日葵坐席
提供向日葵坐席外部开通接口
坐席服务
关闭坐席服务
基本信息
Path： /seats/services
Method： DELETE
接口描述：
Request
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/x-www-form-urlencoded | 是 |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| account | 是 | ||
| eweiid | 是 |
开通坐席服务
基本信息
Path： /seats/services
Method： POST
接口描述：
Request
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
{
"eweiid":222,
"account": "xxx", // 贝锐帐号
"quantity":1, // 数量
"unit" : "m", // m -> 月, d -> 日 y -> 年
"period" : 12, // 对应上面的额unit。 unit是月的时候，period就是传多少个月。是日的时候period就是传多少日
"expiredate": 1658717596 // 直接传时间戳
}
Reponse
{
"quantity":1, // 数量
"service_id": 20294848 // 服务ID
}
更新坐席服务
基本信息
Path： /seats/services
Method： PATCH
接口描述：
Request
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
{
"eweiid":222,
"account": "xxx", // 贝锐帐号
"quantity":1, // 数量
"expiredate": 1658717596
}
查询坐席服务
基本信息
Path： /seats/services/:account
Method： GET
接口描述：
Request
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| account |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| eweiid | 是 | 易维ID |
Reponse
{
"serviceid":20294848,
"quantity":1, // 数量
"expiredate":1972742400 // 过期时间
}
错误码
错误码列表
基本信息
Path： /
Method： GET
接口描述：
若http statuscode 5xx的响应或网络问题，不能保证返回信息的内容与格式，消费端必须做适当的容错处理
消费端直接解析对应的code
| error | code （int型） | 说明 |
|---|---|---|
| seat/xx | 150675473 | 坐席服务已过期 |
| 150675477 | 坐席服务不存在 | |
| 150675464 | 坐席（ID）不存在 | |
| 150675478 | 坐席服务已存在 （开通坐席服务的时候会返回） | |
| 150675461 | 已超过坐席服务数量上限 | |
| 150675475 | 修改坐席密码失败 | |
150765569 | 用户不存在 （贝锐帐户） | |
| seats/params_error | 150675479 | 参数错误 |
| 150675480 | 电话号码冲突重复 | |
| 150675481 | 坐席（id）重复 |
Request
Reponse
// 业务错误统一返回格式：
{
"error": "module/some_error",
"code": 44444,
"message": "error messasges",
}
坐席成员
修改坐席成员帐号
基本信息
Path： /seats/members
Method： PATCH
接口描述：
Request
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
{
"eweiid": 222,
"seat_identity": "string", // 坐席成员唯一ID
"mobile": "13800138000",
"password": "123456"
}
开通坐席成员帐号
基本信息
Path： /seats/members
Method： POST
接口描述：
Request
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
{
"eweiid":222,
"account":"xxx", // 贝锐的帐号 必传
"name": "坐席成员name", // 直接传一个过来就行 必传
"seat_identity":"string", // 坐席成员唯一ID 必传
"mobile":"13800138000", // 选填
"password":"MD5(123456)" // 直接传一个MD5 后的值 必传
}
查询坐席成员列表
基本信息
Path： /seats/members
Method： GET
接口描述：
Request
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| account | 是 | ||
| eweiid | 是 | ||
| limit | 是 | 100 | |
| offset | 是 | 偏移量 *limit 从0开始 |
Reponse
{
"seats": [
{
//坐席名
"name": "test3AZX",
//坐席唯一标识ID
"seat_identity": "supp419409",
//手机号
"mobile": 13697464444,
//创建时间
"create_time": 1623159364,
//是否在线
"is_online": true
}
],
//总数
"total": 1,
//当前在线数
"online": 1,
//在线量
"total_online":10
}
注销坐席成员帐号
基本信息
Path： /seats/members/:seat_identity
Method： DELETE
接口描述：
Request
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| seat_identity |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| eweiid | 是 | ||
| account | 是 |
日志
坐席日志
基本信息
Path： /seats/logs
Method： GET
接口描述：
Request
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| account | 是 | ||
| eweiid | 是 | ||
| remote_time | 是 | 数组，时间段 | |
| remote_time | 是 | ||
| limit | 是 | ||
| offset | 是 |
Reponse
{
"logs": [
{
//日志ID
"log_id": 24,
//帐户ID
"user_id": 12564122,
//坐席ID
"seat_identity": "supp471970",
//坐席名称
"seat_name": "456",
//识别码
"fastcode": "123131231",
//事件
"event": "view",
//开始时间
"start_time": 1618393693,
//结束时间
"end_time": 1622702781,
//备注
"memo": "test2",
//主控端信息
"slcc_info": {
//主控端IP
"slcc_ip": "116.235.162.148",
//主控端版本
"slcc_version": "5.1.0.32847",
//主控端系统
"slcc_osname": "Linux",
//主控端主机名称
"slcc_pcname": "主控1"
},
//被动控端信息
"slrc_info": {
//被控端IP
"slrc_ip": "192.168.0.1",
//被控端版本
"slrc_version": "5.3.1.6",
//被控端系统
"slrc_osname": "test",
//被控端主机名称
"slrc_pcname": "6666"
},
//被控端备注
"slrc_name": "被控2",
//日志创建时间
"create_time": 1618393693
}
],
//总数
"total": 1,
//事件下拉
"events": {
"login": "登录",
"logout": "登出",
"remote": "远程桌面",
"file": "远程文件",
"view": "预览"
}
}
修改于 2023-12-26 02:41:28