佳信客服接口文档 REST API（第三部分）

请求URI

https://api.jiaxincloud.com/rest/{orgName}/agents

访问角色

dev、devAdmin

请求方法

POST

请求数据

添加单个用户： 

{ 

“email”:”email”, 

“name”:”nickname1” 

“password”:”password1” 
}

请求响应

{ 

“code”:200, 

“message”:”create agent success”, 

“timestamp”:1440126977249, 

“orgName”:”pci”, 

“receipt”:{ 

“email1”: true 

} 
}

参数名

类型

必选

说明

email

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”:200, 

“message”:”deleteagent success”, 

“timestamp”:1440126977249, 

“orgName”:”pci”, 

“receipt”: 

{“email1”: true}, 

{“email2”:true} 

}

参数名

类型

必选

说明

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”:”password1”, 

“name”:”newNickname” 

} 

请求响应

{ 

“code”:200, 

“message”:”updateagent success”, 

“timestamp”: 1440126977249, 

“orgName”:”pci”, 

“receipt”: 

{“email”:true} 



} 

数名

类型

必选

说明

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”:200, 

“message”:”getagent success”, 

“timestamp”: 1440126977249, 

“orgName”:”pci”, 

“agent”: 

{“email”:“java”, 

“name”:“group”, 

“status”:”online” 

“creationDate”:1440126977249 

} 

}

参数名

类型

必选

说明

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 
name=name

请求方法

GET

请求数据

请求响应

{ 

“code”:200, 

“message”:”getagents success”, 

“timestamp”: 1440126977249, 

“orgName”:”pci”, 

“agents”:[ 

{“email”:“java”, 

“status”:”online” 

“name”:“group”, 

“creationDate”:1440126977249 

}, 

{“email”:“java2”, 

“status”:”offline” 

“name”:“group”, 

“creationDate”:1440126977249} 

], 

“startIndex”:0, 

“numResults”:2, 

“totalResults”:2 

}

备注

通过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}/ 
workgroups/{workgroupName}/agents/{email}/visitors

访问角色

dev、devAdmin、im

URL参数

limit=n,m

请求方法

GET

请求数据

请求响应

{ 

“code”:200, 

“message”:”get mcsu list success”, 

“timestamp”: 1440126977249, 

“orgName”:”pci”, 

“users”:[ 

{ 

“visitor”:”jiaxin#mcsu_r6912722952391@jiaxincloud.com”, 

“agent”:” 472caf585bfbb86c55686e284b9d3a15”, 

“agentName”:”Admin”, 

“creationDate”:1441009334122, 

“workgroupName”:”workgroup6”, 

“workgroupDisplayName”:”dis”, 

“serviceCount”:17, 

“ip”:”172.16.70.121”, 

“ipLocator”:”Unknown” 

} 

], 

“startIndex”:0 

“numResults”:1, 

“totalResults”:1 
}

参数名

类型

必选

说明

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}/ 
workgroups/{workgroupName}/agents/{email}/visitors/{visitor}/sessions

访问角色

dev、devAdmin、im

URL参数

limit=n,m

请求方法

GET

请求数据

请求响应

{ 

“code”:200, 

“message”:”get mcsu sessions success”, 

“timestamp”: 1440126977249, 

“orgName”:”pci”, 

“sessions”:[ 

{ 

“sessionId”:”28tnbk21”, 

“visitor”:”VHg82oEcq2”, 

“messageCount”:10, 

“agent”:”110”, 

“agentName”:”Admin”, 

“creationDate”:1441009334122, 

“workgroupName”:”workgroup6”, 

“workgroupDisplayName”:”dis”, 

“ip”:”172.16.70.121”, 

“ipLocator”:”Unknown”, 

“sequence”:”502”, 

“source”:”Chrome” 

} 

], 

“startIndex”:0 

“numResults”:1, 

“totalResults”:2 
}

参数名

类型

必选

说明

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}/ 
users/mcs

访问角色

dev、devAdmin

请求方法

POST

请求数据

{ 

“serviceId”:“emn5zmqyd2gzdg”, 

“userName”:“dd”, 

“channelType”:1, 

“sex”:1 
}

请求响应

{ 

“code” : 200, 

“message” : “save mcsu success”, 

“timestamp”: 1440126977249 

} 

参数名

类型

必选

说明

访客的各项信息

Object

N

访客信息，参考数据结果VisitorInfo

参数名

类型

必选

说明

code

String

Y

响应状态码，参考返回码定义

