开发者中心
视频教程知识库工单
中文
在线咨询微信咨询电话咨询

消息功能

发送普通消息

请求说明

httpPOST https://api.netease.im/nimserver/msg/sendMsg.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求中Headers的设置请参考接口概述

接口描述

给用户或者高级群发送普通消息，包括文本，图片，语音，视频和地理位置，具体消息参考下面描述

参数说明

​ ​ ​
参数类型必须说明
fromString是 发送者accid，用户帐号，最大32字符，
必须保证一个APP内唯一
opeint是 0：点对点个人消息，1：群消息（高级群），其他返回414
toString是 ope==0是表示accid即用户id，ope==1表示tid即群id
typeint是 0 表示文本消息,
1 表示图片，
2 表示语音，
3 表示视频，
4 表示地理位置信息，
6 表示文件，
10 表示提示消息，
100 自定义消息类型（特别注意，对于未对接易盾反垃圾功能的应用，该类型的消息不会提交反垃圾系统检测）
bodyString是 最大长度5000字符，JSON格式。
具体请参考： 消息格式示例
msgDescString否消息描述文本，针对非Text、Tip类型的消息有效，最大长度500字符。该描述信息可用于云端历史消息关键词检索。
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;
9. sessionUpdate: 是否将本消息更新到会话列表服务里本会话的lastmsg，默认true。
pushcontent String 否 推送文案,最长500个字符。具体参见 推送配置参数详解。
payload String 否 必须是JSON,不能超过2k字符。该参数与APNs推送的payload含义不同。具体参见 推送配置参数详解。
ext String 否 开发者扩展字段，长度限制1024字符
forcepushlist String 否 发送群消息时的强推用户列表（云信demo中用于承载被@的成员），格式为JSONArray，如["accid1","accid2"]。若forcepushall为true，则forcepushlist为除发送者外的所有有效群成员
forcepushcontent String 否 发送群消息时，针对强推列表forcepushlist中的用户，强制推送的内容
forcepushall String 否 发送群消息时，强推列表是否为群里除发送者外的所有有效成员，true或false，默认为false
bid String 否 可选，反垃圾业务ID，实现“单条消息配置对应反垃圾”，若不填则使用原来的反垃圾配置
useYidun int 否 可选，单条消息是否使用易盾反垃圾，可选值为0。
0：（在开通易盾的情况下）不使用易盾反垃圾而是使用通用反垃圾，包括自定义消息。

若不填此字段，即在默认情况下，若应用开通了易盾反垃圾功能，则使用易盾反垃圾来进行垃圾消息的判断
yidunAntiCheating String 否 可选，易盾反垃圾增强反作弊专属字段，限制json，长度限制1024字符（详见易盾反垃圾接口文档反垃圾防刷版专属字段）
markRead int 否 可选，群消息是否需要已读业务（仅对群消息有效），0:不需要，1:需要
checkFriend boolean 否 是否为好友关系才发送消息，默认否
注：使用该参数需要先开通功能服务
subType int 否 自定义消息子类型，大于0
msgSenderNoSense int 否 发送方是否无感知。0-有感知，1-无感知。若无感知，则消息发送者无该消息的多端、漫游、历史记录等。
msgReceiverNoSense int 否 接受方是否无感知。0-有感知，1-无感知。若无感知，则消息接收者者无该消息的多端、漫游、历史记录等
env String 否 所属环境，根据env可以配置不同的抄送地址

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'from=zhangsan&ope=0&to=lisi&type=0&body={"msg":"hello"}' 'https://api.netease.im/nimserver/msg/sendMsg.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
  "code":200,
  "data":{
        "msgid":1200510468189,
        "timetag": 1545635366312,//消息发送的时间戳
        "antispam":false
     }
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表

批量发送点对点普通消息

请求说明

httpPOST https://api.netease.im/nimserver/msg/sendBatchMsg.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求中Headers的设置请参考接口概述

接口描述

1.给用户发送点对点普通消息，包括文本，图片，语音，视频，地理位置和自定义消息。
2.最大限500人，只能针对个人,如果批量提供的帐号中有未注册的帐号，会提示并返回给用户。
3.此接口受频率控制，一个应用一分钟最多调用120次，超过会返回416状态码，并且被屏蔽一段时间；
具体消息参考下面描述。

参数说明

