删除超级群消息扩展
根据消息 ID 删除指定消息的扩展信息,一次可删除多个扩展 KV 键值对。
超级群消息扩展功能可用于为原始消息增加状态标识(扩展数据为 KV 键值对),提供添加、删除、查询扩展信息的接口。
请求方法
POST: https://数据中心域名/ultragroup/message/expansion/delete.json
频率限制: 每秒钟限 100 次
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded
,支持以下 HTTP 表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
msgUID | String | 是 | 消息唯一标识 ID,可通过全量消息路由功能获取。详见全量消息路由。 |
userId | String | 是 | 操作者用户 ID,即需要为指定消息(msgUID )删除扩展信息的用户 ID。 |
busChannel | String | 否 | 频道 Id 字段。 |
groupId | String | 是 | 超级群频道 ID。具体使用要求如下:
channelId 。 |
extraKey | String | 是 | 需要删除的扩展信息的 Key 值,一次最多可以删除 100 个扩展信息 |
请求示例
POST /ultragroup/message/expansion/delete.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Timestamp: 1585127132438
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
msgUID=BRGM-DEN2-01E4-BN66&userId=tjw3zbMrU&groupId=WNYZbMqpH&busChannel=&extraKey=%5B%2211111%22%5D
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | 返回码,200 为正常。 |
返回结果示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}