message

String

Y

响应消息，简单的文字说明

timestamp

Long

Y

时间戳

返回码

说明

200

成功

400

请求参数非法

500

服务端内部错误

请求URI

https://api.jiaxincloud.com/rest/{orgName}/{appName}/ 
users/{username}/mcs

访问角色

dev、devAdmin

请求方法

GET

url参数

urI中的username是访客名称，全称orgName#appName_xxxxx, 

这里只需要传xxxx部分 

请求数据

请求响应

详情看下面请求响应数据

参数名

类型

必选

说明

code

String

Y

响应状态码，参考返回码定义

message

String

Y

响应消息，简单的文字说明

timestamp

Long

Y

时间戳

visitor

Object

N

访客信息，参考数据结果VisitorInfo

返回码

说明

200

成功

400

请求参数非法

500

服务端内部错误

请求URI

https://api.jiaxincloud.com/rest/{orgName}/{appName}/ 
workgroups

访问角色

dev、devAdmin

请求方法

POST

请求数据

{ 

“workgroupName”:”10086” 

“displayName”:”new workgroup” 
}

请求响应

{ 

“code”:200, 

“message”:”add workgroup success”, 

“timestamp”: 1440126977249, 

“orgName”:”pci”, 

“appName”:”demo” 

“recepit”:{ 

“10086”:true 

} 
}

参数名

类型

必选

说明

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}/ 
workgroups

访问角色

dev、devAdmin

URL参数

workgroupName=workgoupName1,workgroupName2

请求方法

DELETE

请求数据

请求响应

{ 

“code”:200, 

“message”:”delete workgroup success”, 

“timestamp”: 1440126977249, 

“orgName”:”pci”, 

“receipt”:{ 

“workgroupName”: true 

} 

} 

参数名

类型

必选

说明

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}/ 
workgroups/{workgroupName}

访问角色

dev、devAdmin

请求方法

PUT

请求数据

{ 

“displayName”:”new workgroup” 

}

请求响应

{ 

“code”:200, 

“message”:”update workgroupsuccess”, 

“timestamp”: 1440126977249, 

“orgName”:”pci”, 

“receipt”:{ 

“workgroupName”:true 

} 

}

参数名

类型

必选

说明

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}/ 
workgroups/{workgroupName}

访问角色

dev、devAdmin

请求方法

GET

请求数据

请求响应

{ 

“code”:200, 

“message”:”get workgroupsuccess”, 

“timestamp”: 1440126977249, 

“orgName”:”pci”, 

“workgroup”:{ 

“workgroupName”:”workgroup1”, 

“displayName”:”new workgroup”, 

“agents”:[{ 

“username”:”user1”, 

“name”:”agent1” 

“available”:true 

},{ 

“username”:”user2” 

“name”:”agent2”, 

“available”:false 

}] 

} 

}

参数名

类型

必选

说明

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}/ 
workgroups

访问角色

dev、devAdmin、im

URL参数

name=workgroupName 
limit=n,m

请求方法

GET

请求数据

请求响应

{ 

“code”:200, 

“message”:”get workgroupssuccess”, 

“timestamp”: 1440126977249, 

“orgName”:”pci”, 

“workgroups”:[{ 

“workgroupName”:”workgroup1”, 

“displayName”:”new workgroup” 

}, { 

“workgroupName”:”workgroup2”, 

“displayName”,”new workgroup3” 

}], 

“startIndex”:0, 

“numResults”:2, 

“totalResults”:2 
}

参数名

类型

必选

说明

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}/ 
workgroups/{workgroupName}/agents

访问角色

dev、devAdmin

请求方法

POST

请求数据

[ 

{“email”:”username1”}, 

{“email”:”username2”} 
]

请求响应

{ 

“code”:200, 

“message”:”add agents success”, 

“timestamp”: 1440126977249, 

“orgName”:”pci”, 

“receipt”:{ 

“username1”:true, 

“username2”:false 

} 
}

参数名

类型

必选

说明

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}/ 
workgroups/{workgroupName}/agents

访问角色

dev、devAdmin

URL参数

email=username1,username2

请求方法

DELETE

请求响应

{ 

“code”:200, 

“message”:”delete agents success”, 

“timestamp”: 1440126977249, 

“orgName”:”pci”, 

“receipt”:{ 

“username1”:true, 

“username2”:false 

} 

} 

参数名

类型

必选

说明

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}/ 
workgroups/{workgroupName}/agents

访问角色