参数类型必须说明
fromAccid String是 发送者accid，用户帐号，最大32字符，
必须保证一个APP内唯一
toAccids String是 ["aaa","bbb"]（JSONArray对应的accid，如果解析出错，会报414错误），限500人
typeint是 0 表示文本消息,
1 表示图片，
2 表示语音，
3 表示视频，
4 表示地理位置信息，
6 表示文件，
10 表示提示消息，
100 自定义消息类型
bodyString是 最大长度5000字符，JSON格式。
具体请参考： 消息格式示例
msgDescString否消息描述文本，针对非Text、Tip类型的消息有效，最大长度500字符。该描述信息可用于云端历史消息关键词检索。
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;
9. sessionUpdate: 是否将本消息更新到会话列表服务里本会话的lastmsg，默认true。
pushcontent String 否 推送文案，最长500个字符。具体参见 推送配置参数详解。
payload String 否 必须是JSON,不能超过2k字符。该参数与APNs推送的payload含义不同。具体参见 推送配置参数详解。
ext String 否 开发者扩展字段，长度限制1024字符
bid String 否 可选，反垃圾业务ID，实现“单条消息配置对应反垃圾”，若不填则使用原来的反垃圾配置
useYidun int 否 可选，单条消息是否使用易盾反垃圾，可选值为0。
0：（在开通易盾的情况下）不使用易盾反垃圾而是使用通用反垃圾，包括自定义消息。

若不填此字段，即在默认情况下，若应用开通了易盾反垃圾功能，则使用易盾反垃圾来进行垃圾消息的判断
yidunAntiCheating String 否 可选，易盾反垃圾增强反作弊专属字段，限制json，长度限制1024字符（详见易盾反垃圾接口文档反垃圾防刷版专属字段）
returnMsgid Boolean 否 是否需要返回消息ID
false：不返回消息ID（默认值）
true：返回消息ID（toAccids包含的账号数量不可以超过100个）
env String 否 所属环境，根据env可以配置不同的抄送地址

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'fromAccid=zhangsan&toAccids=["aaa","bbb"]&type=0&body={"msg":"hello"}' 'https://api.netease.im/nimserver/msg/sendBatchMsg.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
  "code":200,
  "msgids":{"aaa":1234,"bbb":1235}//消息接受者对应的消息ID，returnMsgId参数为true时才返回
  "timetag": 1545635366312, //消息发送的时间戳
  "unregister":"["a","b"...]" //未注册的帐号
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表

消息格式示例

1.文本消息(type = 0)

{
  "msg":"哈哈哈"//消息内容
}

2. 图片消息(type = 1)

{
  "name":"图片发送于2015-05-07 13:59",   //图片name
  "md5":"9894907e4ad9de4678091277509361f7",	//图片文件md5
  "url":"http://nimtest.nos.netease.com/cbc500e8-e19c-4b0f-834b-c32d4dc1075e",	//生成的url
  "ext":"jpg",	//图片后缀
  "w":6814,	//宽
  "h":2332,	//高
  "size":388245	//图片大小
}

3. 语音消息(type = 2)

{
  "dur":4551,		//语音持续时长ms
  "md5":"87b94a090dec5c58f242b7132a530a01",	//语音文件的md5值
  "url":"http://nimtest.nos.netease.com/a2583322-413d-4653-9a70-9cabdfc7f5f9",	//生成的url
  "ext":"aac",		//语音消息格式，只能是aac格式
  "size":16420		//语音文件大小
}

4. 视频消息(type = 3)

{
  "dur":8003,		//视频持续时长ms
  "md5":"da2cef3e5663ee9c3547ef5d127f7e3e",	//视频文件的md5值
  "url":"http://nimtest.nos.netease.com/21f34447-e9ac-4871-91ad-d9f03af20412",	//生成的url
  "w":360,	//宽
  "h":480,	//高
  "ext":"mp4",	//视频格式
  "size":16420	//视频文件大小
}

5. 发送地理位置消息(type = 4)

{
  "title":"中国 浙江省 杭州市 网商路 599号",	//地理位置title
  "lng":120.1908686708565,		// 经度
  "lat":30.18704515647036			// 纬度
}

6. 发送文件消息(type = 6)

{
  "name":"BlizzardReg.ttf",	//文件名
  "md5":"79d62a35fa3d34c367b20c66afc2a500", //文件MD5
  "url":"http://nimtest.nos.netease.com/08c9859d-183f-4daa-9904-d6cacb51c95b", //文件URL
  "ext":"ttf",	//文件后缀类型
  "size":91680	//大小
}

7. 发送提示消息(type = 10)

{
  "msg":"您收到一份礼物"
}

8. 发送第三方自定义消息(type = 100)

//第三方定义的body体，json格式
{
  "myKey":myValue	
}

发送自定义系统通知

请求说明

