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

拒绝呼叫邀请

GET

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

通过该接口可以为用户拒绝呼叫邀请。

用户拒绝邀请后,通过以下 ZIM SDK 的回调接口,其他处于呼叫中的用户会收到呼叫用户状态变更的通知:

iOSAndroidmacOSWindows
callUserStateChangedonCallUserStateChangedcallUserStateChangedonCallUserStateChanged
Web小程序FlutterReact Native
callUserStateChangedcallUserStateChangedonCallUserStateChangedcallUserStateChanged
Unity3Duniapp | uniapp xHarmonyOS
OnCallUserStateChangedcallUserStateChangedcallUserStateChanged
说明
参数 FromUserId 仅支持数字,英文字符和 {'!','#','$','%','&','(',')','+','-',':',';','<','=','.','>','?','@','[',']','^','_',' ','{','}','|','~'}。
说明
调用频率限制:20 次/秒

Request

Query Parameters

    Action string必填

    可选值: [CallReject]

    接口原型参数

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

    AppId uint32必填

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

    SignatureNonce string必填

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

    Timestamp int64必填

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

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

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

    Signature string必填

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

    FromUserId string必填

    可选值: <= 32 characters

    为此 ID(已在客户端调用 login 方法登录 ZIM 服务,或已调用 服务端 API 完成注册)的用户拒绝邀请。

    CallId string必填

    可选值: <= 32 characters

    呼叫 ID。

    ExtendedData string

    可选值: <= 2048 characters

    扩展字段,长度上限为 2 KB。

Responses

OK
Schema
    Code number

    返回码。

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

    返回码说明处理建议
    660000002参数错误。请检查请求参数。
    660300005调用接口的频率超出了 AppID 级别限制。请稍后再试。
    660500002操作者用户未注册。请先让操作者用户注册 ZIM 服务。
    660900004获取呼叫信息异常请检查呼叫是否存在,或者稍后再试。
    660900005呼叫已结束,无法对其进行操作。无需处理。
    660900006呼叫邀请已超时,无法对其进行操作。无需处理。
    660900008该呼叫没有邀请操作用户,无法对其进行操作。无需处理。
    Message string

    操作结果描述。

    RequestId string

    请求 ID。


ZEGO 签名生成器
Request
折叠所有
Base URL
https://zim-api.zego.im
统一接入地址(不区分区域)
Parameters
query必填
query必填
query必填
query必填
query必填
query必填
query必填
query必填
query
RESPONSE清除

点击上方 “发送” 按钮,在此处查看响应。

Previous

接受呼叫邀请

Next

设置会话消息免打扰

当前页

返回到顶部