批量发送聊天室消息

请求参数

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

Body 参数application/json

room_id

number

聊天室 ID

必需

聊天室 ID。

sender_id

string

发送者账号

必需

发送聊天室消息的账号 ID。

receiver_ids

array[string]

消息接收账号 ID 列表

可选

消息接收账号 ID 列表，例如["yx2","yx3"]。该参数不为空即判定为定向消息，形象消息不存历史。定向消息不支持 message_config 参数。定向消息不支持空间坐标相关参数。

resend_flag

enum<integer>

重发消息标记

可选

重发消息标记。 0（默认）：非重发消息；1：重发消息（按照 message_client_id 进行去重）。

枚举值:

extension

string

开发者扩展参数

可选

开发者扩展参数，JSON 格式，长度上限为 4096 位字符。例如："{"k":"v"}"

messages

array [object {8}]

消息列表

必需

消息列表。

message_client_id

string

消息ID

可选

消息客户端 ID。

message_type

enum<integer>

消息类型

可选

消息类型。 0：文本消息 1：图片消息 2：语音消息 3：视频消息 4：地理位置消息 6：文件消息 10：提示消息 100：自定义消息

枚举值:

01234610100

sub_type

integer

自定义消息子类型

可选

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

text

string

文本消息

可选

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

attachment

object

多媒体消息内容

可选

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

location_x

number

空间坐标 x

可选

空间坐标 x，用于发送空间消息。

location_y

number

空间坐标 y

可选

空间坐标 y，用于发送空间消息。

location_z

number

空间坐标 z

可选

空间坐标 z，用于发送空间消息。

message_config

object

消息配置项

可选

消息配置项。定向消息（receiver_ids 不为空）不支持该参数。

ignore_chat_banned

boolean

是否忽略聊天室的临时禁言

可选

是否忽略聊天室的临时禁言。false（默认）：不忽略，即消息发送者不能是临时禁言的聊天室成员。

history_enabled

boolean

是否存云端历史

可选

该消息是否存云端历史。默认为 true（存储）。

high_priority

boolean

是否高优消息

可选

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

need_high_priority_msg_resend

boolean

高优先级消息重发标记

可选

高优先级消息重发标记。默认为 false（不重发）。若设置为 true，当用户离开聊天室之后重新加入聊天室，在有效期内（30s）还会收到发送的此条消息。该参数只有在 high_priority = true 时才生效。

abandon_ratio

integer

消息丢弃的概率

可选

消息丢弃的概率，取值范围 [0-9999]。0（默认）：不丢弃消息；9999：99.99% 的概率丢弃消息。此参数可用于流控特定业务类型的消息。<note参数 type=note>若设置该参数，则 high_priority 参数设置无效。

notify_target_tags

string

通知标签

可选

目标标签表达式，用于设定聊天室消息提醒的投递对象，长度上限 128 位字符。

chat_msg_priority

enum<integer>

CDN消息的优先级

可选

走 CDN 通道的消息的优先级，可选值：0（默认），1，2，3

枚举值:

01234

forbidden_if_high_priority_msg_freq

enum<integer>

高优先级消息被频控后是降级为普通消息

可选

高优先级消息被频控后是降级为普通消息还是返回错误码。 0（默认）：降级为普通消息；1：返回 403 错误码。

枚举值:

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。

示例

{
    "room_id": 1605537145,
    "sender_id": "yx5",
    "messages": [
        {
            "message_client_id": "sdsadasdas",
            "location_z": 83,
            "location_y": 34,
            "sub_type": 78,
            "message_type": 0,
            "location_x": 3,
            "text": "dolor anim elit"
        },
        {
            "location_y": 65,
            "message_type": 1,
            "attachment": {
            "name": "器年众际根开以",
            "md5": "esse Excepteur do",
            "url": "http://zpcuedkr.nc/yjy",
            "ext": "Excepteur consequat",
            "width": 83,
            "height": 56,
            "size": 18
        },
            "location_z": 87,
            "sub_type": 21,
            "location_x": 98,
            "message_client_id": "sdfdsfsfsd"
        }
    ],
    "route_config": {
        "route_enabled": true,
        "route_environment": "nostrud elit"
    },
    "extension": "officia nulla fugiat eu ad",
    "receiver_ids": [
        "yx1",
        "yx2"
    ],
    "message_config": {
        "ignore_chat_banned": true,
        "notify_target_tags": "ut eu",
        "chat_msg_priority": 1,
        "history_enabled": false,
        "forbidden_if_high_priority_msg_freq": 1,
        "high_priority": true,
        "abandon_ratio": 8,
        "need_high_priority_msg_resend": true
    },
    "antispam_config": {
        "antispam_enabled": false,
        "antispam_business_id": "44",
        "antispam_extension": null,
        "antispam_custom_message_enabled": true,
        "antispam_custom_message": "laborum non irure et",
        "antispam_cheating": "{\"email\":\"123@126.com\"}"
    },
    "resend_flag": 0
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

success_list

array [object {11}]

必需

示例

{
    "code": 200,
    "msg": "success",
    "data": {
        "success_list": [
            {
                "text": "dolor anim elit",
                "message_client_id": "sdsadasdas",
                "create_time": 1709175752304,
                "message_type": 0,
                "sender_id": "yx5",
                "sender_nick": "yx5",
                "sender_avatar": "",
                "room_id": 1605537145,
                "high_priority": false,
                "sub_type": 78
            },
            {
                "attachment": {
                    "ext": "Excepteur consequat",
                    "size": 18,
                    "name": "器年众际根开以",
                    "width": 83,
                    "url": "http://zpcuedkr.nc/yjy",
                    "md5": "esse Excepteur do",
                    "height": 56
                },
                "message_client_id": "sdfdsfsfsd",
                "create_time": 1709175752304,
                "message_type": 1,
                "sender_id": "yx5",
                "sender_nick": "yx5",
                "sender_avatar": "",
                "room_id": 1605537145,
                "high_priority": false,
                "sub_type": 21
            }
        ]
    }
}