发送自定义系统通知
POST
/im/v2/custom_notification请求参数
发送者云信账号 ID。
自定义系统通知类型。1:单聊系统通知;2:高级群系统通知;3:超大群系统通知。
系统通知接收者。type =1 时,该参数接收者账号 ID;type = 2 或 3 时,该参数为接收的群 ID(创建群组时服务器生成并返回的 ID)。
自定义系统通知的内容,由开发者自行组装的 JSON 格式字符串,长度上限 4096 位字符。
推送配置
该消息是否需要 APNs 推送或 Android 系统通知栏推送,默认为 true(推送)。只有该字段为 true 时,推送相关参数才会生效。
推送文案是否需要带上昵称,默认为 true(带昵称)。
推送文案,长度上限 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,最终推送文案为:默认文案 其中,根据消息类型,默认文案分为以下几种: 文本消息默认文案:发来了一条消息 图片消息默认文案:发来了一张图片 语音消息默认文案:发来了一段语音 视频消息默认文案:发来了一段视频 地理位置默认文案:发来了一个地理位置 文件消息默认文案:发来了一个文件 语音聊天邀请消息默认文案:发来了语音聊天邀请 视频聊天邀请消息默认文案:发来了视频聊天邀请
推送对应的 payload,必须是 JSON 格式,长度上限 2048 位字符。详情请参见推送 payload 配置。
该消息(群消息)是否强制推送(@操作),默认为 false。只有该字段为 true 时强制推送相关参数才会生效。
该消息(群消息)的强推(@操作)账号列表,格式为 JSONArray,如["account1","account2"]。若 push_forcepush_all 为 true,则该字段无效,该消息会强制推送(@操作)给群组中所有有效成员(除消息发送者)。 最多可强推 100 个用户。
强制推送的文案,仅针对强推列表 push_forcepush_ids 中的账号,长度上限 500 位字符。
指定的客户端本地的声音文件名,长度上限 30 位字符。
抄送配置
该消息是否需要抄送至指定的应用服务器(需要为应用开通消息抄送功能),默认为 true(抄送)。
抄送相关配置项。
通知配置项,不填则采用默认值。
是否需要存离线消息,默认为 true(存离线)。
是否计入未读数,默认为 true(计入)。
{
"sender_id": "apifoxtest33",
"type": 1,
"receiver_id": "apifoxtest32",
"content": "Lorem irure cupidatat deserunt",
"push_config": {
"push_enabled": false,
"push_nick_enabled": true,
"push_content": "nulla qui voluptate",
"push_payload": null,
"push_forcepush_all": true,
"push_forcepush_ids": [
"56"
],
"push_forcepush_content": "pariatur eiusmod anim aliqua"
},
"sound": "in ",
"route_config": {
"route_enabled": false,
"route_environment": "tempor anim eiusmod officia"
},
"notification_config": {
"offline_enabled": false,
"unread_enabled": true
}
}
示例代码
返回响应
{
"code": 200,
"msg": "success",
"data": {}
}