API 参考
在线调试

批量发送自定义系统通知

更新时间: 2024/07/17 16:58:08

该接口可以批量发送多条单聊自定义系统通知。

调用频率

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

请求

URL

POST https://open.yunxinapi.com/im/v2/custom_notification/batch

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

请求体参数

参数名称 类型 是否必选 描述
sender_id String 必选 发送者云信账号 ID。
receiver_ids Array of strings 必选 接收者账号 ID 列表,JSON 格式。最多传入 500 个云信账号。
content String 必选 自定义系统通知的内容,由开发者自行组装的 JSON 格式字符串,长度上限 4096 位字符。
sound String 可选 指定的客户端本地的声音文件名,长度上限 30 位字符。
notification_config Object 可选 通知配置项,不填则采用默认值。
push_config Object 可选 推送相关配置项。
route_config Object 可选 抄送相关配置项。

请求体示例

json{
    "sender_id": "123456",
    "receiver_ids": ["123","456"],
    "content": "attach",
    "push_config": {
        "push_content": "abcdef",
        "push_payload": "push_payload",
        "push_forcepush_enable": true,
        "force_push_content": "文案"
    },
    "sound": "sound",
    "route_config": {
        "route_environment": "test_01"
    },
    "notification_config": {
        "unread_enabled": false
    }
}

响应

Header

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

响应体参数

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

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "failed_list": [
            {
                "account_id": "hkj-100",
                "error_msg": "error",
                "error_code": 102404
            }
        ],
        "success_list": ["hkj1"]
    }
}

错误码

错误码 错误码描述 错误信息示例
200 请求成功 success
414 参数错误 parameter error
416 频率超限 rate limit exceeded
102404 用户不存在 account not exist
500 服务器内部错误 internal server error
503 服务繁忙 server busy
此文档是否对你有帮助?
有帮助
去反馈
  • 调用频率
  • 请求
  • URL
  • Header
  • 请求体参数
  • 请求体示例
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码