logo
即时通讯
机器人
ZIM Audio
当前页

EditC2cMsgBody

POST

https://zim-api.zego.im/

ZIM 服务端支持开发者编辑已发送的单聊或群聊消息。

编辑消息成功后,会触发 消息发送后回调。同时消息接收用户可以通过以下 ZIM SDK 回调接口,接收消息已编辑通知。

iOSAndroidmacOSWindows
messageEditedonMessageEditedmessageEditedonMessageEdited
Web小程序FlutterReact Native
messageEditedmessageEditedonMessageEditedmessageEdited
uni-app | uni-app xHarmonyOS
messageEditedmessageEdited
说明

单次调用仅可每次修改一个会话的一条消息。
默认仅支持 24 小时内发送的消息,如需编辑更早的历史消息,请联系 ZEGO 技术支持配置。

说明
调用频率限制:20 次/秒。

Request

Query Parameters

    Action string必填

    可选值: [EditC2cMsgBody, EditGroupMsgBody]

    接口原型参数

    https://zim-api.zego.im/?Action=EditC2cMsgBody 或 https://zim-api.zego.im/?Action=EditGroupMsgBody

    AppId uint32必填

    💡公共参数。应用 Id,由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。

    SignatureNonce string必填

    💡公共参数。16 位 16 进制随机字符串(8 字节随机数的 hex 编码)。生成算法可参考 签名示例

    Timestamp int64必填

    💡公共参数。当前 Unix 时间戳,单位为秒。生成算法可参考 签名示例,最多允许 10 分钟的误差。

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

    💡公共参数。签名版本号。

    Signature string必填

    💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。

Body

required
    FromUserId string必填

    可选值: <= 32 characters

    消息编辑用户 ID。

    说明

    编辑群聊消息时,此用户需为目标群组成员。

    SenderId string必填

    可选值: <= 32 characters

    消息发送者 ID。

    • 编辑单聊消息时,此处必填。
    • 编辑群聊消息时,此处选填。
    ConvId string必填

    可选值: <= 32 characters

    会话 ID。

    • 编辑单聊消息时,此处填入另一参与用户的 userID。
    • 编辑群聊消息时,此处填入目标群组的 groupID。
    MsgType number必填

    消息类型。支持以下值:

    • 1:文本。
    • 10:组合。
    • 200:自定义。
    ConvMsgSeq number必填

    消息 Seq。获取方式:

    • 若需要编辑由客户端发出的消息,通过 消息发送后回调 获取 MsgSeq。
    • 若需要编辑由 服务端 API SendPeerMessage 发出的单聊消息,通过接口响应数据获取 MsgSeq。
    • 若需要编辑由 服务端 API SendGroupMessage 发出的群聊消息,通过接口响应数据获取 MsgSeq。
    EditType number必填

    编辑类型。支持以下值:

    • 1:EM_MSG(编辑消息的内容),即修改 MessageBody 中的 Message 字段,此时,Message 不能为空。
    • 2:EM_PAYLOAD(编辑消息的扩展内容),即修改 MessageBody 中的 ExtendedData 字段。此时,ExtendedData 可以为空
    • 4:EM_AT(编辑消息的提醒属性),即修改 AtListInfo 或 IsAtAll。此时,AtListInfo 和 IsAtAll 都可以为空。
    • 8:EM_AT_ALL(编辑是否提醒全部用户),即修改 IsAtAll。
    • 16:EM_SUBMSGTYPE(编辑自定义消息的类型),即修改 subMsgType。此时需要 MsgType 为 200。

    您可以将以上任意值做位运算,表示同时编辑消息的多种属性,如:3:同时选择 EM_MSG 和 EM_PAYLOAD,修改 MessageBody 中的 Message 和 ExtendedData 字段。

    MessageBody object

    当 EditType 包含 EM_MSG 或 EM_PAYLOAD 时,必填。 此参数结构请参考 MessageBody 说明 中文本消息、组合消息和自定义消息中 Message、ExtendedData 字段说明。

    AtListInfo object
    被提醒用户列表。当 EditType 包含 EM_AT 时,必填。
    AtList string[]

    At列表,用户id,可以为空

    IsAtAll boolean

    是否全部用户都被提醒。当 EditType 包含 EM_AT_ALL 时,必填。

    SubMsgType number

    自定义消息的类型,由您定义,取值范围为 [0, 200]。当 EditType 包含 EM_SUBMSGTYPE 时,必填。

Responses

OK
Schema
    Code number

    返回码。

    以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码

    返回码说明处理建议
    660000002输入参数错误。请检查参数。
    661000001已超过可编辑时间。如需编辑更早的历史消息,请联系 ZEGO 技术支持。
    661000005编辑失败。请联系 ZEGO 技术支持。
    Message string

    操作结果描述。

    RequestId string

    请求 ID。

    StateMsgSeq number

    消息状态 Seq。

    EditMsgSeq number

    消息编辑 Seq。

    LatestEditTime number

    最近一次消息编辑的 Unix 时间戳,单位为秒(s)。

上一篇

全员推送

下一篇

撤回单聊消息

当前页

返回到顶部