本文介绍如何通过 NERoom 服务端接口发送全服广播消息。

请求

URI

httpPOST https://{endpoint}/neroom/v1/broadcast

• {endpoint} 为 NERoom 接入地址的域名，默认为 roomkit.netease.im。如果您的应用主要服务于海外用户，请将域名设置为海外数据中心域名（roomkit-sg.netease.im）。
• Content-Type: application/json; charset=utf-8。

Header

请求 Header 的设置请参见 请求结构。

请求参数

参数	类型	必填	说明
msg_id	String	是	客户端消息ID，使用 UUID 等随机串，msg_id 相同的消息会被客户端去重。
sender_user_uuid	String	是	消息发出者的账号ID（user_uuid）。
msg_type	Integer	是	消息类型： 0: 表示文本消息， 1: 表示图片， 2: 表示语音， 3: 表示视频， 4: 表示地理位置信息， 6: 表示文件， 10: 表示Tips消息， 100: 自定义消息类型（注意，对于未对接易盾反垃圾功能的应用，该类型的消息不会提交反垃圾系统检测）。
sub_type	Integer	否	自定义消息子类型，大于0。
resend_flag	Integer	否	重发消息标记，0：非重发消息，1：重发消息，如重发消息会按照 msg_id 执行去重逻辑。
attach	String	否	文本消息：填写消息文案; 其它类型消息，请参考消息格式示例； 长度限制4096字符。
ext	String	否	消息扩展字段，内容可自定义，请使用JSON格式，长度限制4096字符。
route	Integer	否	消息是否需要抄送。 0：不需要；1：需要（默认）
high_priority	Boolean	否	可选，true 表示高优先级消息，云信会优先保障投递此类消息；false 表示低优先级消息。默认值 false。 建议按应用实际业务场景设置参数，确保高优先级消息的投递。如果全部广播消息设置为高优先级，则会导致部分广播消息的高优先级设置失效，因为单个聊天室最多支持每秒10条的高优先级消息，超过限制的会转为普通消息。 此外全服广播的高优先级消息不支持重发。
use_yidun	Integer	否	可选，单条消息是否使用易盾反垃圾，可选值为0。 0：（在开通易盾的情况下）不使用易盾反垃圾，包括自定义消息。 若不填此字段，即在默认情况下，若应用开通了易盾反垃圾功能，则使用易盾反垃圾来进行垃圾消息的判断
yidun_anti_cheating	String	否	可选，易盾反垃圾增强反作弊专属字段，限制JSON格式数据，长度1024字符（详见易盾反垃圾接口文档反垃圾防刷版专属字段）
bid	String	否	可选，反垃圾业务ID，实现单条消息配置对应反垃圾。若不填则使用原来的反垃圾配置
antispam	Boolean	否	对于对接了易盾反垃圾功能的应用，本消息是否需要指定经由易盾检测的内容（antispam_custom）。 true或false, 默认false。 只对消息类型为：100 自定义消息类型 的消息生效。
notify_target_tags	String	否	可选，标签表达式，最长128个字符
antispam_custom	String	否	在 antispam 参数为 true 时生效。 自定义的反垃圾检测内容, JSON格式，长度限制与 body 字段相同，不能超过5,000字符。要求 antispam_custom 格式如下： {"type":1,"data":"custom content"} 字段说明： 1. type: 1：文本，2：图片。 2. data: 文本内容或图片地址。
env	String	否	所属环境，根据 env 可以配置不同的抄送地址。

请求示例

curlcurl --request POST 'https://roomkit.netease.im/neroom/v1/broadcast' \
--header 'AppKey: xxx' \
--header 'Nonce: xxx' \
--header 'CurTime: 1677050511' \
--header 'CheckSum: xxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "msg_id": "c9e6c306-804f-4ec3-b8f0-573778829419",
    "high_priority": true,
    "sender_user_uuid": "user01",
    "msg_type": 0,
    "attach": "test msg"
}'

响应

响应字段

字段	类型	示例	描述
code	Integer	0	状态码，0 表示成功。具体含义请参见错误码。
msg	String	Success	业务结果描述，Success表示成功。
ts	Long	1648021056815	NERoom 服务器处理该请求的完成时间。该时间为 Unix 时间戳，即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数。
request_id	String	7c4b6d9c3e9d42*****cc6e3a4d995	请求的唯一标识。
cost	String	48ms	处理该请求所消耗的时间。
data			无

响应示例

json{
    "code":0,
    "msg":"Success",
    "ts":1619068087795,
    "request_id":"6e507107d1f4447ea731f651dc6d2432",
    "cost":"66ms"
}

错误码

错误码	错误信息	说明	处理建议
0	Success	请求成功	无需处理
400	Invalid parameter.	参数错误	检查接口传参
1004	Room not found.	房间不存在或者已关闭	根据业务场景处理