客服管理
添加客服
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/agents |
访问角色 |
dev、devAdmin |
请求方法 |
POST |
请求数据 |
|
请求响应 |
|
请求参数说明:
参数名 |
类型 |
必选 |
说明 |
|
String |
Y |
用户账号 |
password |
String |
Y |
用户密码 |
name |
Object |
N |
用户昵称 |
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
receipt |
Map |
Y |
map集合,返回操作结果 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
409 |
客服已存在 |
500 |
服务端内部错误 |
批量删除客服
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/agents |
访问角色 |
dev、devAdmin |
URL参数 |
email=email1,email2 |
请求方法 |
DELETE |
请求数据 |
|
请求响应 |
|
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
receipt |
Map |
Y |
map集合,返回操作结果 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
404 |
用户不存在 |
500 |
服务端内部错误 |
修改客服
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/agents/{email} |
访问角色 |
dev、devAdmin |
请求方法 |
PUT |
请求数据 |
|
请求响应 |
|
请求参数说明:
数名 |
类型 |
必选 |
说明 |
password |
String |
N |
用户密码 |
name |
String |
N |
用户昵称 |
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
receipt |
Map |
Y |
map集合,返回操作结果 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
404 |
用户不存在 |
500 |
服务端内部错误 |
获取客服
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/agents/{email} |
访问角色 |
dev、devAdmin |
请求方法 |
GET |
请求数据 |
|
请求响应 |
|
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
agent |
Object |
Y |
参考数据结构Agent |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
404 |
用户不存在 |
500 |
服务端内部错误 |
批量获取客服
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/agents |
访问角色 |
dev、devAdmin |
URL参数 |
limit=n,m |
请求方法 |
GET |
请求数据 |
|
请求响应 |
{ |
备注 |
通过limit=n,m请求参数进行分页获取,如果不加limit请求参数默认获取第一页数据 |
请求参数说明:
参数名 |
类型 |
必选 |
说明 |
n |
Integer |
Y |
获取的数据的开始下标 |
m |
Integer |
Y |
每一页的数据个数 |
name |
String |
N |
客服昵称、账号,支持模糊查询 |
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
agents |
Array |
Y |
客服集合,参考数据结构Agent |
startIndex |
Integer |
N |
开始下标,分页获取时将返回该字段 |
numResults |
Integer |
N |
分页数据的总数,分页获取时将返回该字段 |
totalResults |
Integer |
N |
总记录数 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
500 |
服务端内部错误 |
获取访客列表
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/{appName}/ |
访问角色 |
dev、devAdmin、im |
URL参数 |
limit=n,m |
请求方法 |
GET |
请求数据 |
|
请求响应 |
|
请求参数说明:
参数名 |
类型 |
必选 |
说明 |
limit |
Param |
N |
分页获取 |
workgroupName |
Param |
Y |
查找指定技能组下的会话 |
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
users |
Array |
Y |
访客集合,参考Visitor数据结构 |
startIndex |
Integer |
N |
开始下标,分页获取时将返回该字段 |
numResults |
Integer |
N |
分页数据的总数,分页获取时将返回该字段 |
totalResults |
Integer |
N |
总记录数 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
500 |
服务端内部错误 |
获取访客的会话
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/{appName}/ |
访问角色 |
dev、devAdmin、im |
URL参数 |
limit=n,m |
请求方法 |
GET |
请求数据 |
|
请求响应 |
|
请求参数说明:
参数名 |
类型 |
必选 |
说明 |
limit |
Param |
N |
分页获取 |
workgroupName |
Param |
Y |
查找指定技能组下的会话 |
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
sessions |
Array |
Y |
会话集合,参考数据结构Session |
startIndex |
Integer |
N |
开始下标,分页获取时将返回该字段 |
numResults |
Integer |
N |
分页数据的总数,分页获取时将返回该字段 |
totalResults |
Integer |
N |
总记录数 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
500 |
服务端内部错误 |
保存访客信息
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/{appName}/ |
访问角色 |
dev、devAdmin |
请求方法 |
POST |
请求数据 |
|
请求响应 |
|
请求参数说明:
参数名 |
类型 |
必选 |
说明 |
访客的各项信息 |
Object |
N |
访客信息,参考数据结果VisitorInfo |
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
500 |
服务端内部错误 |
获取访客信息
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/{appName}/ |
访问角色 |
dev、devAdmin |
请求方法 |
GET |
url参数 |
|
请求数据 |
|
请求响应 |
详情看下面请求响应数据 |
请求响应数据:
{
"code" : 200,
"message" : "get mcsu success",
“timestamp”: 1440126977249,
"visitor" : {
"serviceId" : "b3e5mhmznhbjmq",
"channelId" : "",
"channelType" : 3,
"userName" : "b3e5mhmznhbjmq#mcsu_883778738524836",
"nickName" : "nickname",
"sex" : 1,
"city" : "广州",
"province" : "广东省",
"country" : "中国",
"headImg" : "http://wx.qlogo.cn/mmopen/PaVYM2rkkeHGAbpqia3JfkTaHibGEWgEHo6dz4NBlJg0YH0daOhC3SIKDtPk7FUVjRjOlJxHpd9cvYWOkvlCBo6JUr5S2TjqNh/0",
"phone" : "15874093148",
"address" : "地址",
"qq" : "66859655",
"email" : "dd@qq.com",
"company" : "jiaxin",
"remark" : "不错",
"wcAppId" : "",
"createTime" : "2015-12-18 16:08:29",
"lastServiceTime" : "2015-12-18 16:08:29"
}
}
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
visitor |
Object |
N |
访客信息,参考数据结果VisitorInfo |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
500 |
服务端内部错误 |
技能组管理
添加技能组
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/{appName}/ |
访问角色 |
dev、devAdmin |
请求方法 |
POST |
请求数据 |
|
请求响应 |
|
请求参数说明:
参数名 |
类型 |
必选 |
说明 |
workgroupName |
String |
Y |
技能组唯一标示 |
displayName |
String |
Y |
技能组的名称,用于显示,displayName必须唯一 |
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
receipt |
Map |
Y |
Map集合,返回操作结果 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
500 |
服务端内部错误 |
批量删除技能组
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/{appName}/ |
访问角色 |
dev、devAdmin |
URL参数 |
workgroupName=workgoupName1,workgroupName2 |
请求方法 |
DELETE |
请求数据 |
|
请求响应 |
|
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
receipt |
Map |
Y |
Map集合,返回操作结果 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
404 |
技能组不存在 |
500 |
服务端内部错误 |
修改技能组
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/ |
访问角色 |
dev、devAdmin |
请求方法 |
PUT |
请求数据 |
|
请求响应 |
|
请求参数说明:
参数名 |
类型 |
必选 |
说明 |
displayName |
String |
N |
技能组的名称,用于显示,必须保证唯一 |
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
receipt |
Map |
Y |
Map集合,返回操作结果 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
404 |
技能组不存在 |
500 |
服务端内部错误 |
获取技能组详情
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/{appName}/ |
访问角色 |
dev、devAdmin |
请求方法 |
GET |
请求数据 |
|
请求响应 |
|
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
receipt |
Map |
Y |
workgroup集合,参考Workgroup数据结构 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
404 |
技能组不存在 |
500 |
服务端内部错误 |
批量获取/查询技能组(概要信息)
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/{appName}/ |
访问角色 |
dev、devAdmin、im |
URL参数 |
name=workgroupName |
请求方法 |
GET |
请求数据 |
|
请求响应 |
|
请求参数说明:
参数名 |
类型 |
必选 |
说明 |
workgroupName |
Param |
N |
|
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
workgroups |
Array |
Y |
技能组集合,参考Workgroup数据结构 |
startIndex |
Integer |
N |
开始下标,分页获取时将返回该字段 |
numResults |
Integer |
Y |
技能组的个数 |
totalResults |
Integer |
Y |
总记录数 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
500 |
服务端内部错误 |
添加客服
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/{appName}/ |
访问角色 |
dev、devAdmin |
请求方法 |
POST |
请求数据 |
|
请求响应 |
|
请求参数说明:
参数名 |
类型 |
必选 |
说明 |
usernames |
Array |
Y |
用户集合 |
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
receipt |
Map |
Y |
Map集合,返回操作结果 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
404 |
技能组不存在 |
500 |
服务端内部错误 |
批量删除客服
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/{appName}/ |
访问角色 |
dev、devAdmin |
URL参数 |
email=username1,username2 |
请求方法 |
DELETE |
请求响应 |
|
请求参数说明:
参数名 |
类型 |
必选 |
说明 |
username |
Param |
Y |
待删除的客服账号,用逗号分隔 |
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
receipt |
Map |
Y |
Map集合,返回操作结果 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
404 |
技能组不存在 |
500 |
服务端内部错误 |
获取技能组下的指定客服
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/{appName}/ |
访问角色 |
dev、devAdmin |
URL参数 |
name=agentName |
请求方法 |
GET |
请求数据 |
|
请求响应 |
|
备注 |
通过limit=n,m请求参数进行分页获取,如果不加limit请求参数默认获取第一页数据 |
请求参数说明:
参数名 |
类型 |
必选 |
说明 |
n |
Integer |
N |
获取的数据的开始下标 |
m |
Integer |
N |
每一页的数据个数 |
username |
String |
N |
用户的名称,可以查询该技能组下的某一个客服,可以是账号,也可以是昵称 |
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
agents |
Array |
Y |
客服集合,参考数据结构Agent |
startIndex |
Integer |
N |
开始下标,分页获取时将返回该字段 |
numResults |
Integer |
N |
分页数据的总数,分页获取时将返回该字段 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
404 |
技能组不存在 |
500 |
服务端内部错误 |
聊天记录管理
添加访客留言
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/{appName}/ |
访问角色 |
dev、devAdmin |
请求方法 |
POST |
请求数据 |
|
请求响应 |
|
请求参数说明:
参数名 |
类型 |
必选 |
说明 |
visitorId |
String |
Y |
访客Id,orgName#appName_xxxx中的xxxx部分 |
workgroupId |
String |
Y |
技能组Id, orgName#appName_xxxx中的xxxx部分 |
content |
String |
Y |
问题内容 |
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
500 |
服务端内部错误 |
设置管理
获取欢迎设置
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/ |
访问角色 |
dev、devAdmin |
请求方法 |
GET |
请求数据 |
|
请求响应 |
|
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
setting |
Object |
Y |
设置信息,参考Setting数据结构 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
404 |
设置信息不存在 |
500 |
服务端内部错误 |
更新欢迎设置
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/ |
访问角色 |
dev、devAdmin |
请求方法 |
PUT |
请求数据 |
|
请求响应 |
|
请求参数说明:
参数名 |
类型 |
必选 |
说明 |
onlineMessage |
String |
N |
上班欢迎语,参考Setting数据结构 |
… |
… |
… |
… |
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
setting |
Object |
Y |
设置信息,参考Setting数据结构 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
404 |
设置信息不存在 |
500 |
服务端内部错误 |
获取会话标签
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/ |
访问角色 |
dev、devAdmin |
请求方法 |
GET |
请求数据 |
|
请求响应 |
|
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
tags |
Object |
Y |
会话标签,参考SessionTag数据结构 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
404 |
设置信息不存在 |
500 |
服务端内部错误 |
添加会话标签
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/ |
访问角色 |
dev、devAdmin |
请求方法 |
POST |
请求数据 |
|
请求响应 |
|
请求参数说明:
参数名 |
类型 |
必选 |
说明 |
description |
String |
Y |
标签描述 |
parented |
Integer |
N |
标签的父标签Id,可选,如果不传该值表示该标签为第一级标签 |
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
receipt |
Map |
Y |
Map集合,返回结果,tagId为新增标签的id |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
404 |
设置信息不存在 |
500 |
服务端内部错误 |
更新会话标签
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/ |
访问角色 |
dev、devAdmin |
请求方法 |
PUT |
请求数据 |
|
请求响应 |
|
请求参数说明:
参数名 |
类型 |
必选 |
说明 |
description |
String |
Y |
标签描述 |
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
receipt |
Map |
Y |
Map集合,返回结果 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
404 |
设置信息不存在 |
500 |
服务端内部错误 |
删除会话标签
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/ |
访问角色 |
dev、devAdmin |
请求方法 |
DELETE |
请求数据 |
|
请求响应 |
|
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
receipt |
Map |
Y |
Map集合,返回结果 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
404 |
设置信息不存在 |
500 |
服务端内部错误 |
获取问答列表
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/{appName}/ |
访问角色 |
dev、devAdmin |
请求方法 |
POST |
请求数据 |
|
请求响应 |
|
请求参数说明:
参数名 |
类型 |
必选 |
说明 |
question |
String |
N |
问题描述 |
answer |
String |
N |
文本类答案内容 |
status |
Integer |
N |
|
groupId |
Integer |
N |
分类id |
leaf |
Integer |
N |
是否为叶子节点 |
queryType |
Integer |
N |
查询类型 1按照问题查找 2 按照答案查找 |
orderType |
Integer |
N |
|
pageSize |
Integer |
N |
分页返回,每页的数量 |
pageNo |
Integer |
N |
分页返回,第几页 |
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
total |
Integer |
N |
返回数据总条数 |
currentPage |
Integer |
N |
当前页面 |
totlePages |
Integer |
N |
总页面 |
list |
Array |
N |
Question对象的列表, 参考数据结构Question |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
500 |
服务端内部错误 |
获取问题分类
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/{appName}/ |
访问角色 |
dev、devAdmin |
请求方法 |
GET |
请求数据 |
|
请求响应 |
|
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
list |
Array |
Y |
问题分类列表,参考数据结构QuestionType |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
500 |
服务端内部错误 |
获取开发者配置
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/ |
访问角色 |
dev、devAdmin |
请求方法 |
GET |
请求数据 |
|
请求响应 |
|
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
developerConfig |
Object |
Y |
开发者配置,参考DeveloperConfig数据结构 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
500 |
服务端内部错误 |
获取快捷问题列表
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/{appName} / |
访问角色 |
dev、devAdmin |
URL参数 |
|
请求方法 |
GET |
请求数据 |
|
请求响应 |
|
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
questionList |
Object |
Y |
会话标签,参考QuickQuestion数据结构 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
500 |
服务端内部错误 |
企业管理
查询企业信息
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/organizations |
访问角色 |
dev、devAdmin |
请求方法 |
GET |
请求数据 |
|
请求响应 |
|
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
timestamp |
Long |
Y |
时间戳 |
orgName |
String |
Y |
企业名称 |
org |
Object |
Y |
|
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
客服数据结构
Agent
参数名 |
类型 |
说明 |
|
String |
用户账号 |
username |
String |
用户JID |
password |
String |
用户密码 |
name |
String |
用户昵称 |
status |
String |
|
creationDate |
Long |
创建时间 |
phone |
String |
用户手机号码 |
Workgroup
参数名 |
类型 |
说明 |
workgroupName |
String |
技能组唯一标示 |
displayName |
String |
技能组显示的名称 |
agents |
Arrayl |
客服列表,参考Agent数据结构 |
Session
参数名 |
类型 |
说明 |
sessionId |
String |
会话ID |
visitor |
String |
访客的账号 |
messageCount |
Integer |
消息数 |
agent |
String |
客服的账号 |
agentName |
Long |
客服的昵称 |
creationDate |
Long |
创建时间 |
endDate |
String |
结束时间 |
workgroupName |
String |
技能组的唯一标识 |
workgroupDisplayName |
String |
技能组的名称 |
tagId |
Integer |
会话标签的id |
tagDescription |
String |
会话描述 |
ip |
String |
ip地址 |
ipLocator |
String |
ip地址归属 |
sequence |
String |
会话序号 |
resource |
String |
会话来源 |
remarks |
String |
会话备注 |
satisfyOptionId |
Integer |
满意度 |
Setting
参数名 |
类型 |
说明 |
onlineMessage |
String |
上班时间欢迎语 |
onlineMessageEnabled |
Boolean |
是否启用上班时间欢迎语 |
offlineMessage |
String |
下班时间欢迎语 |
offlineMessageEnabled |
Boolean |
是否启用下班时间欢迎语 |
onlineTime |
String |
上班时间,格式为HH:mm |
offlineTime |
String |
下班时间,格式为HH:mm |
weekday |
String |
工作日,格式1,,2,3。星期一至星期日用1-7表示,中间用逗号分隔 |
sessionEndMessage |
String |
会话结束的提示信息 |
sessionEndMessageEnabled |
Boolean |
是否启用会话结束欢迎语 |
SessionTag
参数名 |
类型 |
说明 |
tagId |
Integer |
标签Id |
parenteId |
Integer |
父标签Id,如果为null则为第一级标签 |
description |
String |
标签描述 |
childTags |
Array |
标签集合,参考SessionTag |
Visitor
参数名 |
类型 |
说明 |
visitor |
String |
访客id |
agent |
String |
客服id |
agentName |
String |
客服昵称 |
workgroupName |
String |
技能组id |
workgroupDisplayName |
String |
技能组名称 |
serviceCount |
Integer |
服务次数 |
ip |
String |
ip地址 |
ipLocator |
String |
ip地址归属 |
sequence |
String |
编号 |
resource |
String |
来源 |
Satisfy
参数名 |
类型 |
说明 |
enterpriseId |
String |
企业id |
optionId |
Integer |
满意度标识 |
optionText |
String |
满意度说明 |
optionFlag |
Integer |
是否可用,1可用,0不可用 |
QuestionType
参数名 |
类型 |
说明 |
Id |
Integer |
问题类型标识 |
Name |
String |
问题类型名称 |
ParentId |
Integer |
问题类型父标识 |
Question
名称 |
类型 |
说明 |
id |
Integer |
id代号 |
requestionRegex |
String |
正则格式规定 |
question |
String |
问题描述 |
pointWords |
String |
意义重点词 |
webId |
Integer |
站点的id代号 |
level |
Integer |
问题级别 0:标准问题 1:相似问法 |
brifQuestion |
String |
精简问题 |
keyWord |
String |
问题的关键词 |
sId |
String |
答案代号 |
addedStyle |
Integer |
0手动1机器之不会2机器之猜测3回答问题时添加 |
del |
Integer |
0:不删除 1:删除 |
time |
String |
添加时间 |
groupId |
Integer |
所属分组 |
hits |
Integer |
点击次数 |
addUserId |
Integer |
问题的添加者的Id代号 |
answerStatus |
Integer |
0:表示正常,已发布;-1:暂存;-2:待审核;-3:返回修改;-4:已过期;-5:等待发布 |
del |
Integer |
删除 |
context |
String |
上下文 |
useFull |
Integer |
有帮助 |
useLess |
Integer |
无帮助 |
mode |
Integer |
答案类型 |
modeValue |
Integer |
不同模式的id代号 |
answer |
String |
文本和富文本的答案内容 |
url |
String |
iframe的答案url |
path |
String |
素材答案的path |
info |
String |
流程的info |
similarNum |
Integer |
相似问法的个数 |
DeveloperConfig
名称 |
类型 |
说明 |
enterpriseId |
String |
企业标识 |
timeoutNotifyFlag |
Integer |
是否开启超时提醒统计,1开启,0关闭 |
timeoutInterval |
Integer |
会话超时时间,单位秒 |
maxRoomUsersNum |
Integer |
群成员的最大数量 |
agentAccessType |
Integer |
接待方式设置,0:人工客服优先; 1:机器人客服优先(默认) |
satisfyNotifyFlag |
Integer |
是否开启满意度调查通知, 1开启,0关闭 |
robotFlag |
Integer |
是否允许使用机器人,1开启,0关闭 |
currentFund |
Integer |
当前资金,通过充值、扣费改变该值 |
payMode |
Integer |
支付模式,B 预付费;A 后付费 |
satisfyInvitation |
String |
满意度调查标题 |
VisitorInfo
参数名 |
类型 |
说明 |
serviceId |
String |
企业标识 |
channelId |
String |
渠道标识 |
channelType |
Integer |
渠道类型1: APP 渠道2: 微信渠道3: WEB渠道 |
userName |
String |
访客名称 |
nickName |
String |
访客昵称 |
sex |
Integer |
性别 1男,2女 |
city |
String |
访客所在城市 |
province |
String |
访客所在省份 |
country |
String |
访客所在国家 |
headImg |
String |
头像 |
phone |
String |
电话 |
address |
String |
地址 |
|
String |
QQ号码 |
|
String |
邮箱 |
company |
String |
公司 |
remark |
String |
备注说明 |
wcAppId |
String |
公众号app_id |
createTime |
String |
创建时间 |
lastServiceTime |
String |
最后一次接受服务的时间 |
SessionTimeout
参数名 |
类型 |
说明 |
enterpriseId |
String |
企业标识 |
sessionId |
String |
session标识 |
agentId |
String |
坐席的全称是 orgName#mcs_xxxxx,这里只要xxxxx部分 |
duration |
Integer |
超时时间,单位秒 |
QuickQuestion
参数名 |
类型 |
说明 |
id |
String |
主键 |
enterpriseId |
String |
企业标识 |
appName |
String |
应用标识 |
question |
String |
快捷问题 |
createTime |
String |
创建时间 |
appUse |
String |
APP是否启用:1开启;0不开启 |
desktopUse |
String |
桌面网站是否启用:1开启;0不开启 |
mobileUse |
String |
移动网站启用是否启用:1开启;0不开启 |
客服返回码
RESTful接口存在以下返回码:
返回码 |
说明 |
200 |
请求正确执行 |
400 |
请求参数非法 |
401 |
存在冲突的资源 |
403 |
没有权限访问资源 |
404 |
访问的资源不存在 |
500 |
服务器内部错误 |
工单管理
创建工单
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/{appName}/ |
访问角色 |
dev、devAdmin |
请求方法 |
POST |
请求数据 |
|
请求响应 |
|
请求参数说明:
参数名 |
类型 |
必选 |
说明 |
customerName |
String |
N |
客户名称 |
|
String |
N |
客户邮箱 |
telephoneNum |
Integer |
N |
客户电话 |
acceptWkgroupJID |
Integer |
N |
受理技能组id |
acceptAgentJID |
Integer |
N |
受理客服id |
subject |
Integer |
Y |
工单主题 |
description |
String |
Y |
工单内容 |
priority |
Integer |
N |
|
source |
Integer |
N |
|
extendFields |
Map |
N |
自定义字段 |
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
orgName |
String |
Y |
企业标识 |
timestamp |
String |
Y |
时间戳 |
orderNo |
Integer |
Y |
工单号 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法,出错原因返回结果里有说明 |
更新工单
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/{appName}/ |
访问角色 |
dev、devAdmin |
请求方法 |
PUT |
请求数据 |
|
请求响应 |
|
请求参数说明:
参数名 |
类型 |
必选 |
说明 |
orderNo |
String |
N |
客户名称 |
acceptWkgroupJID |
String |
N |
客户邮箱 |
acceptAgentJID |
Integer |
N |
客户电话 |
subject |
Integer |
N |
受理技能组id |
description |
Integer |
N |
受理客服id |
priority |
Integer |
Y |
工单主题 |
status |
String |
Y |
工单内容 |
extendFields |
Integer |
N |
|
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
orgName |
String |
Y |
企业标识 |
timestamp |
String |
Y |
时间戳 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法,出错原因返回结果里有说明 |
获取工单列表
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/{appName}/ |
访问角色 |
dev、devAdmin |
URL参数 |
limit=n,m |
请求方法 |
GET |
请求数据 |
|
请求响应 |
|
请求参数说明:
参数名 |
类型 |
必选 |
说明 |
limit |
Param |
N |
分页获取 |
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
orgName |
String |
Y |
企业标识 |
timestamp |
Long |
Y |
时间戳 |
orderList |
Array |
Y |
工单列表集合,参考数据结构Order |
startIndex |
Integer |
N |
开始下标,分页获取时将返回该字段 |
numResults |
Integer |
N |
分页数据的总数,分页获取时将返回该字段 |
totalResults |
Integer |
N |
总记录数 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
500 |
服务端内部错误 |
获取工单详情
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/{appName}/ |
访问角色 |
dev、devAdmin |
请求方法 |
GET |
请求数据 |
|
请求响应 |
|
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
orgName |
String |
Y |
企业标识 |
timestamp |
Long |
Y |
时间戳 |
Order |
Object |
Y |
参考Order数据结构 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
404 |
聊天室不存在 |
500 |
服务端内部错误 |
删除工单
接口定义:
请求URI |
https://api.jiaxincloud.com/rest/{orgName}/{appName}/ |
访问角色 |
dev、devAdmin |
请求方法 |
GET |
请求数据 |
|
请求响应 |
|
响应参数说明:
参数名 |
类型 |
必选 |
说明 |
code |
String |
Y |
响应状态码,参考返回码定义 |
message |
String |
Y |
响应消息,简单的文字说明 |
orgName |
String |
Y |
企业标识 |
timestamp |
Long |
Y |
时间戳 |
可能出现的返回码:
返回码 |
说明 |
200 |
成功 |
400 |
请求参数非法 |
404 |
聊天室不存在 |
500 |
服务端内部错误 |
窗体顶端
工单数据结构
窗体顶端
窗体底端
Order
参数名 |
类型 |
必选 |
说明 |
orderNo |
Integer |
Y |
工单号 |
enterpriseID |
String |
Y |
企业标识 |
acceptWkgroupJID |
String |
N |
受理技能组id |
acceptAgentJID |
String |
N |
受理客服id |
subject |
String |
N |
工单主题 |
description |
String |
N |
工单内容 |
priority |
Integer |
N |
|
status |
Integer |
N |
|
customerJID |
String |
N |
客户id |
dispatchStrategy |
Integer |
N |
|
hasAttach |
Integer |
N |
是否有附件 0无 1 有 |
createTime |
String |
N |
创建时间 |
updateTime |
String |
N |
修改时间 |
customerJID |
String |
N |
客户id |
佳信客服SDK登录服务器流程
步骤说明:
1、 佳信客服SDK向RESTful服务发出获取Token的请求
2、 RESTful校验请求是否合法
3、 RESTful返回该用户的Token值
4、 佳信客服SDK使用该Token值向佳信即时通信服务器发起登录请求
5、 佳信客服即时通信服务器校验该Token是否有效
6、 佳信客服即时通信服务器返回登录结果