httpPOST https://api.netease.im/nimserver/msg/sendAttachMsg.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求中Headers的设置请参考接口概述

接口描述

1.自定义系统通知区别于普通消息，方便开发者进行业务逻辑的通知；
2.目前支持两种类型：点对点类型和群类型（仅限高级群），根据msgType有所区别。

应用场景：如某个用户给另一个用户发送好友请求信息等，具体attach为请求消息体，第三方可以自行扩展，建议是json格式

参数说明

参数类型必须说明
fromString是 发送者accid，用户帐号，最大32字符，APP内唯一
msgtypeint是 0：点对点自定义通知，1：群消息自定义通知，其他返回414
toString是 msgtype==0是表示accid即用户id，msgtype==1表示tid即群id
attachString是 自定义通知内容，第三方组装的字符串，建议是JSON串，最大长度4096字符
pushcontentString否 推送文案，最长500个字符。具体参见 推送配置参数详解。
payloadString否 必须是JSON,不能超过2k字符。该参数与APNs推送的payload含义不同。具体参见 推送配置参数详解。
soundString否 如果有指定推送，此属性指定为客户端本地的声音文件名，长度不要超过30个字符，如果不指定，会使用默认声音
saveint否 1表示只发在线，2表示会存离线，其他会报414错误。默认会存离线
option String否 发消息时特殊指定的行为选项,Json格式，可用于指定消息计数等特殊行为;option中字段不填时表示默认值。
option示例：
{"badge":false,"needPushNick":false,"route":false}
字段说明：
1. badge:该消息是否需要计入到未读计数中，默认true;
2. needPushNick: 推送文案是否需要带上昵称，不设置该参数时默认false(ps:注意与sendMsg.action接口有别);
3. route: 该消息是否需要抄送第三方；默认true (需要app开通消息抄送功能)
isForcePush String 否 发自定义通知时，是否强制推送
forcePushContent String 否 发自定义通知时，强制推送文案，最长500个字符
forcePushAll String 否 发群自定义通知时，强推列表是否为群里除发送者外的所有有效成员
forcePushList String 否 发群自定义通知时，强推列表，格式为JSONArray，如"accid1","accid2"
env String 否 所属环境，根据env可以配置不同的抄送地址

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'from=zhangsan&msgtype=0&to=lisi&attach={"myattach":"test"}' 'https://api.netease.im/nimserver/msg/sendAttachMsg.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
  "code":200
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表

批量发送点对点自定义系统通知

请求说明

httpPOST https://api.netease.im/nimserver/msg/sendBatchAttachMsg.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求中Headers的设置请参考接口概述

接口描述

1.系统通知区别于普通消息，应用接收到直接交给上层处理，客户端可不做展示；
2.目前支持类型：点对点类型；
3.最大限500人，只能针对个人,如果批量提供的帐号中有未注册的帐号，会提示并返回给用户；
4.此接口受频率控制，一个应用一分钟最多调用120次，超过会返回416状态码，并且被屏蔽一段时间；

应用场景：如某个用户给另一个用户发送好友请求信息等，具体attach为请求消息体，第三方可以自行扩展，建议是json格式

参数说明

参数类型必须说明
fromAccid String是 发送者accid，用户帐号，最大32字符，APP内唯一
toAccids String是 ["aaa","bbb"]（JSONArray对应的accid，如果解析出错，会报414错误），最大限500人
attachString是 自定义通知内容，第三方组装的字符串，建议是JSON串，最大长度4096字符
pushcontentString否 推送文案，最长500个字符。具体参见 推送配置参数详解。
payloadString否 必须是JSON,不能超过2k字符。该参数与APNs推送的payload含义不同。具体参见 推送配置参数详解。
soundString否 如果有指定推送，此属性指定为客户端本地的声音文件名，长度不要超过30个字符，如果不指定，会使用默认声音
saveint否 1表示只发在线，2表示会存离线，其他会报414错误。默认会存离线
option String否 发消息时特殊指定的行为选项,Json格式，可用于指定消息计数等特殊行为;option中字段不填时表示默认值。
option示例：
{"badge":false,"needPushNick":false,"route":false}
字段说明：
1. badge:该消息是否需要计入到未读计数中，默认true;
2. needPushNick: 推送文案是否需要带上昵称，不设置该参数时默认false(ps:注意与sendBatchMsg.action接口有别)。
3. route: 该消息是否需要抄送第三方；默认true (需要app开通消息抄送功能)
isForcePush String 否 发自定义通知时，是否强制推送
forcePushContent String 否 发自定义通知时，强制推送文案，最长500个字符
env String 否 所属环境，根据env可以配置不同的抄送地址

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'fromAccid=zhangsan&toAccids=["aaa","bbb"]&attach={"myattach":"test"}' 'https://api.netease.im/nimserver/msg/sendBatchAttachMsg.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
  "code":200,
  "unregister":"["a","b"...]" //未注册的帐号
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表

