文档中心
即时通讯
服务端 API
回调说明
呼叫创建回调

呼叫创建回调

更新时间：2024-07-24 10:53

描述

呼叫创建是指用户向其他用户发送呼叫邀请的行为。

当用户在客户端发送呼叫邀请后，业务后台可以接收 ZIM 服务端的呼叫创建回调，用于获取呼叫邀请详情。

呼叫多名用户的时候，若其中一名呼叫对象登出了，则呼叫创建回调中不会包含已登出的用户。
呼叫用户的时候，若所有呼叫对象登出了，则不会进行呼叫创建回调。
若在呼叫创建成功后，主动呼叫用户主动登出或心跳超时为登出态，开发者的业务后台可以接收到 ZIM 服务端的呼叫取消回调，详情请参考呼叫取消回调。

回调说明

请求方法：POST。
- 回调数据需要 UrlDecode 解码。
- 使用 POST 请求方法传递参数时：
  - Body 中的参数直接传 JsonObject 格式即可，无需序列化为 String 格式。
  - Headers 中，设置 “Content-type” 为 “application/json”。

请求地址：请在 ZEGO 控制台上配置回调地址，配置流程请参考控制台文档 ZIM 相关回调配置。
传输协议：HTTPS/HTTP，建议使用 HTTPS。

回调参数

参数	类型	说明
appid	String	APP 的唯一标识。
event	String	回调事件，此回调返回值为 call_create。
nonce	String	随机数。
signature	String	检验串，详情见检验说明。
timestamp	Int	服务器当前时间，Unix 时间戳。
call_id	String	呼叫 ID。
user_ids	Array	呼叫对象用户 ID 列表。
create_time	Int	创建呼叫的时间，Unix 时间戳。
payload	String	呼叫创建时填充的扩展字段。
caller	String	呼叫创建用户。
timeout	Int	等待被叫用户响应的时间上限，单位为秒。

建议您将部分参数转换为 Int 进行逻辑处理，相关字段包括 appid 和 nonce。

数据示例

{
    "appid": "1",
    "event": "call_create",
    "nonce": "350176",
    "signature": "signature",
    "timestamp": 1499676978,
    "call_id": "3501761173612493269",
    "user_ids": ["abc","def"],
    "create_time": 1499676968,
    "payload": "payload",
    "caller": "caller",
    "timeout": 90
}

返回响应

返回 HTTP status code 为 2XX （例如 200）表示成功，其他响应都表示失败。

回调重试策略

如果 ZEGO 服务器没有收到响应，或收到的 HTTP status code 不为 2XX（例如 200），都会尝试重试，最多进行 5 次重试。每次重试请求与上一次请求的间隔时间分别为 2s、4s、8s、16s、32s。若第 5 次重试后仍然失败，将不再重试，该回调丢失。