更新时间: 2021-03-08

# 功能描述

是指系统向 App 中所有在线用户发送消息的行为。当用户正在使用 App 时,消息会展示在聊天界面和会话列表界面,会话类型为 SYSTEM。

# 在线广播消息

# 功能接口

系统通知消息,只能通过 Server API 进行发送,终端用户收到系统消息后,不支持消息回复功能。
在线广播消息使用的是服务端通知 SDK 拉取机制实现,发送消息后极端情况下用户 5 分钟内可收到此条消息。

请求地址: https://数据中心域名/message/online/broadcast.json

请求方法: POST

调用频率: 通过 Server API 单个应用每分钟最多发送 10 次。

签名规则: 所有请求融云服务端 API 接口的请求均需要进行规则校验,详细请参考 通用 API 接口签名规则

输入参数:

参数 类型 必传 说明
fromUserId String 发送人用户 Id。
objectName String 消息类型,可自定义消息类型,长度不超过 32 个字符,在自定义消息时需要注意,不要以 "RC:" 开头,以避免与融云系统内置消息的 ObjectName 重名。
content String 发送消息内容,单条消息最大 128k,内置消息以 JSON 方式进行数据序列化,消息中可选择是否携带用户信息,详见消息结构示例;如果 objectName 为自定义消息类型,该参数可自定义格式,不限于 JSON。

返回结果:

返回值 返回类型 说明
code Int 返回码,200 为正常。
# 调用示例

Request:

POST /message/online/broadcast.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1585127132438
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: Application/x-www-form-urlencoded

content=%7B%22content%22%3A%22hello%22%2C%22extra%22%3A%22helloExtra%22%7D&fromUserId=2191&objectName=RC:TxtMsg
已复制
1
2
3
4
5
6
7
8
9

Response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}
已复制
1
2
3
4

文档是否解决您的问题 ?

如果遇到产品相关问题,您可 提交工单 寻求帮助