服务端
API 参考
圈组

发送聊天室全服广播消息

更新时间: 2024/03/15 14:31:50

网易云信 IM 服务端支持发送聊天室全服广播消息。该功能适用于向聊天室全服用户发送公告,发送后,应用下所有聊天室的所有成员会收到该消息。

广播消息只能在线广播,不会存历史消息。

聊天室全服广播消息功能需要在云信控制台功能权限开通->聊天室->高级配置->聊天室全服广播单独开通。

调用限制

聊天室全服广播消息 1 分钟最多可发送 10 条。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API调用方式

  • POST 请求中 Body 的设置如下:

参数类型必填说明
msgId String 客户端消息id,使用uuid等随机串,msgId相同的消息会被客户端去重
fromAccid String 消息发出者的账号accid
msgType int 消息类型:
0: 表示文本消息,
1: 表示图片,
2: 表示语音,
3: 表示视频,
4: 表示地理位置信息,
6: 表示文件,
10: 表示Tips消息,
100: 自定义消息类型(特别注意,对于未对接易盾反垃圾功能的应用,该类型的消息不会提交反垃圾系统检测)
subType int 自定义消息子类型,大于0
resendFlag int 重发消息标记,0:非重发消息,1:重发消息,如重发消息会按照msgid检查去重逻辑
attach String 文本消息:填写消息文案;
其它类型消息,请参考 消息格式示例
长度限制4096字符
ext String 消息扩展字段,内容可自定义,请使用JSON格式,长度限制4096字符
route Integer消息是否需要抄送
0:不需要;1:需要(默认)
highPriority Boolean 可选,true表示是高优先级消息,云信会优先保障投递这部分消息;false表示低优先级消息。默认false。
强烈建议应用恰当选择参数,以便在必要时,优先保障应用内的高优先级消息的投递。若全部设置为高优先级,则等于没有设置,单个聊天室最多支持每秒10条的高优先级消息,超过的会转为普通消息,此外全服广播的高优先级消息不支持重发。
useYidun int 可选,单条消息是否使用易盾反垃圾,可选值为0。
0:(在开通易盾的情况下)不使用易盾反垃圾,包括自定义消息。

若不填此字段,即在默认情况下,若应用开通了易盾反垃圾功能,则使用易盾反垃圾来进行垃圾消息的判断
yidunAntiCheating String 可选,易盾反垃圾含圈组反作弊专属字段,限制json,长度限制1024字符(详见易盾反垃圾接口文档反垃圾防刷版专属字段
bid String 可选,反垃圾业务ID,实现“单条消息配置对应反垃圾”,若不填则使用原来的反垃圾配置
antispam String 对于对接了易盾反垃圾功能的应用,本消息是否需要指定经由易盾检测的内容(antispamCustom)。
true或false, 默认false。
只对消息类型为:100 自定义消息类型 的消息生效。
notifyTargetTags String 可选,标签表达式,最长128个字符
antispamCustom String 在antispam参数为true时生效。
自定义的反垃圾检测内容, JSON格式,长度限制同body字段,不能超过5000字符,要求antispamCustom格式如下:

{"type":1,"data":"custom content"}

字段说明:
1. type: 1:文本,2:图片。
2. data: 文本内容or图片地址。
env String 所属环境,根据env可以配置不同的抄送地址

示例

请求示例(curl)

curlcurl -X POST -H "CheckSum: 51eb13ea**1c65c7866c366" -H "AppKey: f541664055e**d7799" -H "Nonce: 1" -H "CurTime: 1451207708" -H "Content-Type: application/x-www-form-urlencoded" -d 'fromAccid=zhangsan&msgType=0&attach=This+is+test+msg&msgId=c9e6c306-804f-4ec3-b8f0-573778829419' 'https://api.netease.im/nimserver/chatroom/broadcast.action'

请求成功返回示例

json"Content-Type": "application/json; charset=utf-8"
{
  "code":200,
  "desc":{
    "time": "1456396333115", 
    "fromAvator":"http://b12026.nos.netease.com/MTAxMTAxMA==/bmltYV84NDU4OF8xNDU1ODczMjA2NzUwX2QzNjkxMjI2LWY2NmQtNDQ3Ni0E2LTg4NGE4MDNmOGIwMQ==",
    "msgid_client": "c9e6c306-804f-4ec3-b8f0-573778829419",
    "fromClientType": "REST",
    "attach": "This+is+test+msg",
    "roomId": "36",
    "fromAccount": "zhangsan",
    "fromNick": "张三",
    "type": "0",
    "ext": "",
    "highPriorityFlag":1 //高优先级消息标记,不带此标记表示非高优先级
  } 
}

状态码

此 API 在 HTTPS Body 中返回请求的状态码,状态码详情请参见状态码

此文档是否对你有帮助?
有帮助
去反馈
  • 调用限制
  • URL
  • 请求参数
  • 示例
  • 请求示例(curl)
  • 请求成功返回示例
  • 状态码