dev、devAdmin

URL参数

name=agentName 
limit=n,m

请求方法

GET

请求数据

请求响应

{ 

“code”: 200, 

“message”: “get workgroup success”, 

“timestamp”: 1441963402265, 

“orgName”: “xws”, 

“workgroup”: { 

“workgroupName”: “test”, 

“displayName”: “测试”, 

“agents”: [ 

{ 

“email”: “xws_mcs_asd”, 

“name”: “xws_mcs_asd”, 

“status”: “online” 

}, 

{ 

“email”: “xws_mcs_test”, 

“name”: “xws_mcs_test”, 

“status”: “dnd” 

} 

] 

} 
}

备注

通过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}/ 
leavewords

访问角色

dev、devAdmin

请求方法

POST

请求数据

{ 

“visitorId”:“visitorId”, 

“workgroupId”:“workgroupId”, 

“content”:“May I ask a question?” 
}

请求响应

{ 

“code” : 200, 

“message” : “save leaveword success ”, 

“timestamp” : 1450428743616, 

“orgName”:”b3e5mhmznhbjmq” 

}

参数名

类型

必选

说明

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}/ 
settings /welcome

访问角色

dev、devAdmin

请求方法

GET

请求数据

请求响应

{ 

“code”: 200, 

“message”: “get setting success”, 

“timestamp”: 1441701072824, 

“orgName”: “orgname”, 

“setting”: { 

“onlineMessage”: “上班”, 

“onlineMessageEnabled”: false, 

“offlineMessage”: “下班了，明天再来”, 

“offlineMessageEnabled”: true, 

“onlineTime”: “05:20”, 

“offlineTime”: “17:50”, 

“weekday”: “1,2,3,4,5”, 

“sessionEndMessage”: “会话以结束”, 

“sessionEndMessageEnabled”: true 

} 

} 

参数名

类型

必选

说明

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}/ 
settings /welcome

访问角色

dev、devAdmin

请求方法

PUT

请求数据

{ 

“onlineMessage”: “欢迎”, 

“onlineMessageEnabled”: true, 

“offlineMessage”: “下班了，明天再来”, 

“onlineTime”: “05:20”, 

“offlineTime”: “17:50”, 

“weekday”: “1,2,3,4,5”, 

“sessionEndMessage”: “会话以结束” 

} 

请求响应

{ 





“code”: 200, 

“message”: “update setting success”, 

“timestamp”: 1441691804186, 

“orgName”: “orgname”, 

} 

参数名

类型

必选

说明

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}/ 
settings /tags

访问角色

dev、devAdmin

请求方法

GET

请求数据

请求响应

{ 

“code”: 200, 

“message”: “get session tags success”, 

“timestamp”: 1441681787881, 

“orgName”: “orgname”, 

“tags”: [ 

{ 

“tagId”: 1, 

“description”: “咨询”, 

“childTags”: [ 

{ 

“tagId”: 4, 

“parentId”: 1, 

“description”: “功能咨询” 

}, 

{ 

“tagId”: 5, 

“parentId”: 1, 

“description”: “收费咨询” 

}, 

{ 

“tagId”: 6, 

“parentId”: 1, 

“description”: “状态咨询” 

} 

] 

}, 

{ 

“tagId”: 2, 

“description”: “报故障”, 

“childTags”: [ 

{ 

“tagId”: 7, 

“parentId”: 2, 

“description”: “界面故障” 

}, 

{ 

“tagId”: 8, 

“parentId”: 2, 

“description”: “改进建议” 

} 

] 

}, 

{ 

“tagId”: 3, 

“description”: “投诉”, 

“childTags”: [ 

{ 

“tagId”: 9, 

“parentId”: 3, 

“description”: “产品质量投诉” 

}, 

{ 

“tagId”: 10, 

“parentId”: 3, 

“description”: “服务态度投诉” 

} 

] 

} 

] 

} 

参数名

类型

必选

说明

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}/ 
settings /tags

访问角色

dev、devAdmin

请求方法

POST

请求数据

{ 

“description”: “咨询”, 

“parentId”: “12”, 

} 

请求响应

{ 

“code”: 200, 

“message”: “update setting success”, 

“timestamp”: 1441691804186, 

“orgName”: “orgname”, 

“receipt”: {“tagId”,13} 

} 

参数名

类型

必选

说明

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}/ 
settings /tags/{tagId}

访问角色

dev、devAdmin

请求方法

PUT

请求数据

