首页 > 代码库 > 聊天工具SDK接口开发文档
聊天工具SDK接口开发文档
http 接口
判断客服是否在线的接口
http://.../user/canChat?uid=..&siteid=.. (GET)
返回参数
{
Code{string=} 状态码 正常为0
errno{string=} 错误码 正常为0
messgae{string=} 消息信息 正常为success
data {
can_chat {string=} 是否可接单:0,不可接待 1,可接待
}
}
发送留言信息的接口
http://.../ leavemsg/msg
请求参数(POST)
user_id {int} ucid
site_id {int} 站点ID
ip {string} 网民ip
bid {string} (可选)商桥访客唯一标识
msg {string} (可选)留言内容
name {string}(可选)留言人姓名
phone {int}(可选)手机
telephone {int}(可选)座机
qq {int}(可选)QQ号
address {string} (可选)留言人地址
email {string} (可选)留言人email
沟通SDK
一、 引入方式
<script src="http://meiqia.baidu.com/sdk/api.js"></script>
<script type="text/javascript">
SDK.init({...});
</script>
二、 方法
1. init 初始化方法
options 所需参数(以下参数仅供参考,将按照时间需求设定)
siteid uid appid query
2. connect 建立连接方法无需传参
3. hasConnected 请求判断是不是会话连接成功返回 true或者false
4. restart 重新开始建立沟通
5. disconnect 结束沟通
6. getData 获取沟通相关的数据
请求参数
key
{string=} 传入key值则返回相应的值,不传则返回所有的值
返回参数 (以下参数仅供参考)
res
sessionid {string} 当前会话的ID
subid {string} 当前接待的客服
tid {string} 当前接待客服所在的分组
7. send 发送消息
请求参数
data {Object} 所需参数(文字类型,其他类型见demo)
type {string=} 类型 text
text {string=} 消息内容
fontFamily {string=} fontFamily 字体
fontSize {number=} fontSize 字号
color {string=} color 字体颜色 #ffffff
fontWeight {string=} fontWeight 字体粗细 为粗体则传1
fontStyle {string=} fontStyle 字体斜体则italic,否则不传
fontDecoration {string=} fontDecoration字体带下划线则传underline,否则不传
返回参数 (以下参数仅供参考)
callback {Function=} 回调
status {string} 执行结果状态,为 im.STATUS.SUCCESS 表示成功,为 im.STATUS.FAIL 表示失败
data {Object}
info {string=} 失败时返回失败原因
8. leave 访客离开
9. STATUS 状态码
SUCCESS // 成功
FAIL // 失败
三、 事件
1. Message 获取消息
content {Array.} 消息内容
type {string} 类型
text {string} 内容
name {string} 当前说话的人
time {number} 话说的时间
options {Object} 更多参数描述
wordType {string} 消息类型 word 表示 普通消息, welcome 表示 欢迎语, autoReply 表示自动应答, wait 标示排队自动应答
messageType {string=} 为 history 标示历史消息
speakerType {string} 为 server 标示客服说的话, 为 visitor 标示访客说的话
2. init 初始化事件
status {string} 状态
res {Object} 进站成功数据
bid {string} 访客身份标示
from {string} 访客所在地域
3. connect 沟通建立成功
status {string} 状态
res {Object} 沟通建立成功
result {string} ok表示当前有客服接待,wait表示进入排队,等待客服接待。
4. wait 沟通建立成功且进入排队
5. Taskbegin 沟通建立成功且当前有客服接待
res {Object} 返回的结果
sessionid {string} 会话ID
6. inputing 客服正在输入
7. transfer转移给其他客服
options {Object} 内容
subid {string} 转移给的客服id
tid {string} 转移给的客服所在分组id
8. endsession会话被客服中止
聊天工具SDK接口开发文档