即时通信
  1. 系统通知管理
即时通信
  • API在线调试指南
  • IM账号管理
    • 注册云信IM账号
      POST
    • 更新账号属性
      PATCH
    • 刷新 Token
      PATCH
    • 封禁账号
      PATCH
    • 更新移动端推送配置
      PATCH
    • 查询账号属性
      GET
    • 批量查询账号信息
      GET
    • 强制账号退出登录
      POST
  • 用户名片管理
    • 更新用户名片
      PATCH
    • 查询用户名片
      GET
    • 批量查询用户名片
      GET
    • 批量获取账号在线状态
      POST
  • 好友管理
    • 添加好友
      POST
    • 删除好友
      DELETE
    • 更新好友信息
      PATCH
    • 查询好友信息
      GET
    • 分页查询好友列表
      GET
    • 同意/拒绝添加好友
      POST
  • 静音管理
    • 分页查询静音列表
      GET
    • 解除静音
      DELETE
    • 设置静音
      POST
  • 黑名单管理
    • 列入黑名单
      POST
    • 移出黑名单
      DELETE
    • 分页查询黑名单列表
      GET
  • 消息管理
    • 发送消息
    • 批量发送单聊消息
    • 撤回/删除消息
    • 删除会话中漫游/历史消息
    • 发送单聊已读回执
    • 发送高级群已读回执
    • 查询群消息已读未读详情
    • 查询单条消息
    • 分页查询历史消息
    • 发送聊天室消息
    • 批量发送聊天室消息
    • 撤回/删除聊天室历史消息
    • 分页查询聊天室历史消息
    • 更新消息
    • 根据消息 ID 查询历史消息
    • 查询 Thread 消息
    • 添加快捷评论
    • 删除快捷评论
    • 查询快捷评论
    • 检索历史消息
    • 发送流式消息
  • 会话功能
    • 会话管理
      • 创建会话
      • 更新会话
      • 删除会话
      • 批量删除会话
      • 查询会话信息
      • 批量查询会话信息
      • 分页查询账号的所有会话列表
    • 会话未读数管理
      • 获取会话总未读数
    • 会话分组
      • 创建会话分组
      • 更新会话分组
      • 删除会话分组
      • 查询会话分组信息
      • 批量查询会话分组信息
      • 查询所有会话分组信息
  • 群组功能
    • 群成员
      • 拉人入群
      • 踢人出群
      • 主动退群
      • 更新群成员信息
      • 批量禁言群成员
      • 分页查询指定账号已加入的群组信息
    • 群组管理
      • 创建群组
      • 更新群组信息
      • 转让群主
      • 添加管理员
      • 移除管理员
      • 解散群组
      • 查询群组信息
      • 批量查询群组信息列表
      • 查询高级群在线成员列表
      • 批量查询高级群的在线成员数
      • 分页查询群成员列表
  • 聊天室功能
    • 聊天室管理
      • 创建聊天室
      • 获取聊天室地址
      • 查询聊天室信息
      • 更新聊天室信息
      • 开放/关闭聊天室
      • 聊天室禁言
      • 开启/关闭进出聊天室事件通知
      • 查询开放状态的聊天室
      • 分页查询聊天室在线成员列表
      • 查询聊天室固定成员列表
    • 聊天室成员
      • 设置聊天室成员角色
      • 更新聊天室在线成员信息
      • 禁言聊天室成员
      • 临时禁言聊天室成员
      • 查询聊天室的禁言列表
      • 拉黑聊天室成员
      • 聊天室标签禁言
      • 查询聊天室黑名单列表
      • 聊天室标签禁言
      • 修改聊天室在线成员标签
      • 查询标签下的在线成员数
      • 分页查询标签下的在线成员列表
      • 批量查询聊天室固定成员信息
      • 添加聊天室虚构用户
      • 删除聊天室虚构用户
      • 清空聊天室虚构用户
      • 查询聊天室虚构用户
    • 聊天室队列
      • 初始化聊天室队列
      • 删除聊天室队列
      • 更新聊天室队列
      • 查询聊天室队列元素
      • 从聊天室队列中取出元素
  • 广播消息管理
    • 发送广播消息
    • 删除广播消息
    • 查询广播消息
    • 分页查询广播消息
    • 发送聊天室全服广播消息
  • 系统通知管理
    • 发送自定义系统通知
      POST
    • 批量发送自定义系统通知
      POST
  • 发布订阅
    • 订阅在线状态事件
    • 查询在线状态事件订阅关系
    • 取消在线状态事件订阅
  • 翻译
    • 文本翻译
  1. 系统通知管理

批量发送自定义系统通知

POST
/im/v2/custom_notification/batch

请求参数