{ 

“description”: “咨询0”, 

} 

请求响应

{ 

“code”: 200, 

“message”: “update setting success”, 

“timestamp”: 1441691804186, 

“orgName”: “orgname”, 

“receipt”: {“13”,true} 

} 

参数名

类型

必选

说明

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}/ 
settings /tags/{tagId}

访问角色

dev、devAdmin

请求方法

DELETE

请求数据

请求响应

{ 

“code”: 200, 

“message”: “update setting success”, 

“timestamp”: 1441691804186, 

“orgName”: “orgname”, 

“receipt”: {“13”,true} 

} 

参数名

类型

必选

说明

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}/ 
robot /questions/list

访问角色

dev、devAdmin

请求方法

POST

请求数据

{ 

“orgName”:“jiaxin”, 

“orderType”:6, 

“question”:“产品的价格”, 

“queryType”:1, 

“pageSize”:10, 

“pageNo”:1 

} 

请求响应

{ 

“code”:200, 

“currentPage”:1, 

“message”:“get question list success”, 

“questionList”: 

[{“Answer”:“在这里您可以填写您的产品价格”, 

“AnswerStatus”:0, 

“GroupName”:“产品概览”, 

“Hits”:0, 

“Id”:226391, 

“Mode”:0, 

“Name”:“管理员”, 

“Question”:“产品的价格”, 

“SolutionId”:226391, 

“Time”:“2015-12-18 14:31:31”, 

“UseFull”:0, 

“UseLess”:0, 

“aId”:142693 

}], 

“total”:1, 

“totlePages”:1 

} 

参数名

类型

必选

说明

question

String

N

问题描述

answer

String

N

文本类答案内容

status

Integer

N

状态信息 0: 表示正常，已发布； -1：暂存； 

-2：待审核； -3：返回修改；-4：已过期；-5：等待发布； 

groupId

Integer

N

分类id

leaf

Integer

N

是否为叶子节点

queryType

Integer

N

查询类型 1按照问题查找 2 按照答案查找

orderType

Integer

N

排序方式 1.id asc 2.id desc 3.time asc 4.time desc 

5.hits asc 6.hits desc 7.group asc 8.group desc 

9.level asc 10.level desc 11.status asc 12.status desc 

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}/ 
robot /questions/type

访问角色

dev、devAdmin

请求方法

GET

请求数据

请求响应

{ 

“code”:200, 

“list”:[{ 

“Id”:47503, 

“Name”:“系统保留”, 

“ParentId”:47500 

},{ 

“Id”:47502, 

“Name”:“企业概览”, 

“ParentId”:47500 

},{ 

“Id”:47501, 

“Name”:“产品概览”, 

“ParentId”:47500 

},{ 

“Id”:47500, 

“Name”:“基础类”, 

“ParentId”:0 

}], 

“message”:“get question type success” 

} 

参数名

类型

必选

说明

code

String

Y

响应状态码，参考返回码定义

message

String

Y

响应消息，简单的文字说明

list

Array

Y

问题分类列表，参考数据结构QuestionType

返回码

说明

200

成功

400

请求参数非法

500

服务端内部错误

请求URI

https://api.jiaxincloud.com/rest/{orgName}/ 
developer/config

访问角色

dev、devAdmin

请求方法

GET

请求数据

请求响应

{ 

“code” : 200, 

“message” : “get developer configure success”, 

“timestamp” : 1450515496146, 

“orgName” : “b3e5mhmznhbjmq”, 

“developerConfig” : { 

“enterpriseId” : “b3e5mhmznhbjmq”, 

“timeoutNotifyFlag” : 1, 

“timeoutInterval” : 30, 

“maxRoomNum” : 50, 

“maxRoomUsersNum” : 100, 

“agentAccessType” : 0, 

“satisfyNotifyFlag” : 1, 

“robotFlag” : 1, 

“currentFund” : 0, 

“payMode” : 0, 

“satisfyInvitation” : “尊敬的用户，很荣幸为您服务， 

诚邀您对本次服务作出评价，我们将持续改善服务质量。” 

} 

} 

参数名

类型

必选

说明

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} / 
quickquestion/{userType}

访问角色

dev、devAdmin

URL参数

userType 参数说明：手机端应用： 

APP,桌面网页：DESKTOP,手机端网页MOBILE

请求方法

GET

请求数据

请求响应

