发送普通消息

请求参数

Header 参数

AppKey

string

必需

示例值:

Nonce

string

必需

示例值:

CurTime

string

必需

示例值:

CheckSum

string

必需

示例值:

Content-Type

string

必需

示例值:

application/x-www-form-urlencoded

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

from

string

必需

发送者accid，用户帐号，最大32字符，必须保证一个APP内唯一

示例值:

ope

string

必需

0：点对点个人消息，1：群消息（高级群），其他返回414

to

string

必需

ope==0表示accid即用户id，ope==1表示tid即群id

type

string

必需

0 表示文本消息,
1 表示图片，
2 表示语音，
3 表示视频，
4 表示地理位置信息，
6 表示文件，
10 表示提示消息，
100 自定义消息类型（特别注意，对于未对接易盾反垃圾功能的应用，该类型的消息不会提交反垃圾系统检测）

body

string

必需

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

示例值:

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

antispam

string

可选

对于对接了易盾反垃圾功能的应用，本消息是否需要指定经由易盾检测的内容（antispamCustom）。true或false, 默认false。只对消息类型为：100 自定义消息类型的消息生效。

antispamCustom

string

可选

在antispam参数为true时生效。自定义的反垃圾检测内容, JSON格式，长度限制同body字段，不能超过5000字符，要求antispamCustom格式如下：
{"type":1,"data":"custom content"}
字段说明：

1.

type: 1：文本，2：图片。

2.

data: 文本内容or图片地址。

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字符

forcepushlist

string

可选

发送群消息时的强推（@操作）用户列表，格式为JSONArray，如["accid1","accid2"]。若forcepushall为true，则forcepushlist为除发送者外的所有有效群成员

forcepushcontent

string

可选

发送群消息时，针对强推（@操作）列表forcepushlist中的用户，强制推送的内容

forcepushall

string

可选

发送群消息时，强推（@操作）列表是否为群里除发送者外的所有有效成员，true或false，默认为false

bid

string

可选

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

useYidun

string

可选

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

markRead

string

可选

可选，群消息是否需要已读业务（仅对群消息有效），0:不需要，1:需要

checkFriend

string

可选

是否为好友关系才发送消息，默认否
注：使用该参数需要先开通功能服务

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

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

返回响应

🟢200成功

application/json

Body

object {0}

示例

{}