调用RecallMessage撤回一条消息。

收到过该条消息的账号会收到撤回指令,支持普通撤回和静默撤回,撤回时间默认24小时,支持个性化配置。

  • 普通撤回:用户会话视图上的最后一条消息是撤回的那条消息。
  • 静默撤回:用户会话视图上的最后一条消息是被撤回的上一条消息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
AppId String apitest

App ID。IMPaaS租户的ID。

RequestParams Object

消息撤回请求体。

AppUid String 950000010

操作者用户ID。

AppCid String 28017165705

会话ID。

MsgId String 28017165705.center_daily

消息ID。

Type Integer 0

撤回显示类型。

  • 0:静默撤回,不显示撤回信息。
  • 1:普通撤回,显示撤回信息。

默认为0

OperatorType Integer 0

操作者类型。

  • 0:发送者。
  • 1:群主。
  • 2:系统。
  • 3:安全合规。
  • 101:业务自定义类型。

默认为0

Extensions Map

扩展字段。撤回成功后该字段会透传给消息的所有接收者。

String {"k1":"v1"}

扩展字段内容。

返回数据

名称 类型 示例值 描述
RequestId String C02635EE-C867-4CC0-9DE0-E4497378F720

请求ID。

Code String User.xxx

错误码。

Message String System Error

错误信息。

示例

请求示例

http(s)://live-interaction.aliyuncs.com/?AppId=apitest
&RequestParams={"AppUid":"950000010","AppCid":"28017165705","MsgId":"28017165705.center_daily","Type":0,"OperatorType":0,"Extensions":{"key":"{\"k1\":\"v1\"}"}}
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<RequestId>C02635EE-C867-4CC0-9DE0-E4497378F720</RequestId>
<Code>User.xxx</Code>
<Message>System Error</Message>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "C02635EE-C867-4CC0-9DE0-E4497378F720",
  "Code" : "User.xxx",
  "Message" : "System Error"
}

错误码

访问错误中心查看更多错误码。