批量发送自定义系统通知

请求参数

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

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（抄送）。

默认值:

true

route_environment

string

抄送环境

可选

抄送相关配置项。

notification_config

object

通知配置

可选

通知配置项，不填则采用默认值。

offline_enabled

boolean

是否存离线消息

可选

是否需要存离线消息，默认为 true（存离线）。

默认值:

true

unread_enabled

boolean

是否计入未读数

可选

是否计入未读数，默认为 true（计入）。

默认值:

true

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢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服务器错误