简要描述：

  • 聊天记录

接口版本：

版本号 制定人 制定日期 修订日期
2.1.0 毛成 2020-08-30 xxxx-xx-xx

请求URL:

请求方式：

  • GET

当使用page进行分页时，我们还会在响应头中返回额外的分页基础数据：

  • X-Pagination-Current-Page 指示当前返回的是第几页的数据
  • X-Pagination-Per-Page 指示每页数据的条数
  • X-Pagination-Page-Count 指示总页数
  • X-Pagination-Total-Count 指示信息流总条数

请求示例

# GET请求
curl -X GET  'http://站点接口域名/openapi/message/chat-list?start=1&page=3' \
  -H 'Authorization: Bearer 5d39164d1f281' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

请求参数:

参数名 是否必须 类型 说明
start 否 string 开始时间 示例:2020-09-01 不传默认7天前
end 否 string 结束时间 示例:2020-09-05
page 否 int 分页 0开始
pageSize 否 int 分页个数
from 否 string 发送人id 或者用户名称
to 否 string 接收人id 或者用户名称
keyword 否 string 标题和内容关键词

返回示例:

正确时返回:

{
    "code": 0,
    "text": "",
    "data": [
        {
            "id": 1049,
            "from": 2538,
            "from_user": "沐沐1",
            "to": 2564,
            "to_user": "",
            "ip": "117.63.42.195",
            "ip_city": "中国江苏常州市电信",
            "created_at": "2020/08/31 03:21",
            "msg_type": "txt",
            "url": "",
            "msg": "hhhhhhhhhh",
        },
        {
            "id": 1045,
            "from": 1,
            "from_user": "admin",
            "to": 0,
            "to_user": "",
            "ip": "",
            "ip_city": "",
            "created_at": "2020/08/11 02:35",
            "msg_type": "txt",
            "url": "",
            "msg": "hhhhhhhhhh",
        }
    ],
    "time": 1599101843
}

错误时返回:

{
    "errcode": 500,
    "errmsg": "invalid appid"
}

返回参数说明:

参数名 类型 说明
id int 消息id
from string 发送人id
from_name int 发送人名称
to string 接收人id
to int 接收人名称
ip string ip
ip_city string ip城市
created_at string 时间
msg_type string 类型
url string 图片地址
msg string 文字内容 
msg_type
txt 文字
img 图片
loc 定位
audio 音频
video 视频
file 文件
gift 礼物
lucky_money 红包
at_user @某人

备注:

  • 更多返回错误代码请看首页的错误代码描述
文档更新时间: 2020-11-06 13:53   作者：毛成