跳转至

消息撤回

单群聊消息撤回

支持撤回单聊、群聊中用户发送的消息,如开通了单群聊消息云存储功能,则云存储中的消息数据也将被删除。

提示

撤回指定消息后,该条消息将被删除,同时生成一条撤回的小灰条消息 RC:RcNtf。在 IMKit SDK 中已实现了消息撤回的处理机制,会话中将展示撤回的小灰条提示消息。IMLib SDK 可根据消息类型自行处理展示。

方法名:/message/recall

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/message/recall.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
fromUserId String 消息发送人用户 Id。(必传)
conversationType Int 会话类型,二人会话是 1 、群组会话是 3 。(必传)
targetId String 目标 Id,根据不同的 ConversationType,可能是用户 Id、群组 Id。(必传)
messageUID String 消息唯一标识,可通过服务端实时消息路由获取,对应名称为 msgUID。(必传)
sentTime Long 消息发送时间,可通过服务端实时消息路由获取,对应名称为 msgTimestamp。(必传)
isAdmin Int 是否为管理员,默认为 0,设为 1 时,IMKit 收到此条消息后,小灰条默认显示为“管理员 撤加了一条消息”。(非必传)
isDelete Int 是否删除消息,默认为 0 撤回该条消息同时生成一条小灰条提示消息,为 1 时撤回此条消息后,不生成小灰条提示消息。(非必传)
extra String 扩展信息,可以放置任意的数据内容。(非必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml>
  <code>200</code>
</xml>

返回值请参考 API 方法返回值说明

示例

HTTP 请求:

POST /message/recall.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

fromUserId=fDR2cVpxxR5zSMUNh3yAwh&targetId=MersNRhaKwJkRV9mJR5JXY&conversationType=1&messageUID=5FGT-7VA9-G4DD-4V5P&sentTime=1507778882124

HTTP 响应:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}

广播消息撤回

使用广播消息接口 message/broadcast 发送撤回消息,支持将已发送的广播消息撤回,撤回广播消息也占用广播消息每天的使用配额。

撤回指定消息后,该条消息将被删除,同时生成一条撤回的小灰条消息 RC:RcNtf。在 IMKit SDK 中已实现了消息撤回的处理机制,会话中将展示撤回的小灰条提示消息。IMLib SDK 可根据消息类型自行处理展示。

方法名:/message/broadcast

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/message/broadcast.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
fromUserId String 发送人用户 Id。(必传)
objectName String 消息类型,参考融云消息类型表.消息标志;可自定义消息类型,长度不超过 32 个字符,您在自定义消息时需要注意,不要以 "RC:" 开头,以避免与融云系统内置消息的 ObjectName 重名。(必传)
content String 发送撤回消息内容,(必传)

content 撤回消息结构说明:

名称 类型 说明
messageUId String 消息唯一标识,可通过服务端实时消息路由获取,对应名称为 msgUID。(必传)
conversationType String 系统会话默认传 6 即可。(必传)
isAdmin Int 是否为管理员,默认为 0;设为 1 时 IMKit SDK 收到此条消息后,小灰条默认显示为“管理员 撤加了一条消息”。(非必传)
isDelete Int 是否删除消息,默认为 0 撤回该条消息同时生成一条小灰条提示消息,为 1 时撤回此条消息后,不生成小灰条提示消息。(非必传)
sentTime Long 消息发送时间,可通过服务端实时消息路由获取,对应名称为 msgTimestamp。(必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml>
  <code>200</code>
</xml>

示例

HTTP 请求:

POST /message/recall.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

fromUserId=1&objectName=RC:RcCmd&content={"messageUId":"BC52-ESJ0-022O-001H","isAdmin":0,"isDelete":1,"conversationType":6,"sentTime":1564049525120}

HTTP 响应:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}