文件上传

请求说明

httpPOST https://api.netease.im/nimserver/msg/upload.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求中Headers的设置请参考接口概述

接口描述

文件上传，字符流需要base64编码，最大15M。

参数说明

参数类型必须说明
contentString是 字符流base64串(Base64.encode(bytes)) ，最大15M的字符流
typeString否 上传文件类型
ishttpsString否 返回的url是否需要为https的url，true或false，默认false
expireSecInteger否 文件过期时长，单位：秒，必须大于等于86400
tagString否 文件的应用场景，不超过32个字符

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'content=gwettwgsgssgs323f' 'https://api.netease.im/nimserver/msg/upload.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
  "code":200,
  "url":"xxx"
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表

文件上传（multipart方式）

请求说明

httpPOST https://api.netease.im/nimserver/msg/fileUpload.action HTTP/1.1
Content-Type:multipart/form-data;charset=utf-8

请求中Headers的设置请参考接口概述

接口描述

文件上传，最大15M

参数说明

参数类型必须说明
contentMultipart是 最大15M的字符流
typeString否 上传文件类型
ishttpsString否 返回的url是否需要为https的url，true或false，默认false
expireSecInteger否 文件过期时长，单位：秒，必须大于等于86400
tagString否 文件的应用场景，不超过32个字符

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: multipart/form-data" -d 'content=gwettwgsgssgs323f' 'https://api.netease.im/nimserver/msg/fileUpload.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
  "code":200,
  "url":"xxx"
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表

上传NOS文件清理任务

请求说明

httpPOST https://api.netease.im/nimserver/job/nos/del.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求中Headers的设置请参考接口概述

接口描述

上传NOS文件清理任务，按时间范围和文件类下、场景清理符合条件的文件

每天提交的任务数量有限制，请合理规划

关于startTime与endTime请注意：

  • startTime必须小于endTime且大于0，endTime和startTime差值在1天以上，7天以内。
  • endTime必须早于今天（即只可以清理今天以前的文件）。

参数说明

参数类型必须说明
startTimeLong是 被清理文件的开始时间(毫秒级)
endTimeLong是 被清理文件的结束时间(毫秒级)
contentTypeString否 被清理的文件类型，文件类型包含contentType则被清理 如原始文件类型为"image/png"，contentType参数为"image",则满足被清理条件
tagString否 被清理文件的应用场景，完全相同才被清理 如上传文件时知道场景为"usericon",tag参数为"usericon"，则满足被清理条件

curl请求示例

curlcurl -X POST -H "CheckSum: 32dc17d0190f37037abc9feb749bbf049c9367e7" -H "AppKey: fe416640c8e8a72734219e1847ad2547" -H "Nonce: 1" -H "CurTime: 1451200147" -H "Cache-Control: no-cache" -H "Postman-Token: a503b469-ee33-2c2e-8fb1-87b1fdf9f8f4" -H "Content-Type: application/x-www-form-urlencoded" -d 'startTime=1533988669286&endTime=1534420669286&contentType=image&tag=usericon' "http://223.252.220.223/nimserver/job/nos/del.action"

返回说明

http 响应:json

json"Content‐type":"application/json;charset=utf‐8"
{
  "code": 200,
  "data":{
    "taskid":"1024030f3841440daf2af73672792f47"
  }
}

主要的返回码

200、403、414、416、500

具体请参考code状态表

消息撤回

请求说明

httpPOST https://api.netease.im/nimserver/msg/recall.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求中Headers的设置请参考接口概述

接口描述

消息撤回接口，可以撤回一定时间内的点对点与群消息

参数说明

参数类型必须说明
deleteMsgid String 是 要撤回消息的msgid
timetag long是 要撤回消息的创建时间
type int是 7:表示点对点消息撤回，8:表示群消息撤回，其它为参数错误
from String 是 发消息的accid
to String是 如果点对点消息，为接收消息的accid,如果群消息，为对应群的tid
msg String否 可以带上对应的描述
ignoreTime String否 1表示绕过撤回时间检测，其它为非法参数，最多撤回近30天内的消息。如果需要撤回时间检测，不填即可。
pushcontentString否推送文案，android以此为推送显示文案；ios若未填写payload，显示文案以pushcontent为准。超过500字符后，会对文本进行截断。
payloadString否推送对应的payload,必须是JSON,不超过2K字符
envString否所属环境，根据env可以配置不同的抄送地址
attachString否扩展字段，最大5000字符

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'deleteMsgid=10386192&timetag=1481528155741&type=7&from=t1&to=t4&msg=这是一条撤回消息'  'https://api.netease.im/nimserver/msg/recall.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
  "code":200
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表