{ 

“code” : 200, 

“message” : “get quick question success”, 

“timestamp” : 1453433508293, 

“orgName” : “z3uxawhtmnlloa”, 

“questionList” : [ { 

“id” : “ FAD6600CF26E00314433”, 

“enterpriseId” : “z3uxawhtmnlloa”, 

“appName” : “bingmcs”, 

“question” : “你们的价格是多少”, 

“createTime” : “2016-01-21 18:50:12”, 

“appUse” : “1”, 

“desktopUse” : “0”, 

“mobileUse” : “0” 

}, { 

“id” : “FAD6600CF26E00314444”, 

“enterpriseId” : “z3uxawhtmnlloa”, 

“appName” : “bingmcs”, 

“question” : “价格是多少”, 

“createTime” : “2016-01-21 18:58:18”, 

“appUse” : “1”, 

“desktopUse” : “1”, 

“mobileUse” : “1” 

} ] 

}

参数名

类型

必选

说明

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”:200, 

“message”:”get org info success”, 

“timestamp”:1440126977249, 

“orgName”:”pci”, 

“org”:{ 

“username”:”845623236@sina.com”, 

“orgName”:“pci”, 

“orgDescription”:”pciName” 

} 
}

参数名

类型

必选

说明

code

String

Y

响应状态码，参考返回码定义

message

String

Y

响应消息，简单的文字说明

timestamp

Long

Y

时间戳

orgName

String

Y

企业名称

org

Object

Y

企业信息，orgName为企业id，orgDescription为企业描述， 

username为开发者邮箱

返回码

说明

200

成功

400

请求参数非法

参数名

类型

说明

email

String

用户账号

username

String

用户JID

password

String

用户密码

name

String

用户昵称

status

String

online:在线 

offline:离线 
dnd:隐身

creationDate

Long

创建时间

phone

String

用户手机号码

参数名

类型

说明

workgroupName

String

技能组唯一标示

displayName

String

技能组显示的名称

agents

Arrayl

客服列表，参考Agent数据结构

参数名

类型

说明

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

满意度

参数名

类型

说明

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

是否启用会话结束欢迎语

参数名

类型

说明

tagId

Integer

标签Id

parenteId

Integer

父标签Id，如果为null则为第一级标签

description

String

标签描述

childTags

Array

标签集合，参考SessionTag

参数名

类型

说明

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

来源

参数名

类型

说明

enterpriseId

String

企业id

optionId

Integer

满意度标识

optionText

String

满意度说明

optionFlag

Integer

是否可用，1可用，0不可用

参数名

类型

说明

Id

Integer

问题类型标识

Name

String

问题类型名称

ParentId

Integer

问题类型父标识

名称

类型

说明

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

相似问法的个数

名称

类型

说明

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

满意度调查标题

参数名

类型

说明

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

地址

qq

String

QQ号码

email

String

邮箱

company

String

公司

remark

String

备注说明

wcAppId

String

公众号app_id

createTime

String

创建时间

lastServiceTime

String

最后一次接受服务的时间

参数名

类型

说明

enterpriseId

String

企业标识

sessionId

String

session标识

agentId

String

坐席的全称是 orgName#mcs_xxxxx，这里只要xxxxx部分

duration

Integer

超时时间，单位秒

参数名

类型

说明

id

String

主键

enterpriseId

String

企业标识

appName

String

应用标识

question

String

快捷问题

createTime

String

创建时间

appUse

String

APP是否启用：1开启;0不开启

desktopUse

String

桌面网站是否启用：1开启;0不开启

mobileUse

String

移动网站启用是否启用：1开启;0不开启

返回码

说明

200

请求正确执行

400

请求参数非法

401

存在冲突的资源

403

没有权限访问资源

404

访问的资源不存在

500

服务器内部错误

请求URI

https://api.jiaxincloud.com/rest/{orgName}/{appName}/ 
order

访问角色

dev、devAdmin

请求方法

POST

请求数据

{“customerName”:“name” ,“subject”:“subject”, 

“description”:“content”,“priority”:1,“source”:-1, 

“extendFields”:{“EXTEND2”:“华为”,“EXTEND3”:“男”}} 

请求响应

{ 

“code” : 200, 

“message” : “create order success”, 

“timestamp” : 1464318878826, 

“orgName” : “mnuwmxhzzmxxna”, 

“receipt” : { 

“orderNo” : 63946 

} 
}

参数名

类型

必选

说明

customerName

String

N

客户名称

email

String

N

客户邮箱

telephoneNum

Integer

N

客户电话

acceptWkgroupJID

Integer

N

