API 参考
在线调试

批量发送单聊消息

更新时间: 2024/07/17 16:53:40

该接口可以在多个单聊会话中发送一条消息,即发送一条消息给多个用户。

调用频率

单个应用默认最高调用频率请参考 频控说明

请求

URL

POST https://open.yunxinapi.com/im/v2/conversations/messages

请求 Header 的参数说明请参见请求 Header

请求体参数

参数名称 类型 是否必选 描述
sender_id String 必选 发送者的云信账号 ID。
receiver_ids Array of strings 必选 接收者账号 ID 列表,JSON 格式。最多传入 500 个云信账号。
message Object 必选 消息体。
route_config Object 可选 抄送相关配置项。
push_config Object 可选 推送相关配置项。
antispam_config Object 可选 安全通相关配置项。
p2p_option Object 可选 单聊消息功能配置项。
sender_no_sense Boolean 可选 发送方是否无感知,默认为 false。若设置为无感知(true),则消息发送者无该消息的多端、漫游、历史记录等信息。
查询历史消息时可设置是否在历史记录查询结果中包含无感知消息,具体参见分页查询历史消息发送者和接收者必须有一方感知,即不能将两者都设置为无感知。
extension String 可选 开发者扩展字段,JSON 格式,长度上限为 1024 位字符。例如:"{"k":"v"}"。

请求体示例

json{
    "extension": "",
    "message": {
        "type": 0,
        "sub_type": 0,
        "text": "hahaha",
        "attachment": {
            "name": "图片发送于2015-05-07 13:59",
            "md5": "9894907e4ad9de4678091277509361f7",
            "url": "http://nimtest.nos.netease.com/cbc500e8-e19c-4b0f-834b-c32d4dc1075e",
            "ext": "jpg",
            "width": 6814,
            "height": 2332,
            "size": 388245
        }
    },
    "route_config": {
        "route_enabled": false,
        "route_environment": ""
    },
    "push_config": {
        "push_content": "string"
    },
    "antispam_config": {
        "yidun_antispam_enable": false
    }
}

响应

Header

响应 Header 的参数说明请参见响应 Header

响应体参数

参数名称 类型 描述 是否必返回
code Integer 状态码,200 表示请求成功。
msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
data Object 返回的 JSON 数据对象,请求失败则返回空对象。

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "success_list": [
            {
                "message": {
                    "message_type": 0,
                    "text": "1231",
                    "extension": "",
                    "sub_type": 1
                },
                "sender_id": "wqt",
                "conversation_type": 1,
                "receiver_id": "apiv2test"
            }
        ],
        "failed_list": [
            {
                "account_id": "Accid1",
                "error_code": 102404,
                "error_msg": "account_id does not exist"
            }
        ]
    }
}

错误码

错误码 错误码描述 错误信息示例
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
此文档是否对你有帮助?
有帮助
去反馈
  • 调用频率
  • 请求
  • URL
  • Header
  • 请求体参数
  • 请求体示例
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码