发送广播消息

请求说明

httpPOST https://api.netease.im/nimserver/msg/broadcastMsg.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求中Headers的设置请参考接口概述

接口描述

1、使用广播消息前，请务必阅读注意事项，详见关于广播消息。
2、广播消息，可以对应用内的所有用户发送广播消息，广播消息目前暂不支持第三方推送（APNS、小米、华为等）；
3、广播消息支持离线存储，并可以自定义设置离线存储的有效期，最多保留最近100条离线广播消息；
4、此接口受频率控制，一个应用一分钟最多调用10次，一天最多调用1000次，超过会返回416状态码；
5、该功能目前需申请开通，详情可咨询您的客户经理。

参数说明

参数类型必须说明
body String 是 广播消息内容，最大4096字符
from String否 发送者accid, 用户帐号，最大长度32字符，必须保证一个APP内唯一
isOffline String否 是否存离线，true或false，默认false
ttl int否 存离线状态下的有效期，单位小时，默认7天
targetOs String否 目标客户端，默认所有客户端，jsonArray，格式：["ios","aos","pc","web","mac"]

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'from=zhangsan&body=abc' 'https://api.netease.im/nimserver/msg/broadcastMsg.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "msg": {
        "expireTime": 1505502793520,
        "body": "abc",
        "createTime": 1505466793520,
        "isOffline": true,
        "broadcastId": 48174937359009,
        "targetOs": [
            "ios",
            "pc",
            "aos"
        ]
    }
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表

单向撤回消息

请求说明

httpPOST https://api.netease.im/nimserver/msg/delMsgOneWay.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求中Headers的设置请参考接口概述

接口描述

1、可以单向撤回点对点消息和群消息，撤回之后，消息接收者会收到一条单向撤回的通知，并删除对应的离线消息、漫游消息、历史消息
2、撤回之后，消息发送者无感知，可以正常使用漫游消息、历史消息
3、客户端要求至少v7.2.0版本，否则无法收到撤回通知（但是历史消息依然会单向删除）

参数说明

参数类型必须说明
deleteMsgid String 是 要撤回消息的msgid
timetag long是 要撤回消息的创建时间
type int是 13:表示点对点消息撤回，14:表示群消息撤回，其它为参数错误
from String 是 发消息的accid
to String是 如果点对点消息，为接收消息的accid,如果群消息，为对应群的tid
msg String否 可以带上对应的描述

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'from=zhangsan&body=abc' 'https://api.netease.im/nimserver/msg/broadcastMsg.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
    "code": 200
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表

删除会话漫游

请求说明

httpPOST https://api.netease.im/nimserver/msg/delRoamSession.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求中Headers的设置请参考接口概述

接口描述

按会话删除漫游消息，可以删除p2p/群会话

参数说明

参数类型必须说明
type int 是 会话类型，1-p2p会话，2-群会话，其他返回414
from String是 发送者accid, 用户帐号，最大长度32字节
to String是 type=1表示对端accid，type=2表示tid

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'type=2&from=cs4&to=2775725369' 'https://api.netease.im/nimserver/msg/delRoamSession.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
    "code": 200
}

主要的返回码

200、403、414、416、500

具体请参考code状态表

在线咨询微信咨询电话咨询
此文档是否对你有帮助？
有帮助
去反馈
  • 消息功能
  • 发送普通消息
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 批量发送点对点普通消息
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 消息格式示例
  • 1.文本消息(type = 0)
  • 2. 图片消息(type = 1)
  • 3. 语音消息(type = 2)
  • 4. 视频消息(type = 3)
  • 5. 发送地理位置消息(type = 4)
  • 6. 发送文件消息(type = 6)
  • 7. 发送提示消息(type = 10)
  • 8. 发送第三方自定义消息(type = 100)
  • 发送自定义系统通知
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 批量发送点对点自定义系统通知
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 文件上传
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 文件上传（multipart方式）
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 上传NOS文件清理任务
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 消息撤回
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 发送广播消息
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 单向撤回消息
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 删除会话漫游
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
© 1997-2024 网易公司增值电信业务许可证B1-20180288浙B1.B2-20090185浙公网安备浙公网安备 33010802002218号浙ICP备17006647号-3工业和信息化部备案管理系统网站隐私政策