批量发送点对点普通消息

请求参数

Header 参数

AppKey

string

必需

示例值:

Nonce

string

必需

示例值:

CurTime

string

必需

示例值:

CheckSum

string

必需

示例值:

Content-Type

string

必需

示例值:

application/x-www-form-urlencoded

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

fromAccid

string

必需

示例值:

toAccids

string

必需

["aaa","bbb"]（JSONArray对应的accid，如果解析出错，会报414错误），限500人

type

string

必需

0 表示文本消息,
1 表示图片，
2 表示语音，
3 表示视频，
4 表示地理位置信息，
6 表示文件，
10 表示提示消息，
100 自定义消息类型

body

string

必需

最大长度5000字符，JSON格式。

示例值:

{"msg":"测试信息"}

option

string

可选

发消息时特殊指定的行为选项,Json格式，可用于指定消息的漫游，存云端历史，发送方多端同步，推送，消息抄送等特殊行为;option中字段不填时表示默认值 option示例:
{"push":false,"roam":true,"history":false,"sendersync":true,"route":false,"badge":false,"needPushNick":true}
字段说明：

1.

roam: 该消息是否需要漫游，默认true（需要app开通漫游消息功能）；

2.

history: 该消息是否存云端历史，默认true；

3.

sendersync: 该消息是否需要发送方多端同步，默认true；

4.

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

5.

route: 该消息是否需要抄送第三方；默认true (需要app开通消息抄送功能);

6.

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

7.

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

8.

persistent: 是否需要存离线消息，不设置该参数时默认true。

pushcontent

string

可选

推送文案，android以此为推送显示文案；ios若未填写payload，显示文案以pushcontent为准。超过500字符后，会对文本进行截断。

payload

string

可选

ios 推送对应的payload,必须是JSON,不能超过2k字符

ext

string

可选

开发者扩展字段，长度限制1024字符

bid

string

可选

可选，反垃圾业务ID，实现“单条消息配置对应反垃圾”，若不填则使用原来的反垃圾配置

useYidun

string

可选

可选，单条消息是否使用易盾反垃圾，可选值为0。
0：（在开通易盾的情况下）不使用易盾反垃圾而是使用通用反垃圾，包括自定义消息。
若不填此字段，即在默认情况下，若应用开通了易盾反垃圾功能，则使用易盾反垃圾来进行垃圾消息的判断

returnMsgid

string

可选

是否需要返回消息ID
false：不返回消息ID（默认值）
true：返回消息ID（toAccids包含的账号数量不可以超过100个）

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/nimserver/msg/sendBatchMsg.action' \
--header 'AppKey: {{AppKey}}' \
--header 'Nonce: {{Nonce}}' \
--header 'CurTime: {{CurTime}}' \
--header 'CheckSum: {{CheckSum}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'fromAccid={{imaccid}}' \
--data-urlencode 'toAccids=' \
--data-urlencode 'type=' \
--data-urlencode 'body={"msg":"测试信息"}'

返回响应

🟢200成功

application/json

Body

object {0}

示例

{}