简要描述:
- 根据活动ID获取活动的互动列表,分页获取,每页最多返回20条信息
访问权限
接口URL:
http://api.zmengzhu.com/business/v1/message/history |
请求方式:
返回结果格式:
参数:
参数名 |
是否必须 |
类型 |
说明 |
ticket_id |
是 |
int |
活动id |
offset |
否 |
int |
查询历史聊天位移值 默认0 |
limit |
否 |
int |
每次请求获取聊天数量 默认20 |
show_num |
否 |
int |
是否显示总数,0:否 1:是,默0, 注意返回数据结构不同 |
keywords |
否 |
string |
搜索聊天关键词 |
start_at |
否 |
string |
消息发送时间 2019-10-01 |
end_at |
否 |
string |
消息发送时间 2019-10-02 |
返回示例:
响应成功JSON示例:
// 展示总数请求返回数据结构
{
"code": 200,
"msg": "ok",
"data": {
"total": "1",
"list": [
{
"id": "303636", // 聊天消息id
"channel": "smb.10001724",
"text": {
"user_id": "2006058", // 用户uid
"account_id": "2006058",
"user_name": "江湖六少", // 用户昵称
"avatar": "http://s1.zmengzhu.com/upload/img/e4/8c/e48c82fe4be616a0c6ea53134995b767.jpeg", // 用户头像
"room": "10001724",
"role": "host", // 用户身份 host:管理员 user:用户 anonymous:游客
"event": "msg", // 消息类型
"time": "2019-09-17 17:49:14", // 发送时间
"real_name": "smb.10001724",
"app": "smb",
"data": "{\"text\":\"你好\"}" // 消息内容
},
"tag": "",
"time": ""
}
]
}
}
// 不展示总数请求返回数据结构
{
"code": 200,
"msg": "ok",
"data": [
{
"id": "303636", // 聊天消息id
"channel": "smb.10001724",
"text": {
"user_id": "2006058", // 用户uid
"account_id": "2006058",
"user_name": "江湖六少", // 用户昵称
"avatar": "http://s1.zmengzhu.com/upload/img/e4/8c/e48c82fe4be616a0c6ea53134995b767.jpeg", // 用户头像
"room": "10001724",
"role": "host", // 用户身份 host:管理员 user:用户 anonymous:游客
"event": "msg", // 消息类型
"time": "2019-09-17 17:49:14", // 发送时间
"real_name": "smb.10001724",
"app": "smb",
"data": "{\"text\":\"你好\"}" // 消息内容
},
"tag": "",
"time": ""
}
]
}
字段说明:
参数名 |
说明 |
code |
成功为200 |
msg |
成功返回ok |
id |
聊天消息id |
channel |
聊天室频道 |
user_id |
用户uid |
account_id |
账号 |
user_name |
用户昵称 |
avatar |
用户头像 |
room |
房间号 |
role |
用户身份 host:管理员 user:用户 anonymous:游客 |
event |
消息类型 |
time |
发送时间 |
real_name |
拼接字段 |
app |
拼接字段 |
data |
消息内容 |
错误时返回:
{
"code": 20001,
"msg": "签名校验失败",
"data": {}
}