发送聊天室全服广播消息
POST
/im/v2/broadcast_notification/actions/chatroom请求参数
聊天室全服广播消息 ID。使用 uuid 等随机串,客户端会通过该 ID 进行消息去重。
聊天室广播消息发送者的云信账号 ID。
开发者扩展字段,长度上限 4096 位字符。
是否为重发消息。0(默认):非重发消息;1:重发消息(会根据 client_broadcast_id 检查去重逻辑)。
消息体。
消息类型。 0:文本消息 1:图片消息 2:语音消息 3:视频消息 4:地理位置消息 6:文件消息 10:提示消息 100:自定义消息 对于未开通安全通(即易盾反垃圾)功能的应用,自定义消息不会过内容审核。
自定义消息子类型,大于 0。message_type = 100 时该字段才有效。
对于文本消息和提示消息,该字段必填,值为消息内容,长度上限 5000 位字符。 对于非文本/提示消息,该字段非必填,值为描述信息,可用于全文关键字搜索历史消息,长度上限 500 位字符。
非文本消息/提示消息的属性或自定义消息内容,长度上限 5000 位字符。 对于非文本消息/提示消息,该字段必填,每种消息的属性参数见:消息格式示例。
抄送相关配置项。
该消息是否需要抄送至指定的应用服务器(需要为应用开通消息抄送功能),默认为 true(抄送)。
抄送相关配置项。
安全通相关配置项。
该消息(除自定义消息)是否需要过审核。 若已在控制台开通安全通,该字段默认为 true(过审核),若需要设置单条消息不经过审核,则设置为 fasle。 若未开通安全通,该字段无效。
安全通业务 ID,可以指定当前消息过安全通某个检测策略。 默认情况下云信控制后台会生成默认业务,开通安全通后,客户端不需要配置业务 ID 就能默认走该策略,若需要自定义检测策略,请联系技术支持进行配置,配置好后传入对应的安全通业务 ID,表示当前消息过安全通的指定检测策略。
透传给易盾的反垃圾增强版的检测参数,格式为 JSON,长度限制 1024 位字符(具体请参见易盾的反垃圾增强版用户可扩展参数)。反作弊相关的 email、phone、token、extension,抄送到 antispam_cheating 字段中。其他用户增值信息,抄送到 antispam_extension 字段。
是否对自定义消息的指定内容(antispam_custom_message)进行审核。 若已在控制台开通安全通,该字段默认为 false(不过审核),若需要设置该条自定义消息经过审核,则设置为 true。 若未开通安全通,该字段无效。
自定义的安全通检测内容, JSON 格式,长度限制同 text 字段。格式如下: {"type":1,"data":"custom content"} 字段说明: type: 1 为文本;2 为图片;3 为视频;(TODO 音频) data: 文本内容或图片地址。 该参数只对自定义消息(message_type = 100 )且 ntispam_custom_message_enabled = true 时才生效。
透传给易盾的反作弊检测参数,格式为 JSON,长度限制 1024 位字符(具体请参见易盾的反垃圾防刷版专属参数)。反作弊相关的 email、phone、token、extension,抄送到antispam_cheating 字段中。其他用户增值信息,抄送到 antispam_extension 字段。 antispam_extension 传入的值默认覆盖 extension。
是否重发高优先级消息,云信会优先保障投递此类消息,默认为 false(低优先级)。 若需要重发高优先级消息,需要配置可以设置 need_high_priority_msg_resend 参数。 建议恰当使用该参数,以便在必要时,优先保障应用内的高优先级消息的投递。若全部设置为高优先级,则等于没有设置,单个聊天室最多支持每秒 10 条高优先级消息,超过的默认转为普通消息。
目标标签表达式,用于设定聊天室消息提醒的投递对象,长度上限 128 位字符。
"client_broadcast_id": "aaaaaaaa-asdasdsadasda-adasda",
"sender_id": "accid1",
"extension": "occaecat",
"resend_flag": 0,
"message": {
"message_type": 0,
"sub_type": 15063838,
"text": "dolor aliqua ut laboris commodo"
},
"route_config": {
"route_enabled": true,
"route_environment": "amet sunt commodo"
},
"message_config": {
"high_priority": false,
"notify_target_tags": " "
}
}
示例代码
返回响应
聊天室广播消息发送时间戳。
聊天室广播消息的 ID。
聊天室广播消息发送方帐号 ID。
聊天室广播消息发送方的昵称。
聊天室广播消息发送方的头像。
发送者所在聊天室 ID。
文本/提示消息内容或多媒体消息的描述文本(该描述信息可用于云端历史消息关键词检索)。
多媒体消息的属性或自定义消息内容。
发送者的客户端类型。
是否为高优先级消息。true:高优先级消息。
自定义消息子类型,大于0。