文档中心
IM 即时通讯
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
中文站 English
  • 文档中心
  • 即时通讯
  • 服务端 API
  • 呼叫邀请
  • 拒绝呼叫邀请

拒绝呼叫邀请

更新时间:2024-07-03 18:02

描述

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

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

iOS Android macOS Windows Web
callUserStateChanged
onCallUserStateChanged
callUserStateChanged
onCallUserStateChanged
callUserStateChanged
小程序 Flutter Unity3D uni-app React Native
callUserStateChanged
onCallUserStateChanged
OnCallUserStateChanged
callUserStateChanged
callUserStateChanged

接口原型

  • 请求方法:GET
  • 请求地址:https://zim-api.zego.im/?Action=CallReject
  • 传输协议:HTTPS
  • 调用频率限制:20 次/秒

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数。

参数 类型 是否必选 描述
FromUserId
String
是
为此 ID(已注册)的用户拒绝邀请。
CallId
String
是
呼叫 ID。
ExtendedData
String
否
扩展字段,长度上限为 2 KB。

FromUserId 仅支持数字,英文字符和 '!','#','$','%','&','(',')','+','',':',';','<','=','.','>','?','@','[',']','^','_','{','}','|','~'。

请求示例

https://zim-api.zego.im/?Action=CallReject
&FromUserId=user0
&CallId=CallId
&ExtendedData=ExtendedData
&<公共请求参数>

响应参数

参数 类型 描述
Code
Number
返回码。
Message
String
操作结果描述。
RequestId
String
请求 ID。

响应示例

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782"
}

返回码

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

返回码 说明 处理建议
660000002
参数错误。
请检查请求参数。
660300005
调用接口的频率超出了 AppID 级别限制。
请稍后再试。
660500002
操作者用户未注册。
请先让操作者用户注册 ZIM 服务。
660900004
获取呼叫信息异常
请检查呼叫是否存在,或者稍后再试。
660900005
呼叫已结束,无法对其进行操作。
无需处理。
660900006
呼叫邀请已超时,无法对其进行操作。
无需处理。
660900008
该呼叫没有邀请操作用户,无法对其进行操作。
无需处理。
本篇目录
  • 免费试用
  • 提交工单
    咨询集成、功能及报价等问题
    电话咨询
    400 1006 604
    咨询客服
    微信扫码,24h在线

    联系我们

  • 文档反馈