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

CallInvite

POST

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

通过该接口可以创建普通模式的呼叫邀请。

呼叫邀请创建成功后,通过以下 ZIM SDK 的回调接口,发起邀请的用户(主叫)会收到邀请已创建的通知:

iOSAndroidmacOSWindows
callInvitationCreatedonCallInvitationCreatedcallInvitationCreatedonCallInvitationCreated
Web小程序FlutterReact Native
callInvitationCreatedcallInvitationCreatedonCallInvitationCreatedcallInvitationCreated
Unity3Duniapp | uniapp xHarmonyOS
onCallInvitationCreatedcallInvitationCreatedcallInvitationCreated

被邀请的用户(被叫)会收到被邀请的通知:

iOSAndroidmacOSWindows
callInvitationReceivedonCallInvitationReceivedcallInvitationReceivedonCallInvitationReceived
Web小程序FlutterReact Native
callInvitationReceivedcallInvitationReceivedonCallInvitationReceivedcallInvitationReceived
Unity3Duniapp | uniapp xHarmonyOS
OnCallInvitationReceivedcallInvitationReceivedcallInvitationReceived
说明
参数 FromUserIdUserIds 对应的用户已在客户端调用 login 方法登录 ZIM 服务,或开发者已调用 服务端 API 注册相关的 userID。
说明
参数 FromUserId 和 UserIds 仅支持数字,英文字符和 '!','#','$','%','&','(',')','+','-',':',';','<','=','.','>','?','@','[',']','^','_',' ','{','}','|','~'。
说明
调用频率限制:20 次/秒

Request

Query Parameters

    Action string必填

    可选值: [CallInvite]

    接口原型参数

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

    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(已在客户端调用 login 方法登录 ZIM 服务,或已调用 服务端 API 完成注册)。

    UserIds string[]必填

    可选值: <= 9

    被叫用户列表,上限为 9 名用户。如需上调,请联系 ZEGO 技术支持。

    Timeout number

    可选值: >= 0 and <= 600

    默认值: 90

    呼叫超时时间,单位为秒,取值范围为 (0, 600]。传 0 或为空取默认值 90。

    ExtendedData string

    可选值: <= 2048 characters

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

    OfflinePush objectrequired
    离线推送配置,详情请参考 MessageBody 说明 - OfflinePush 说明
    Enable integer

    是否启用离线推送。1 表示启用,0 表示禁用。

    Title string

    离线推送展示的标题。

    Content string

    离线推送展示的内容。

    Payload string

    扩展字段,开发者可以自定义收到离线推送消息后的行为。

Responses

OK
Schema
    Code integer

    返回码。

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

    返回码说明处理建议
    660000002参数错误。请检查请求参数。
    660300005调用接口的频率超出了 AppID 级别限制。请稍后再试。
    660500002操作者用户未注册。请先让操作者用户注册 ZIM 服务。
    660900003所有被叫用户需为已注册。请检查被叫用户的注册状态或稍后再试。
    660900007被叫用户列表长度超过限制。请缩短被叫用户列表长度,或联系 ZEGO 技术支持上调上限。
    Message string

    操作结果描述。

    RequestId string

    请求 ID。

    CallId string

    呼叫 ID。

    CreateTime number

    呼叫邀请创建时间戳。

    ErrorUsers object[]
    邀请失败用户信息。Code 为 0:
    • ErrorUsers 为空,向全部指定用户发起邀请成功。
    • ErrorUsers 不为空,表示向部分指定用户发起邀请失败,请参考 SubCode 处理。
    Code 不为 0:
    • ErrorUsers 为空,表示参数错误、接口频率限制、系统错误。
    • ErrorUsers 不为空,表示向全部指定用户发起邀请失败。
  • Array[
  • UserId string

    失败用户 ID。

    SubCode number

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

    返回码说明处理建议
    660000002参数错误。请检查请求参数。
    660300005调用接口的频率超出了 AppID 级别限制。请稍后再试。
    660500002操作者用户未注册。请先让操作者用户注册 ZIM 服务。
    660900003所有被叫用户需为已注册。请检查被叫用户的注册状态或稍后再试。
    660900007被叫用户列表长度超过限制。请缩短被叫用户列表长度,或联系 ZEGO 技术支持上调上限。
  • ]

上一篇

删除群聊会话内的全部消息

下一篇

接受呼叫邀请

当前页

返回到顶部