文档中心
即时通讯
服务端 API
呼叫邀请
发起呼叫邀请

发起呼叫邀请

更新时间：2024-07-03 11:09

描述

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

呼叫邀请创建成功后，通过以下 ZIM SDK 的回调接口，发起邀请的用户（主叫）会收到邀请已创建的通知：

iOS	Android	macOS	Windows	Web
callInvitationCreated	onCallInvitationCreated	callInvitationCreated	onCallInvitationCreated	callInvitationCreated
小程序	Flutter	uni-app	React Native
callInvitationCreated	onCallInvitationCreated	callInvitationCreated	callInvitationCreated

被邀请的用户（被叫）会收到被邀请的通知：

iOS	Android	macOS	Windows	Web
callInvitationReceived	onCallInvitationReceived	callInvitationReceived	onCallInvitationReceived	callInvitationReceived
小程序	Flutter	Unity3D	uni-app	React Native
callInvitationReceived	onCallInvitationReceived	OnCallInvitationReceived	callInvitationReceived	callInvitationReceived

接口原型

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

请求参数

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

参数	类型	是否必选	描述
FromUserId	String	是	主叫用户 ID（已注册）。
UserIds	Array of String	是	被叫用户列表，上限为 9 名用户。如需上调，请联系 ZEGO 技术支持。
Timeout	Number	否	呼叫超时时间，单位为秒，取值范围为 (0, 600]。传 0 或为空取默认值 90。
ExtendedData	String	否	扩展字段，长度上限为 2 KB。
OfflinePush	Object	是	离线推送配置，详情请参考 MessageBody 说明 - OfflinePush 说明。

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

请求示例

请求地址 URL：

https://zim-api.zego.im/?Action=CallInvite
&<公共请求参数>

请求消息体：

{
    "FromUserId": "user0",
    "UserIds": [
        "uid1",
        "uid2"
    ],
    "Timeout": 90,
    "ExtendedData": "ExtendedData",
    "OfflinePush": {
        "Enable": 1,
        "Title": "title",
        "Content": "content",
        "Payload": "payload"
    }
}

响应参数

参数	类型	描述
Code	Number	返回码。
Message	String	操作结果描述。
RequestId	String	请求 ID。
CallId	String	呼叫 ID。
CreateTime	Number	呼叫邀请创建时间戳。
ErrorUsers	Array of Object	邀请失败用户信息。 Code 为 0： ErrorUsers 为空，向全部指定用户发起邀请成功。 ErrorUsers 不为空，表示向部分指定用户发起邀请失败，请参考 SubCode 处理。 Code 不为 0： ErrorUsers 为空，表示参数错误、接口频率限制、系统错误。 ErrorUsers 不为空，表示向全部指定用户发起邀请失败。
UserId	String	失败用户 ID。
SubCode	Number	失败的具体返回码。

响应示例

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782",
    "CreateTime": "1713249504000",
    "CallId": "12261423186766631832",
    "ErrorUsers":[
        {
            "UserId": "uid2",
            "SubCode": 660500002
        }
    ] 
}

返回码

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

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