发送聊天室全服广播消息

POST

/im/v2/broadcast_notification/actions/chatroom

请求参数

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

Body 参数application/json

client_broadcast_id

string

必需

聊天室全服广播消息 ID。使用 uuid 等随机串，客户端会通过该 ID 进行消息去重。

sender_id

string

必需

聊天室广播消息发送者的云信账号 ID。

extension

string

可选

开发者扩展字段，长度上限 4096 位字符。

resend_flag

integer

必需

是否为重发消息。0（默认）：非重发消息；1：重发消息（会根据 client_broadcast_id 检查去重逻辑）。

>= 0<= 1

message

object

消息体

必需

消息体。

message_type

integer

消息类型

必需

消息类型。 0：文本消息 1：图片消息 2：语音消息 3：视频消息 4：地理位置消息 6：文件消息 10：提示消息 100：自定义消息对于未开通安全通（即易盾反垃圾）功能的应用，自定义消息不会过内容审核。

sub_type

integer

自定义消息子类型

可选

自定义消息子类型，大于 0。message_type = 100 时该字段才有效。

> 0

text

string

文本消息

可选

对于文本消息和提示消息，该字段必填，值为消息内容，长度上限 5000 位字符。对于非文本/提示消息，该字段非必填，值为描述信息，可用于全文关键字搜索历史消息，长度上限 500 位字符。

<= 500 字符

attachment

object

多媒体消息内容

可选

非文本消息/提示消息的属性或自定义消息内容，长度上限 5000 位字符。对于非文本消息/提示消息，该字段必填，每种消息的属性参数见：消息格式示例。

route_config

object

抄送配置

可选

抄送相关配置项。

route_enabled

boolean

可选

默认值:

true

route_environment

string

可选

antispam_config

object

安全通配置

可选

安全通相关配置项。

antispam_enabled

boolean

安全通开关

可选

该消息（除自定义消息）是否需要过审核。若已在控制台开通安全通，该字段默认为 true（过审核），若需要设置单条消息不经过审核，则设置为 fasle。若未开通安全通，该字段无效。

默认值:

true

antispam_business_id

string

安全通业务ID

可选

安全通业务 ID，可以指定当前消息过安全通某个检测策略。默认情况下云信控制后台会生成默认业务，开通安全通后，客户端不需要配置业务 ID 就能默认走该策略，若需要自定义检测策略，请联系技术支持进行配置，配置好后传入对应的安全通业务 ID，表示当前消息过安全通的指定检测策略。

antispam_extension

string

安全通增强参数

可选

透传给易盾的反垃圾增强版的检测参数，格式为 JSON，长度限制 1024 位字符（具体请参见易盾的反垃圾增强版用户可扩展参数）。反作弊相关的 email、phone、token、extension，抄送到 antispam_cheating 字段中。其他用户增值信息，抄送到 antispam_extension 字段。

antispam_custom_message_enabled

boolean

自定义内容审核开关

可选

是否对自定义消息的指定内容（antispam_custom_message）进行审核。若已在控制台开通安全通，该字段默认为 false（不过审核），若需要设置该条自定义消息经过审核，则设置为 true。若未开通安全通，该字段无效。

默认值:

false

antispam_custom_message

string

自定义安全通检测内容

可选

自定义的安全通检测内容, JSON 格式，长度限制同 text 字段。格式如下： {"type":1,"data":"custom content"} 字段说明： type: 1 为文本；2 为图片；3 为视频；4 为音频；5 为图文。 data: type 为 1、2、3、4 时，data 为字符串，分别传入文本内容、图片地址、视频/音频地址。 type 为 5 时，data 为 JSON 格式。例如：{"text":""，//1 个文本必填"images":["url1,"url2"], //最大 6 个图片必填"textbid":"", //文本检测业务 ID 选填"picbid":"" //图片检测业务 ID 选填}。该参数只对自定义消息（message_type = 100 ）且 ntispam_custom_message_enabled = true 时才生效。

antispam_cheating

string

反作弊检测参数

可选

透传给易盾的反作弊检测参数，格式为 JSON，长度限制 1024 位字符（具体请参见易盾的反垃圾防刷版专属参数）。反作弊相关的 email、phone、token、extension，抄送到antispam_cheating 字段中。其他用户增值信息，抄送到 antispam_extension 字段。 antispam_extension 传入的值默认覆盖 extension。

message_config

object

消息配置项。

可选

high_priority

boolean

可选

是否重发高优先级消息，云信会优先保障投递此类消息，默认为 false（低优先级）。若需要重发高优先级消息，需要配置可以设置 need_high_priority_msg_resend 参数。建议恰当使用该参数，以便在必要时，优先保障应用内的高优先级消息的投递。若全部设置为高优先级，则等于没有设置，单个聊天室最多支持每秒 10 条高优先级消息，超过的默认转为普通消息。

notify_target_tags

string

可选

目标标签表达式，用于设定聊天室消息提醒的投递对象，长度上限 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": " "
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open.yunxinapi.com/im/v2/broadcast_notification/actions/chatroom' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '"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": " "
    }
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

create_time

number

必需

聊天室广播消息发送时间戳。

client_broadcast_id

string

必需

聊天室广播消息的 ID。

sender_id

string

必需

聊天室广播消息发送方帐号 ID。

from_nick

string

必需

聊天室广播消息发送方的昵称。

from_avator

string

必需

聊天室广播消息发送方的头像。

room_id

string

必需

发送者所在聊天室 ID。

message_type

integer

广播消息类型。

必需

text

string

必需

文本/提示消息内容或多媒体消息的描述文本（该描述信息可用于云端历史消息关键词检索）。

attachment

object

必需

多媒体消息的属性或自定义消息内容。

from_client_type

string

必需

发送者的客户端类型。

high_priority

boolean

必需

是否为高优先级消息。true：高优先级消息。

sub_type

integer

必需

自定义消息子类型，大于0。

示例

{
    "code": 0,
    "msg": "string",
    "data": {
        "create_time": 0,
        "client_broadcast_id": "string",
        "sender_id": "string",
        "from_nick": "string",
        "from_avator": "string",
        "room_id": "string",
        "message_type": 0,
        "text": "string",
        "attachment": {},
        "from_client_type": "string",
        "high_priority": true,
        "sub_type": 0
    }
}

🟢200成功

🟢200请求参数错误

🟢200服务器错误

分页查询广播消息

发送自定义系统通知