即时通信接口(Beta)
即时通信接口(Beta)
Udesk API 通用说明
创建会话(请求分配客服)
POST /im/sessions
customer_token
应用端客户唯一标识
assign_type
期望的分配类型, 'robot', 'urobot', 'agent', 默认为 'robot'
指定分配的客服id，如果指定忽略 assign_type 和 group_id
指定分配的客服组id，如果指定忽略 assign_type
自定义渠道
robot_role_id
udesk机器人id
udesk机器人对应场景id
customer_token 与创建客户时的 open_api_token 一致
如果 agent_id 和 group_id 都没有指定，且 assign_type 为 'agent'，则按系统分配规则分配
robot_role_id 需要先在云问端设置好
assign_type为’urobot‘时，robot_id和scene_id必填
执行结果码，1000代表成功
分配成功时为欢迎语，失败时为错误提示
assign_type
分配类型, 'robot', 'agent', 'urobot'
assign_info
分配结果信息
根据 assign_type 不同 assign_info 的结构不同。
机器人返回
assign_type 为 robot 时, assign_info 的结构如下:
robot_name
机器人姓名
robot_avatar
机器人头像
welcome_message
unknow_message
未知回答语
&code&: 1000,
&message&: &请求成功&,
&assign_type&: &robot&,
&assign_info&: {
&robot_name&: &Udesk客服机器人&,
&robot_avatar&: &https://rd-dota.udesk.cn/entry/images/agent-avatar-3e6a68e1e1fcb4db653d9e.png&,
&welcome_message&: &&p&您好，我是智能客服机器人，我可以回答您相关的业务问题，有什么问题就问我吧！ 很高兴为您服务！&/p&&p&&br/&&/p&&,
&unknow_message&: &&p&对不起，我目前只能回答常见的业务相关问题！此问题暂不在我知识范围内，我会继续努力学习的！您也可以换个简单的问法向我提问，或许我就可以回答您了...&/p&&,
assign_type 为 ‘urobot’ 时, assign_info 的结构如下:
该条log的id
leadingWord
机器人名称
机器人头像
常见问题列表
&code&: 1000,
&message&: &请求成功&,
&assign_type&: &urobot&,
&assign_info&: {
&sessionId&: 23702,
&logId&: 55392,
&robotName&: &测试&,
&logoUrl&: null,
&leadingWord&: &你好，很高兴为您服务！&,
&helloWord&: &你好，很高兴为您服务！&
&topAsk&: [
&quesitionType&: &问题类型１&，
&quesitionTypeId&: 2,
&optionsList&:[
&quesition&:&问题１&,
&quesitionId&: 2122
&quesition&: &问题２&,
&quesitionId&: 3222
请求客服返回
assign_type 为 agent 时, assign_info 的结构如下:
im_sub_session_id
分配的客服id
agent_name
分配的客服名称
agent_avatar
客服头像地址
survey_options
满意度评价设置
&code&: 1000,
&message&: &请求成功&,
&assign_type&: &agent&,
&assign_info&: {
&im_sub_session_id&: 1234,
&count&: 0,
&agent_id&: 3,
&agent_name&: &Tom&,
&agent_avatar&: &&,
&survey_options&: &见survey_options一节&,
&code&: 2001,
&message&: &当前客服正繁忙，您排在第3位。&,
&assign_type&: &agent&,
&assign_info&: {
&count&: 3,
&code&: 2001,
&message&: &客服分配中!&,
&assign_type&: &agent&,
&assign_info&: {
&count&: 0,
客服不在线
&code&: 2002,
&message&: &当前没有客服在线&,
&assign_type&: &agent&,
&assign_info&: {
&count&: 0,
survey_options
&survey_options&:
&enabled&: true,
# 是否开放
&name&: &满意度评价&,
&title&: &您对本服务的评价是?&,
# 给客户显示提示
&desc&: &感谢您的支持，为了使我们更好的为您服务，请您为本次服务做一个评价（回复字母即可）&,
#微信微博API满意度评价引导语
&remark_enabled&: true,
# 是否可填写评价备注
&remark&: &您可填写评价备注&, # 评价备注提示
&show_type&: String text|expression|star
// 满意度种类
// 可选,当show_type 为 text显示
default_option_id:
options: [{
text: 非常满意|满意|一般|不满意|非常不满意 (可以修改的,显示在BI中)
desc: 不可以修改的
tags: &tag1,tag2&
remark_option: hide|required|optional
expression: { // 可选,当show_type 为 expression 显示
default_option_id:
options: [{
text: 满意|一般|不满意
tags: &tag1,tag2&
remark_option: hide|required|optional
// 可选,当show_type 为 star 显示
default_option_id:
options: [{
text: 满意|一般|不满意
tags: &tag1,tag2&
remark_option: hide|required|optional
&options&: [
兼容模式,评价选项/ id对应 /im_sessions/survey 的 option_id
&text&: &超级满意2&,
&enabled&: true
&text&: &满意2&,
&enabled&: true
&text&: &一般2&,
&enabled&: true
&text&: &不满意&,
&enabled&: true
&text&: &非常不满意&,
&enabled&: true
&methods&: [
# 满意度评价方式
&flag&: &after_session&,
&text&: &对话结束后弹出&,
&enabled&: true
&flag&: &agent_invite&,
&text&: &客服主动邀请&,
&enabled&: true
&id&: 1485,
&flag&: &customer_invite&,
&text&: &客户主动满意度评价（仅支持web和Android/iOS SDK）&,
&enabled&: true
API客户发送消息给客服
POST /im/messages
注意: 发送给机器人的消息 type 参数目前只支持 'message' 类型
customer_token
应用端客户唯一标识
im_sub_session_id
会话ID / ID为0或空为机器人问题/ID为-1为Udesk机器人问题 -2为IM工作台留言
message_id
消息id/公司消息唯一标识（Udesk机器人可不传）
消息类型, 'message', 'image', 'audio', 'rich', 默认为 'message'
消息内容 (详情见 消息内容格式 一节)
Udesk机器人id(Udesk机器人必填)
Udesk机器人对应场景id(Udesk机器人必填)
urobot_session_id
Udesk机器人对应的会话id
指定分配的客服id 配合im_sub_session_id=-2使用
指定分配的客服组id 配合im_sub_session_id=-2使用
执行结果码，1000代表成功
错误返回(assign_type为'robot'时)
message 说明
会话不存在/会话已关闭
回复消息通知
客服推送消息给API客户
POST {接收消息URL}
推送格式为 JSON
接收消息URL，请在管理员-&设置-&渠道管理-&接口消息 中设置
customer_token
应用端客户唯一标识
assign_type
分配类型, 'robot', 'agent', 'urobot'
根据 assign_type 不同，message 的格式有所不同
当 assign_type 为 'robot' 时, message 的格式如下
messages: 对像数组
type: 消息类型
message_id: 消息id, 字符串
data: 消息内容
question_id: 0为寒暄库，非问答; 非0时，可对问答进行有用无用评价
question_title: 问题内容, 字符串
answer: 问题答案文字, 字符串
gus_list: 问题引导列表
- question_title: 问题内容, 字符串
relate_list: 相关问题列表
- question_title: 问题内容, 字符串
third_url: 相关推荐链接
url: 链接地址, 字符串
&customer_token&: &axb&,
&assign_type&: &robot&,
&messages&: [{
&type&: &message&,
&message_id&: &f862f80d-89aa-4f31-92d9-ccd4fcacffcf&,
&question_id&: 210530,
&question_title&: &公司业务是什么&,
&answer&: &嗨,我们是做云客服的公司!不同开发就可以和微信微博web上的用户进行沟通和管理&,
&gus_list&: [
{&question_title&: &你会什么业务&},
{&question_title&: &你们公司有什么业务&}
&relate_list&: [
{&question_title&: &公司在哪里&},
{&question_title&: &联系方式是什么&}
&third_url&: {
&url&: &http://www.udesk.cn&
当 assign_type 为 'urobot' 时, message 的格式如下
messages: 对像
sessionId: 会话id， 字符串
aid: 答案id
ansContent: 答案内容
ansType: 答案类型 (1表示普通答案，2表示答案和建议列表, 3表示建议列表, 4表示返回寒暄，6表示未知说辞, 8表示敏感词 )
hitQuestion: 问题内容
suggestQuestionList: 建议列表
&sessionId&: 1835244,
&logId&: 3574331,
&aid&: 12,
&ansContent&: &申诉流程&,
&ansType&: 1,
hitQuestion: &账号申诉&,
&suggestQuestionList&: [
&id&: 434,
&content&: &问题1&,
当 assign_type 为 'agent' 时, messages 的格式如下
type: 消息类型, 'message', 'image', 'audio', 'rich', 参见 &http://git.flyudesk.com/udesk/udesk_im/blob/master/doc/server/agent_logs.md&
message_id: 消息id
agent_id: 客服id
agent_name: 客服名称
agent_avatar: 客服头像
im_sub_session_id: 会话ID
message_created_at: 消息创建时间 &:52:11&
data: 与发送消息内容相同
font: 字体, 仅支持message
content: 内容
&customer_token&: &axb&,
&assign_type&: &agent&,
&messages&: [
&type&: &start_session&,
&message_id&: &xxxxx&,
&agent_id&: 1,
&agent_name&: &TOM&,
&agent_avatar&: &http://123.com/1.png&,
&im_sub_session_id&: 3,
&message_created_at&: &:52:11&,
&content&: &对话开始&
&type&: &message&,
&message_id&: &xxxxx&,
&agent_id&: 1,
&agent_name&: &TOM&,
&agent_avatar&: &http://123.com/1.png&,
&im_sub_session_id&: 3,
&message_created_at&: &:52:12&,
&font&: &字体, 仅支持message&,
&content&: &您好,有什么可以帮助您?&,
&type&: &rich&,
&message_id&: &xxxxx&,
&agent_id&: 1,
&agent_name&: &TOM&,
&agent_avatar&: &http://123.com/1.png&,
&im_sub_session_id&: 3,
&message_created_at&: &:52:13&,
&content&: &本公司促销产品走过路过不要错过 &a href=\&https://xxx.com/1.png\&&热销.com&/a&&,
&type&: &close&,
&message_id&: &xxxxx&,
&agent_id&: 1,
&agent_name&: &TOM&,
&agent_avatar&: &http://123.com/1.png&,
&im_sub_session_id&: 3,
&message_created_at&: & 00:00:00&,
&close_type&: &normal(正常)|redirect(转接)|force(强制)&
&content&: &关闭会话&,
&survey_options&: &见survey_options一节&,
请在10秒内返回 HTTP Status Code 200，响应体为空，否则 UDesk 端会认为发送失败，并尝试重发
消息内容格式
type 类型及支持列表
暂不支持发送语音
暂不支持发送视频
富文本消息
结构话消息
start_session
对话开始时推给客户
客户被转接时推给客户,客户需要修改im_sub_session_id 为新的
info_transfer
转接事件显示内容
客户被转接时显示给客服的提示内容
会话关闭事件
客户会话被关闭时推给客户
满意度评价相关事件
只会在客服IM工作台显示
active_guest
客服主动会话事件
仅支持web访客
info_appoint
客服分配客户事件
发送表单消息事件
form_received
接受表单消息事件
询前表单 is_receive: false
仅用于客服显示
robot_transfer
机器人转接对话
仅用于客服显示

注: 不支持/暂不支持/仅用于客服显示的消息,不要在客户端显示处理
消息内容详情
根据 type 类型，data 的结构也有所不同:
# 普通消息
type: 'message'
font: 字体格式, 选填, 比如
content: 文本内容
注: 文本内容可以包含 富文本 html 标签
# 图片消息
type: 'image'
content: url
# 语音消息
type: 'audio'
content: url
filename: '足球.mp4' #
filesize: &4.3M&
duration: 200
# 语音时长,可能没有 # 单位为s
type: 'video'
# 仅支持mp4
content: url
filename: '足球.mp4' # 文件名称
filesize: &4.3M&
# 文件大小
type: 'rich'
content: &p&您好，小雅客服很高兴为您服务，请问有什么可以帮您？&/p&
# type: struct
结构化消息, 现仅支持 web/sdk
# 相关文档 &http://www.udesk.cn/website/doc/apiv1/im/#im_2&
# start_session 会话开始,通常为数组推送,后面有欢迎语 message
type: &start_session&,
content: &对话开始&
# transfer 会话被转接,通常为数组推送,后面有转接内容 message 如: '会话转接成功,客服xx为您服务'
type: &transfer&,
content: &会话转接&
type: &info_transfer&,
content: &客服Jerry213转接会话&
type: &close&,
content: &会话关闭&
机器人问答评价
customer_token
应用端客户唯一标识
message_id
所评价机器人答案的消息ID
question_id
问题是否有用
执行结果码，1000代表成功
urobot机器人会话评价（urobot使用)
POST /im/sessions/robot_survey
customer_token
应用端客户唯一标识
im_sub_session_id
评价选项ID (2：满意 3：一般 4：不满意)
udesk机器人id
udesk机器人对应场景id
执行结果码，1000代表成功
会话评价（评价客服）
POST /im/sessions/survey
im_sub_session_id
评价选项id
执行结果码，1000代表成功
问题评价(仅限urobot使用)
POST /im/messages/answer_survey
customer_token
应用端客户唯一标识
messgae_id
问题答案所在的消息id
im_sub_session_id
评价选项id(1表示满意，2表示不满意,默认为满意)
udesk机器人id
udesk机器人对应场景id
执行结果码，1000代表成功
用户点击行为接口
POST /im/messages/hit
customer_token
应用端客户唯一标识
im_sub_session_id
message_id
机器人答案的消息id
question_id
query_type
6：常见问题点击
7：建议列表点击
参考urobot回复消息通知接口的返回
获取urobot列表
GET /im/urobots
执行结果码，1000代表成功
返回结果信息
urobot_list
机器人列表的详细信息
&code&: 1000,
&message&: &请求成功&,
&urobot_list&: [
&name&: &默认机器人&,
&logo&: &&,
&scene_list&: [
&id&: 114,
&name&: &默认场景&
&id&: 116,
&name&: &系统默认场景&
&created_at&: &T10:55:20.000+08:00&
&name&: &测试&,
&logo&: &&,
&scene_list&: [
&id&: 120,
&name&: &系统默认场景&
&created_at&: &T11:25:30.000+08:00&
转人工统计接口(urobot使用)
POST /im/sessions/transfer_survey
im_sub_session_id
机器人场景id
查询排队状态
GET /im/queue_status
customer_token
应用端客户唯一标识
执行结果码，1000代表成功
排队状态, '排队中', '未排队', '会话中', '分配中'
查询客户状态
用于查看客户是否在会话中,支持 customer_token / web_token / sdk_token 查询客户
GET /im/customer_status
customer_token
OpenApi 客户唯一标识
web 客户唯一标识
sdk 客户唯一标识
session_key
web_token 存在时,支持多会话不同的会话状态
注: customer_token/web_token/sdk_token必须存在一个,按顺序取第一个有值参数
执行结果码，1000代表成功
status_code
'无会话','会话中','排队中','无效客户'
查询客服状态
查看当前所有客服的在线状态
GET /im/agent_status
如果只查看某个客服组
如果没有指定,则返回全部
执行结果码，1000代表成功,11012指定组不存在
返回客服数据,详见客服状态详细
客服状态详细
客服昵称,用于对客户显示,如果为空,显示客服姓名
在线状态 online/busy/offline (在线/忙碌/离线)
im_custom_status
自定义状态,仅在im_status为busy时有效
im_session_num
当前接待人数,仅在im_status为online/busy时有效,可能为0,可能有数,但数字无意义
im_max_join_num
客服最大接待人数,仅在im_status为online/busy时有效,可能为0,可能有数,但数字无意义
&code&: &1000&,
&agents&: [
name: '张xxx',
nick: 'Jerry',
avatar: 'udesk.cn/xxxx.jpm',
im_status: 'online',
im_custom_status: '',
im_session_num: 3,
im_max_join_num: 5,
我们想使用这个API接口,需要什么条件?
此API接口是高级接口,需要开发量较大,要求较高.必须符合以下条件:
必须自建即时通讯平台.
Udesk只负责推送给您的服务器,不负责推送给您的客户.
您必须已经拥有即时通讯平台或有自建即时通讯平台的能力,或是使用第三方平台
如果您的客户都是 微信/微博 平台,可以认为已经拥有即时通讯平台
有很强的后台开发能力,需要进行如下工作
维护客户信息,并把用户创建/更新到Udesk平台
维护客户的会话
维护对话内容,把客服回复客户的对话推送给客户
[可选] 维护满意度显示及结果
推送到我们指定服务器地址的请求是什么格式的 ?
POST请求,JSON格式.
我请求会话后返回客户不存在?
请求会话前需要请求创 建客户,详见
我们的服务器收不到客服回复的消息,怎么确认Udesk是否推送过来?
用nginx/apache 做前置,这样不管后端应用是不是处理正确,都能在前端 上看到日志是否收到请求
应用服务器先什么先只把收到的请求 body 打印到日志看下是不是到收请求,再进行业务逻辑开发
为什么回复消息什么时候会返回多条消息?
当一些事件和消息有强顺序绑定,如开始会话事件和欢迎语消息.巴卜技术平台做短信接口开发吗？_百度知道
巴卜技术平台做短信接口开发吗？
我有更好的答案
做的，巴卜短信接口是最简单的，适配很多语言，有汇总demo实例可以下载。
为您推荐：
其他类似问题
您可能关注的内容
换一换
回答问题，赢新手礼包
个人、企业类
违法有害信息,请在下方选择后提交
色情、暴力
我们会通过消息、邮箱等方式尽快将举报结果通知您。巴卜技术平台短信接口开发用什么中间件？_百度知道
巴卜技术平台短信接口开发用什么中间件？
我有更好的答案
这个问题很难回答，这个市场有点乱，找大的不一定好，找小的不一定稳定，找贵的不一定好，找便宜的差的一踏糊涂，我是身受其害，没少花冤枉钱，最后总结出找口碑好的，像皓宇信息通、238、鱼贡通信都不错，首推第一家，供楼主参考吧
采纳率：93%
有多种中间件协同开发的，具体还要咨询巴卜技术团队。
为您推荐：
其他类似问题
您可能关注的内容
换一换
回答问题，赢新手礼包
个人、企业类
违法有害信息,请在下方选择后提交
色情、暴力
我们会通过消息、邮箱等方式尽快将举报结果通知您。巴卜短信告诉你如何实现短信平台接口一般短信平台都支持HTTP协议调用。开发工程师在对接时需要将发送短信的地方添加接口地址和相关参数，如接收端手机号码、接收的内容以及其他接口参数，调用完就会返回相应的字符结果(xml,txt,json等)数据，表示成功提交或者提交失败。有关回复短信，会绑定到一个接收回复内容的地址，短信平台会推送过去；或直接调用短信平台的回复获取地址去抓取回复短信内容。
特别声明：本文为网易自媒体平台“网易号”作者上传并发布，仅代表该作者观点。网易仅提供信息发布平台。
一键安装官方客户端
重大事件及时推送 阅读更流畅
http://dingyue.nosdn.127.net/hFI=Ncf1fr9U7wiC6zbsBOe2tRBbFt1w6Y62mVgSK0D0X8compressflag.jpg中国移动通信有限公司政企客户分公司云MAS平台SDK接口1.0.3(.NET版)_百度文库
赠送免券下载特权
10W篇文档免费专享
部分付费文档8折起
每天抽奖多种福利
两大类热门资源免费畅读
续费一年阅读会员，立省24元！
中国移动通信有限公司政企客户分公司云MAS平台SDK接口1.0.3(.NET版)
阅读已结束，下载本文需要
想免费下载本文？
定制HR最喜欢的简历
下载文档到电脑，同时保存到云知识，更方便管理
加入VIP
还剩9页未读，
定制HR最喜欢的简历
你可能喜欢