Vocode核心项目中的Webhooks功能详解：实现通话事件实时监听与自动化-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00837/article/details/148578576

Vocode核心项目中的Webhooks功能详解：实现通话事件实时监听与自动化

什么是Webhooks

在Vocode核心项目中，Webhooks是一种强大的机制，允许开发者实时监听通话过程中的各种事件，并基于这些事件触发自动化流程。简单来说，当通话状态发生变化或特定事件发生时，Vocode会自动向您指定的服务器端点发送通知。

Webhooks的核心价值

实时性：立即获取通话状态变化，无需轮询查询
自动化：基于事件触发后续业务流程
灵活性：可自定义监听的事件类型和响应方式
集成性：轻松与其他系统对接

如何设置Webhooks

基本配置步骤

要设置Webhook，您需要指定三个关键参数：

订阅事件(subscriptions)：确定要监听哪些类型的事件
目标URL(url)：设置接收事件通知的服务器端点
HTTP方法(method)：定义使用POST还是GET方法发送通知

代码示例

以下是Python和TypeScript两种语言的配置示例：

Python实现

from vocode import AgentUpdateParams, EventType, HttpMethod, WebhookUpdateParams

# 创建Webhook配置
new_webhook = WebhookUpdateParams(
    subscriptions=[EventType.EVENT_PHONE_CALL_ENDED],  # 监听通话结束事件
    url="https://example.com",  # 接收通知的URL
    method=HttpMethod.POST,    # 使用POST方法
)

# 更新电话号码配置
number = vocode_client.numbers.update_number(
    phone_number="YOUR_NUMBER",
    inbound_agent=AgentUpdateParams(
        webhook=new_webhook,
    ),
)

TypeScript实现

import { EventType, HttpMethod } from "@vocode/vocode-api/api";

const number = await vocode.numbers.updateNumber({
  phoneNumber: "YOUR_NUMBER",
  inboundAgent: {
    webhook: {
      subscriptions: [EventType.EventPhoneCallConnected],  // 监听通话连接事件
      url: "https://example.com",  // 接收通知的URL
      method: HttpMethod.Post,     // 使用POST方法
    },
  },
});

支持的事件类型

Vocode核心项目提供了丰富的事件类型供开发者订阅：

消息事件(EVENT_MESSAGE)：通话中的每条消息都会触发
动作事件(EVENT_ACTION)：通话中的特定动作发生时触发
通话连接事件(EVENT_PHONE_CALL_CONNECTED)：通话成功建立时触发
通话结束事件(EVENT_PHONE_CALL_ENDED)：通话结束时触发
转录事件(EVENT_TRANSCRIPT)：通话转录文本可用时触发
录音事件(EVENT_RECORDING)：通话录音可用时触发
人机检测事件(EVENT_HUMAN_DETECTION)：检测到接听方是人类还是机器时触发

实际应用场景

场景1：通话后自动处理

# 监听通话结束事件，自动触发后续处理流程
WebhookUpdateParams(
    subscriptions=[EventType.EVENT_PHONE_CALL_ENDED],
    url="https://your-api.com/call-followup",
    method=HttpMethod.POST,
)

场景2：实时转录分析

// 监听转录事件，实时分析通话内容
{
  subscriptions: [EventType.EVENT_TRANSCRIPT],
  url: "https://your-api.com/realtime-analysis",
  method: HttpMethod.Post
}

场景3：人机检测分流

# 根据检测结果将人类通话转接给人工客服
WebhookUpdateParams(
    subscriptions=[EventType.EVENT_HUMAN_DETECTION],
    url="https://your-api.com/routing",
    method=HttpMethod.POST,
)