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

GroupDeliveryReceipt

2026-07-24
POST

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

通过该接口可以给某个用户设置群聊消息的已送达回执。

服务端调用此接口可以代替消息接收方(群成员)上报送达状态。调用成功后,消息发送方会收到对应群消息的送达回执推送。

说明
FromUserId 为接收方(操作者,须为群成员),GroupId 为目标群 ID。

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

Request

Query Parameters

    Action string必填

    可选值: [GroupDeliveryReceipt]

    接口原型参数

    https://zim-api.zego.im/?Action=GroupDeliveryReceipt

    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必填

    操作者(消息接收方),需要是已注册状态且为群成员。

    GroupId string必填

    群聊 ID。

    ConvMsgSeq number[]必填

    需要设置已送达回执的消息序号,单次最多 10 条。

Responses​

OK
Schema
    Code number

    返回码。(0表示成功)

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

    返回码说明解决方案
    660000002参数错误请检查参数
    660300005频率限制请稍后再尝试
    660400102传入的回执消息数量超出上限单次最多 10 条,请减少后重试
    660400103设置群聊的回执消息异常联系技术支持
    Message string

    返回状态信息。

    RequestId string

    请求唯一标识。

    DeliveredTime number

    对于接收者,已送达回执成功时的服务端时间戳。

上一篇

设置单聊消息已送达回执

下一篇

发起呼叫邀请

当前页

返回到顶部