发送圈组自定义系统通知

请求参数

Header 参数

AppKey

string

必需

示例值:

Nonce

string

必需

示例值:

CurTime

string

必需

示例值:

CheckSum

string

必需

示例值:

Content-Type

string

必需

示例值:

application/x-www-form-urlencoded

Body 参数application/x-www-form-urlencoded

toType

string

必需

1表示发给server
2表示发给channel
3表示发给server下的某些账号
4表示发给channel下的某些账号

serverId

string

服务器唯一标识

必需

channelId

string

频道唯一标识

必需

from

string

必需

用户帐号，通知发送者

toAccids

string

必需

通知接收者，JSONArray格式，最多100个账号

body

string

必需

通知内容，最大5000字符

attach

string

必需

消息附件，最大5000字符

ext

string

必需

扩展字段，最大1024字符

msgIdClient

string

客户端消息id

必需

pushContent

string

必需

推送文案,最长500个字符。具体参见推送配置参数详解。

pushPayload

string

必需

必须是JSON,不能超过2k字符。该参数与APNs推送的payload含义不同。具体参见推送配置参数详解。

option

string

必需

消息时特殊指定的行为选项,JSON格式，可用于指定消息的存离线，推送等特殊行为;option中字段不填时表示默认值，option示例:

{"push":false,"persist":false,"badge":false,"needPushNick":true}
字段说明：

1.

persist: 该消息是否存离线，只有是发给某些账号的通知支持存离线，默认false；

2.

push: 该消息是否需要APNS推送或安卓系统通知栏推送，默认true；

3.

badge:该消息是否需要计入到未读计数中，默认true;

4.

needPushNick: 推送文案是否需要带上昵称，不设置该参数时默认true;

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/nimserver/qchat/sendAttachMsg.action' \
--header 'AppKey: {{AppKey}}' \
--header 'Nonce: {{Nonce}}' \
--header 'CurTime: {{CurTime}}' \
--header 'CheckSum: {{CheckSum}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'toType=' \
--data-urlencode 'serverId=' \
--data-urlencode 'channelId=' \
--data-urlencode 'from=' \
--data-urlencode 'toAccids=' \
--data-urlencode 'body=' \
--data-urlencode 'attach=' \
--data-urlencode 'ext=' \
--data-urlencode 'msgIdClient=' \
--data-urlencode 'pushContent=' \
--data-urlencode 'pushPayload=' \
--data-urlencode 'option='

返回响应

🟢200成功

application/json

Body

object {0}

示例

{}