服务端
API 参考
圈组

广播消息查询

更新时间: 2024/03/15 14:27:33

网易云信 IM 服务端支持对广播消息的查询功能。

查询单条广播消息

API 使用限制

单个应用默认最高调用频率:100 次/秒。如超限,将被屏蔽 10 秒。

URL

POST  https://api.netease.im/nimserver/history/queryBroadcastMsgById.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求参数

  • POST 请求中 Headers 的设置请参考接口概述
  • POST 请求中 Body 的设置如下:
参数类型必须说明
broadcastId long广播消息ID,应用内唯一

示例

请求示例(curl)

curlcurl -X POST -H "appkey: fe4166***547" -H "nonce: 12345" -H "curtime: 1459154905" -H "checksum: 8d3ef0***e75fc9d3" -H "Content-Type: application/x-www-form-urlencoded" -d 'broadcastId=123456' "https://api.netease.im/nimserver/history/queryBroadcastMsgById.action"

返回示例

json"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "msg": {
        "expireTime": 1505502793520,
        "body": "hello world",
        "createTime": 1505466793520,
        "isOffline": true,
        "broadcastId": 48174937359009,
        "targetOs": [
            "ios",
            "pc",
            "aos"
        ]
    }
} 

批量查询广播消息

API 使用限制

单个应用默认最高调用频率:100 次/秒。如超限,将被屏蔽 10 秒。

URL

POST  https://api.netease.im/nimserver/history/queryBroadcastMsg.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求参数

  • POST 请求中 Headers 的设置请参考接口概述
  • POST 请求中 Body 的设置如下:
参数
类型
必须说明
broadcastId long查询的起始ID,0表示查询最近的limit条。默认0。
limit int查询的条数,最大100。默认100。
type long查询的类型,1表示所有,2表示查询存离线的,3表示查询不存离线的。默认1。

示例

请求示例(curl)

curlcurl -X POST -H "appkey: fe4***547" -H "nonce: 12345" -H "curtime: 1459154905" -H "checksum: 8d3ef0***75fc9d3" -H "Content-Type: application/x-www-form-urlencoded" -d 'type=1' "https://api.netease.im/nimserver/history/queryBroadcastMsg.action"

返回示例

"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "msgs": [
        {
            "expireTime": 1505502793520,
            "body": "hello world 1",
            "createTime": 1505466793520,
            "isOffline": true,
            "broadcastId": 48174937359009,
            "targetOs": [
                "ios",
                "pc",
                "aos"
            ]
        },
        {
            "expireTime": 1505502292394,
            "body": "hello world 2",
            "createTime": 1505466292394,
            "isOffline": true,
            "broadcastId": 48174921356545,
            "targetOs": [
                "pc",
                "aos",
                "ios"
            ]
        }
    ]
} 

状态码

上述接口在 HTTPS Body 中返回请求的状态码,状态码详情请参状态码

此文档是否对你有帮助?
有帮助
去反馈
  • 查询单条广播消息
  • API 使用限制
  • URL
  • 请求参数
  • 示例
  • 请求示例(curl)
  • 返回示例
  • 批量查询广播消息
  • API 使用限制
  • URL
  • 请求参数
  • 示例
  • 请求示例(curl)
  • 返回示例
  • 状态码