受理技能组id

acceptAgentJID

Integer

N

受理客服id

subject

Integer

Y

工单主题

description

String

Y

工单内容

priority

Integer

N

工单优先级 

0:低 

1:中 
2:高

source

Integer

N

工单来源 

-1：其他渠道 

0：手工录入 

1: APP 

2: 网站 

3: 微信 

4: 微博 
5: QQ

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}/ 
order

访问角色

dev、devAdmin

请求方法

PUT

请求数据

{“orderNo”:98907,“customerName”:“name”,“dispatchStrategy”:1, 

“subject”:“112”,“description”:“content”,“priority”:1,“source”:-1, 

“extendFields”:{“EXTEND3”:“男”}} 

请求响应

{ 

“code” : 200, 

“message” : “create order success”, 

“timestamp” : 1464318878826, 

“orgName” : “mnuwmxhzzmxxna”, 

“receipt” : { 

“orderNo” : 63946 

} 
}

参数名

类型

必选

说明

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

工单优先级 

0:低 

1:中 
2:高

参数名

类型

必选

说明

code

String

Y

响应状态码，参考返回码定义

message

String

Y

响应消息，简单的文字说明

orgName

String

Y

企业标识

timestamp

String

Y

时间戳

返回码

说明

200

成功

400

请求参数非法,出错原因返回结果里有说明

请求URI

https://api.jiaxincloud.com/rest/{orgName}/{appName}/ 
order/list

访问角色

dev、devAdmin

URL参数

limit=n,m

请求方法

GET

请求数据

请求响应

{ 

“code” : 200, 

“message” : “get order list success”, 

“ orgName ” : “mnuwmxhzzmxxna”, 

“totalResults” : 98909, 

“orderList” : [ { 

“orderNo” : 98994, 

“enterpriseID” : “mnuwmxhzzmxxna”, 

“customerJID” : “mnuwmxhzzmxxna#order_1464319325580”, 

“priority” : 1, 

“status” : 1, 

“subject” : “11”, 

“description” : “content”, 

“source” : -1, 

“isDelete” : 0, 

“hasAttach” : 0, 

“createTime” : “2016-06-23 14:14:33”, 

“dispatchStatus” : 0, 

“batchNo” : “146666247348297”, 

“customerName” : “name”, 

“updateTime” : “2016-06-23 14:14:33”, 

“id” : “7e16166c-14e0-4240-8c72-8adb1702b718” 

}, { 

“orderNo” : 98993, 

“enterpriseID” : “mnuwmxhzzmxxna”, 

“customerJID” : “mnuwmxhzzmxxna#order_1464319325580”, 

“priority” : 1, 

“status” : 1, 

“subject” : “11”, 

“description” : “content”, 

“source” : -1, 

“isDelete” : 0, 

“dispatchStrategy” : 1, 

“hasAttach” : 0, 

“createTime” : “2016-06-23 14:13:21”, 

“dispatchStatus” : 0, 

“batchNo” : “146666240197175”, 

“customerName” : “name”, 

“updateTime” : “2016-06-23 14:13:21”, 

“id” : “ab06b4e2-5d6e-4d94-ba3b-cb909d10dd71” 

} ] 

} 

参数名

类型

必选

说明

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}/ 
order/{orderNo}

访问角色

dev、devAdmin

请求方法

GET

请求数据

请求响应

{ 

“code” : 200, 

“message” : “get order success”, 

“ orgName ” : “mnuwmxhzzmxxna”, 

“order” : { 

“orderNo” : 98993, 

“enterpriseID” : “mnuwmxhzzmxxna”, 

“customerJID” : “mnuwmxhzzmxxna#order_1464319325580”, 

“priority” : 1, 

“status” : 1, 

“subject” : “11”, 

“description” : “content”, 

“source” : -1, 

“isDelete” : 0, 

“dispatchStrategy” : 1, 

“hasAttach” : 0, 

“createTime” : “2016-06-23 14:13:21”, 

“dispatchStatus” : 0, 

“batchNo” : “146666240197175”, 

“customerName” : “name”, 

“email” : “”, 

“telephoneNum” : “”, 

“updateTime” : “2016-06-23 14:13:21”, 

“id” : “ab06b4e2-5d6e-4d94-ba3b-cb909d10dd71” 

} 

} 

参数名

类型

必选

说明

code

String

Y

响应状态码，参考返回码定义

message

String

Y

响应消息，简单的文字说明

orgName

String

Y

企业标识