获取消息列表
API 地址
api.yun.vhall.com/api/v1/channel/get-message-list
描述
根据频道ID,获取消息列表
入参
关于公共请求参数详细内容,请参考 公共请求参数。
参数 | 类型 | 是否必选 | 含义 |
---|---|---|---|
channel_id | string | 是 | 频道ID |
type | int | 否 | 查询类型 ,1 聊天列表( 默认),2 自定义聊天列表 |
pos | int | 否 | 获取条目节点,默认为 0。eg : 10 从第10条开始查询 |
limit | int | 否 | 获取条目数量,默认为 10 条,最大为1000条 |
filter_status | int | 否 | 过滤类型 , 0 可查看( 默认),1 不可查看 |
start_time | date | 是 | 查询开始时间,格式为:2017/01/01 |
end_time | date | 否 | 查询结束时间,默认为当前时间,格式为:2017/01/01 |
出参
参数 | 类型 | 是否必选 | 含义 |
---|---|---|---|
data | string | 是 | 聊天内容 |
date_time | string | 是 | 聊天时间 |
third_party_user_id | string | 是 | 第三方用户ID |
nick_name | string | 是 | 第三方用户昵称 |
错误码
错误码 | 类型 | 含义 | |
---|---|---|---|
10016 | int | 频道ID不能为空 | |
20004 | int | 频道查询为空 | |
20010 | int | 聊天数据查询为空 | |
30002 | int | 不是当前频道拥有者 | |
10020 | int | 开始时间不能为空 | |
40002 | int | 消息类型不正确 | |
40004 | int | 时间类型不正确 | |
40038 | int | 过滤类型不正确 |
响应格式
- 返回列表数据按时间格式倒序
{
"code": 200,
"msg": "",
"data": [
{
"data": "天天",
"date_time": "2017-12-22 01:32:25",
"third_party_user_id": "test1",
"nick_name": "游客1443"
},
{
"data": "英语",
"date_time": "2017-12-22 01:32:09",
"third_party_user_id": "third_party_user_id",
"nick_name": "游客1443"
}
]
}