简要描述:

  • 根据活动ID获取活动的互动列表,分页获取,每页最多返回20条信息

访问权限

账号类型 是否有权限
主账号
子账号

请求域名:

  • http://api.zmengzhu.com

请求URL:

GET/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

返回示例:

正确时返回:

// 展示总数请求返回数据结构
{
    "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": 20001,
    "msg": "签名校验失败",
    "data": {}
}