Header 参数
AppKey
string 
必需
默认值:
{{AppKey}}
X-custom-traceid
string 
可选
默认值:
{% mock 'uuid' %}
Nonce
string 
必需
默认值:
{{Nonce}}
CurTime
string 
必需
默认值:
{{CurTime}}
CheckSum
string 
必需
默认值:
{{CheckSum}}
Body 参数application/json
sender_id
string 
发送着
必需
发送者云信账号 ID。
content
string 
通知内容
必需
自定义系统通知的内容,由开发者自行组装的 JSON 格式字符串,长度上限 4096 位字符。
push_config
object 
推送配置
必需
推送配置
push_enabled
boolean 
是否推送
可选
该消息是否需要 APNs 推送或 Android 系统通知栏推送,默认为 true(推送)。只有该字段为 true 时,推送相关参数才会生效。
默认值:
true
push_nick_enabled
boolean 
推送是否带昵称
可选
推送文案是否需要带上昵称,默认为 true(带昵称)。
默认值:
true
push_content
string 
推送文案
可选
推送文案,长度上限 500 位字符。如果不填,则使用默认推送文案。 推送文案的显示规则如下: push_content 不为空且 push_nick_enabled = true,最终推送文案为:推送者昵称+ push_content push_content 不为空且 push_nick_enabled = false,最终推送文案为:push_content push_content 为空且 push_nick_enabled = true,最终推送文案为:推送者昵称+默认文案 push_content 为空且 push_nick_enabled = false,最终推送文案为:默认文案 其中,根据消息类型,默认文案分为以下几种: 文本消息默认文案:发来了一条消息 图片消息默认文案:发来了一张图片 语音消息默认文案:发来了一段语音 视频消息默认文案:发来了一段视频 地理位置默认文案:发来了一个地理位置 文件消息默认文案:发来了一个文件 语音聊天邀请消息默认文案:发来了语音聊天邀请 视频聊天邀请消息默认文案:发来了视频聊天邀请
<= 500 字符
push_payload
string 
推送payload
可选
推送对应的 payload,必须是 JSON 格式,长度上限 2048 位字符。详情请参见推送 payload 配置。
<= 2048 字符
push_forcepush_all
boolean 
是否强制推送
可选
该消息(群消息)是否强制推送(@操作),默认为 false。只有该字段为 true 时强制推送相关参数才会生效。
默认值:
false
push_forcepush_ids
array[string]
强推列表
可选
该消息(群消息)的强推(@操作)账号列表,格式为 JSONArray,如["account1","account2"]。若 push_forcepush_all 为 true,则该字段无效,该消息会强制推送(@操作)给群组中所有有效成员(除消息发送者)。 最多可强推 100 个用户。
push_forcepush_content
string 
强推文案
可选
强制推送的文案,仅针对强推列表 push_forcepush_ids 中的账号,长度上限 500 位字符。
<= 500 字符
sound
string 
声音文件
可选
指定的客户端本地的声音文件名,长度上限 30 位字符。
<= 30 字符
route_config
object 
抄送配置
可选
抄送配置
route_enabled
boolean 
可选
默认值:
true
route_environment
string 
可选
notification_config
object 
通知配置
可选
通知配置项,不填则采用默认值。
notification_enabled
boolean 
可选
默认值:
true
notification_extension
string 
可选
high_priority
integer 
可选
默认值:
0
high_priority_policy
integer 
可选
默认值:
0
receiver_ids
array[string]
接收者账号 ID 列表
必需
接收者账号 ID 列表,JSON 格式。最多传入 500 个云信账号。
示例
{
    "sender_id": "apifoxtest18",
    "content": "tempor nisi aliqua",
    "push_config": {
        "push_enabled": true,
        "push_nick_enabled": false,
        "push_content": "ut voluptate nulla aliquip",
        "push_payload": null,
        "push_forcepush_all": false,
        "push_forcepush_ids": [
            "30"
        ],
        "push_forcepush_content": "culpa Lorem irure dolore fugiat"
    },
    "sound": "magna ex sit velit",
    "route_config": {
        "route_enabled": false,
        "route_environment": null
    },
    "notification_config": {
        "offline_enabled": false,
        "unread_enabled": false
    },
    "receiver_ids": ["apifoxtest10","apifoxtest32"]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://open.yunxinapi.com/im/v2/custom_notification/batch' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sender_id": "apifoxtest18",
    "content": "tempor nisi aliqua",
    "push_config": {
        "push_enabled": true,
        "push_nick_enabled": false,
        "push_content": "ut voluptate nulla aliquip",
        "push_payload": null,
        "push_forcepush_all": false,
        "push_forcepush_ids": [
            "30"
        ],
        "push_forcepush_content": "culpa Lorem irure dolore fugiat"
    },
    "sound": "magna ex sit velit",
    "route_config": {
        "route_enabled": false,
        "route_environment": null
    },
    "notification_config": {
        "offline_enabled": false,
        "unread_enabled": false
    },
    "receiver_ids": ["apifoxtest10","apifoxtest32"]
}'

返回响应

🟢200成功
application/json
Body
code
integer 
必需
msg
string 
必需
data
object 
必需
success_list
array[string]
可选
发送成功的的自定义系统通知。
failed_list
array[string]
可选
示例
{
    "code": 200,
    "msg": "success",
    "data": {
        "failed_list": [
            {
                "account_id": "hkj-100",
                "error_msg": "error",
                "error_code": 102404
            }
        ],
        "success_list": [
            "hkj1"
        ]
    }
}
🟢200成功
🟢200请求参数错误
🟢200服务器错误
上一页
发送自定义系统通知
下一页
订阅在线状态事件
Built with