全部功能

Webhook

服务事件触发,业务流程接续。

通过文档定义的载荷、签名请求和投递记录,将通话、短信、联系人及语音留言事件接入您的应用。

用事件推动
业务流程。

选择类别,查看当前文档支持的事件。这是参考说明,并非实时事件流。

call_initiated

呼叫开始。

call_ringing

呼叫进入振铃阶段。

call_answered

电话已接听。

call_completed

通话结束,包含最终时长。

使用流程

事件发生后,
由应用作出响应。

IllyVoIP 会向您配置的端点发送 JSON 格式的 POST 请求。

选择订阅事件

在账户 Webhook 设置中创建接收端点,订阅应用需要的通话、短信、联系人或语音留言事件。

先验签,再处理

按照文档,使用 Webhook 密钥、时间戳和原始请求体检查 Illyvoip-Signature 请求头。

及时确认,后台处理

尽快返回成功的 2xx 响应。较耗时的工作请放入队列,避免延迟投递确认。

处理重复投递

保存请求体中的事件 ID,忽略已经处理过的事件。重试可能再次投递同一事件。

为真实的
投递情况做好准备。

客户平台提供投递历史,API 文档说明载荷、签名和重试行为。

检查失败原因
查看投递状态、HTTP 响应和错误信息,区分接收端问题与业务逻辑问题。
区分短信接收范围
端点可以接收所有 Sender ID 或仅选定 Sender ID 的事件。每个匹配端点都会收到事件;改变筛选不会重放旧事件。
在服务器上保管密钥
Webhook 管理涉及账户级端点、密钥和投递日志,请谨慎授予此权限。 阅读当前 Webhook 规范

进一步
了解。

咨询我们的团队
客户平台的每个操作都有 Webhook 吗?+

没有。请以 API 文档的事件目录为准,仅订阅目标流程支持的事件。

同一事件可能收到多次吗?+

可能。重试投递保留相同事件 ID。请使用请求体中的 id 去重,而不是投递任务 ID。

哪些失败会重试?+

当前文档将网络失败、HTTP 408、429 和 5xx 响应列为可重试情况。重定向和其他 4xx 响应会终止投递。实现接收端前,请查看最新规范。

让事件推动业务向前。

先阅读当前事件文档,再配置接收端点。