私聊
发送:chat:private
说明:发起私聊
发送参数:
名称 | 描述 |
---|---|
xid | 欢拓用户ID(String) |
msg | 发送内容(String) |
返回参数:
名称 | 描述 |
---|---|
xid | 欢拓用户ID |
uid | 合作方用户ID |
nickname | 昵称 |
role | 角色 |
msg | 消息内容(String) |
type | 消息类型(String) |
time | 时间 |
示例:
_HT.emit('chat:private', {xid: "123456", msg: "向123456发起一个私聊"}, function(res){
if(res){
// console.log(res.msg);
}
});
接收:chat:private
说明:接收私聊
返回参数:
名称 | 描述 |
---|---|
xid | 欢拓用户ID |
uid | 合作方用户ID |
nickname | 昵称 |
role | 角色 |
msg | 消息内容(String) |
type | 消息类型(String) |
time | 时间 |
示例:
_HT.on('chat:private', function(res){
if(res){
// console.log(res.msg);
}
});
方法: _HT.chat.private() (v6.1+)
说明:获取私聊用户列表或和某个用户的聊天记录
权限说明:只有role 为 admin才有权限
请求参数:
名称 | 描述 |
---|---|
token | access_token 详见如何获取access_token |
xid | 用户的xid(String),可选,如果不传此参数则是获取私聊用户列表,如果传了就是获取和该用户的私聊记录 |
callback | 请求后执行的callback(Function) |
示例1返回的res.data参数:
名称 | 描述 |
---|---|
nickname | 用户昵称 |
role | 用户角色 |
xid | 用户xid |
示例2返回的res.data参数:
名称 | 描述 |
---|---|
nickname | 发消息用户昵称 |
xid | 发消息用户xid |
time | 发消息时间 |
msg | 消息内容 |
role | 发消息用户角色 |
term | 发消息用户终端 |
chat | 禁言状态 |
robot | 是否机器人 |
attr | 附加信息 |
touser | 接收者xid |
示例1:获取私聊用户列表
_HT.chat.private({
token: access_token,
callback: function (res) {
if (res.code == 0) {
// 私聊用户。只有发送过私聊才会记录用户数据,如果只是点击了私聊并未发送聊天内容,执行此方法返回的res.data为[]
console.log(res.data)
} else {
// 接口返回异常,res.msg可查看具体错误信息
console.log(res.msg)
}
}
})
示例2:获取xid为1的私聊记录
_HT.chat.private({
token: access_token,
xid: '1',
callback: function (res) {
if (res.code == 0) {
// 私聊记录
console.log(res.data)
} else {
// 接口返回异常,res.msg可查看具体错误信息
console.log(res.msg)
}
}
})