在线调试
批量发送单聊消息
更新时间: 2025/11/28 10:24:27
该接口可以在多个单聊会话中发送一条消息,即发送一条消息给多个用户。
调用频率
单个应用默认最高调用频率请参考 频控说明。
请求信息
请求 URL
POST https://{endpoint}/im/v2/conversations/messages
请求 URL 中的 {endpoint} 代表服务地址域名,您可以根据用户服务区域选择中国大陆和海外服务地址,并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。
请求头参数
请求 Header 的参数说明请参考 请求 Header。
请求体参数
| 参数名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
sender_id |
String | 是 | 发送者的 IM 账号 ID。 |
receiver_ids |
Array of strings | 是 | 接收者账号 ID 列表,JSON 格式。最多传入 100 个 IM 账号。 |
-
message |
Object | 是 | 消息体。 |
message_type |
Integer | 是 | 消息类型。0:文本消息;1:图片消息;2:语音消息;3:视频消息;4:地理位置消息;6:文件消息;10:提示消息;100:自定义消息。 |
sub_type |
Integer | 否 | 消息子类型。用于对消息进行二级分类,取值范围为大于 0 的正整数。推荐自定义消息类型使用此字段区分不同业务场景,其他消息类型可根据实际需求选择性使用。 |
text |
String | 否 | 对于文本消息和提示消息,该字段必填,值为消息内容,长度上限 5000 位字符。 对于非文本/提示消息,该字段非必填,值为描述信息,可用于 全文关键字搜索历史消息,长度上限 500 位字符。 |
attachment |
Object | 否 | 非文本消息/提示消息的属性或自定义消息内容。 |
-
message_config |
Object | 否 | 消息配置项。 |
unread_enabled |
Boolean | 否 | 消息是否需要计入未读数。默认为 true(计入)。 |
mutil_sync_enabled |
Boolean | 否 | 消息是否需要发送方多端同步。默认为 true(同步)。 |
offline_enabled |
Boolean | 否 | 是否需要存离线消息,默认为 true(存储)。 离线消息指不在线时其他用户发来的消息。如果存离线,在用户下次登录时,IM 服务端会自动将离线期间暂存的离线消息自动下发到客户端 SDK。 |
history_enabled |
Boolean | 否 | 消息是否存云端历史。默认为 true(存储)。 |
roaming_enabled |
Boolean | 否 | 消息是否需要漫游。默认为 true(漫游)。 |
conversation_update_enabled |
Boolean | 否 | 是否将消息更新至会话列表服务中本会话的最后一条消息。默认为 true(更新)。 |
-
route_config |
Object | 否 | 抄送相关配置项。 |
route_enabled |
Boolean | 否 | 该消息是否需要抄送至指定的应用服务器(需要为应用开通消息抄送功能),默认为 true(抄送)。 |
route_environment |
String | 否 | 当前消息需要抄送到的环境的名称,对应您在 网易云信控制台 中配置的自定义抄送的环境名称。 |
-
push_config |
Object | 否 | 推送相关配置项。 |
push_enabled |
Boolean | 否 | 该消息是否需要 APNs 推送或 Android 系统通知栏推送,默认为 true(推送)。只有该字段为 true 时,推送相关参数才会生效。 |
push_nick_enabled |
Boolean | 否 | 推送文案是否需要带上昵称,默认为 true(带昵称)。 |
push_content |
String | 否 | 推送文案,长度上限 500 位字符。如果不填,则使用默认推送文案。 推送文案的显示规则如下: 其中,根据消息类型,默认文案分为以下几种: |
push_payload |
String | 否 | 推送对应的 payload,必须是 JSON 格式,长度上限 2048 位字符。详情请参考 推送 payload 配置。 |
-
antispam_config |
Object | 否 | 安全通相关配置项。 |
antispam_enabled |
Boolean | 否 | 该消息(除自定义消息)是否需要过审核。 |
antispam_business_id |
String | 否 | 安全通业务 ID,可以指定当前消息过安全通某个检测策略。 默认情况下网易云信控制后台会生成默认业务,开通安全通后,客户端不需要配置业务 ID 就能默认走该策略,若需要自定义检测策略,请 提交工单 联系网易云信技术支持工程师进行配置,配置好后传入对应的安全通业务 ID,表示当前消息过安全通的指定检测策略。 |
antispam_extension |
String | 否 | 透传给易盾的反垃圾增强版的检测参数,格式为 JSON,长度限制 1024 位字符(具体请参考易盾的反垃圾增强版用户 可扩展参数)。反作弊相关的 email、phone、token、extension,抄送到 antispam_cheating 字段中。其他用户增值信息,抄送到 antispam_extension 字段。 |
antispam_cheating |
String | 否 | 透传给易盾的反作弊检测参数,格式为 JSON,长度限制 1024 位字符(具体请参考易盾的反垃圾防刷版 专属参数)。反作弊相关的 email、phone、token、extension,抄送到 antispam_cheating 字段中。其他用户增值信息,抄送到 antispam_extension 字段。 antispam_extension 传入的值默认覆盖 extension。 |
-
p2p_option |
Object | 否 | 单聊消息功能配置项。 |
check_friend |
Boolean | 否 | 该消息是否只发给好友(与消息发送者为好友关系的账号),默认为 false。 若需要设置为好友关系才能发送消息,需先在 网易云信控制台 完成配置,再将该字段设置为 true。 |
sender_no_sense |
Boolean | 否 | 发送方是否无感知,默认为 false。若设置为无感知(true),则消息发送者无该消息的多端、漫游、历史记录等信息。 查询历史消息时可设置是否在历史记录查询结果中包含无感知消息,具体参考 分页查询历史消息。 |
receiver_no_sense |
Boolean | 否 | 接收方是否无感知,默认为 false。若设置为无感知(true),则消息接收者无该消息的多端、漫游、历史记录等信息。 查询历史消息时可设置是否在历史记录查询结果中包含无感知消息,具体参考 分页查询历史消息。 |
extension |
String | 否 | 开发者扩展字段,JSON 格式。例如:"{"k":"v"}"。 该字段长度上限以使用的 IM 套餐为准。IM 旗舰版及以上套餐才支持配置字段上限。 |
need_message_detail |
Boolean | 否 | 是否返回消息详情。默认为 true,返回消息的全部信息。 |
请求体示例
JSON{
"sender_no_sense": false,
"extension": "officia labore ex sit ut",
"message": {
"message_type": 0,
"sub_type": 1,
"text": "laborum irure",
"attachment": {
"name": "型用四这却认",
"md5": "amet sit Excepteur officia",
"url": "http://xkjotf.cq/ckp",
"ext": "in qui",
"width": 10,
"height": 95,
"size": 89
}
},
"message_config": {
"unread_enabled": true,
"mutil_sync_enabled": true,
"offline_enabled": true,
"history_enabled": true,
"roaming_enabled": true,
"conversation_update_enabled": true
},
"route_config": {
"route_enabled": false,
"route_environment": "incididunt eiusmod esse magna"
},
"push_config": {
"push_enabled": true,
"push_nick_enabled": false,
"push_content": "proident reprehenderit",
"push_payload": null,
"push_forcepush_all": true,
"push_forcepush_ids": [
"30"
],
"push_forcepush_content": "irure"
},
"antispam_config": {
"antispam_enabled": false,
"antispam_business_id": "31",
"antispam_extension": null,
"antispam_cheating": null
},
"p2p_option": {
"check_friend": true
},
"sender_id": "apifoxtest1",
"receiver_ids": [
"apifoxtest2"
]
}
响应信息
响应头参数
响应 Header 的参数说明请参考 响应 Header。
响应体参数
| 参数名称 | 类型 | 说明 | 是否必返回 |
|---|---|---|---|
code |
Integer | 状态码,200 表示请求成功。 | 是 |
msg |
String | 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。 | 是 |
-
data |
Object | 返回的 JSON 数据对象,请求失败则返回空对象。 | 是 |
-
success_list |
Array of objects | 发送成功的信息列表。 | 否 |
message_server_id |
Long | 服务端消息 ID。 | 否 |
sender_id |
String | 消息发送方账号 ID。 | 否 |
conversation_type |
Integer | 消息会话类型。1:单聊;2:高级群,3:超大群。 | 否 |
receiver_id |
String | 消息接收者账号 ID。 | 否 |
create_time |
Long | 消息发送时间戳。 | 否 |
message_type |
Integer | 消息类型。0:文本消息;1:图片消息;2:语音消息;3:视频消息;4:地理位置消息;6:文件消息;10:提示消息;100:自定义消息。 | 否 |
sub_type |
Integer | 消息子类型。用于对消息进行二级分类,取值范围为大于 0 的正整数。推荐自定义消息类型使用此字段区分不同业务场景,其他消息类型可根据实际需求选择性使用。 | 否 |
text |
String | 文本/提示消息内容或多媒体消息的描述文本(该描述信息可用于云端历史消息关键词检索)。 | 否 |
attachment |
Object | 多媒体消息的属性或自定义消息内容。 | 否 |
-
failed_list |
Array of objects | 发送失败的信息列表。 | 否 |
account_id |
String | 错误的 IM 账号 ID。 | 否 |
error_code |
Integer | 操作失败的错误码。 | 否 |
error_msg |
String | 操作失败的错误信息。 | 否 |
响应体示例
JSON{
"code": 200,
"msg": "success",
"data": {
"success_list": [
{
"text": "{\"msg\":\"2025-07-21T16:46:00.192文本消息测试-9rnauelszd\"}",
"message_server_id": 15026323919688,
"sender_id": "test",
"conversation_type": 1,
"receiver_id": "wm412",
"create_time": 1753087560560,
"message_type": 0,
"sub_type": 1
}
]
}
}
错误码
本文仅列举部分业务接口错误码,完整列表请参考客户端 API 错误码。
| 错误码 | 错误码描述 | 错误信息示例 |
|---|---|---|
| 200 | 请求成功 | success |
| 414 | 参数错误 | parameter error |
| 102404 | 用户发送者账号不存在 | account not exist |
| 102421 | 用户被禁言 | account chat banned |
| 102422 | 用户被禁用 | account banned |
| 107410 | 该 App 未开启发消息功能 | messaging function disabled |
| 107451 | 该消息未通过反垃圾审核 | message hit antispam |
| 500 | 服务器内部错误 | internal server error |
此文档是否对你有帮助?





