> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ycloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhook 示例

> 浏览特定事件的 Webhook 演练、前置条件和 Payload 示例。

<Note>如需查看完整的 Schema 衍生目录，请参阅[所有示例](/zh/api-reference/guides/examples/webhook-examples/webhook-payload-examples)。</Note>

## 概述

浏览特定事件的 Webhook 演练、前置条件和 Payload 示例。

## 准备工作

* 在您的应用程序中创建一个公开的 HTTPS 端点。
* 为您所需的事件类型配置 YCloud Webhook 端点。
* 安全存储端点签名密钥。
* 确保事件处理具备幂等性。

## 工作原理

当事件发生时，YCloud 会发送 HTTP `POST` 请求。验证签名，持久化记录事件，返回 `2xx` 响应，并异步处理耗时任务。

## 请求

以下场景展示了发送至您的 Webhook URL 的请求。将事件 `id` 作为投递标识符，并使用 `type` 路由 Payload。

## 响应

接收事件后返回 `2xx` 状态。

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```

<Note>有关端点设置、签名验证和重试机制，请参阅[配置 Webhook](/zh/api-reference/guides/api-fundamentals/configure-webhooks)。</Note>

## 消息与模板事件

<CardGroup cols={2}>
  <Card title="模板审核" icon="rectangle-list" href="/zh/api-reference/guides/examples/webhook-examples/whatsapp-template-reviewed-webhook-examples">
    处理已批准、已拒绝、已暂停、已停用和已归档的模板状态。
  </Card>

  <Card title="消息状态" icon="message-check" href="/zh/api-reference/guides/examples/webhook-examples/whatsapp-message-updated-webhook-examples">
    处理出站消息的已发送、已送达、已读和失败状态。
  </Card>

  <Card title="入站消息" icon="inbox" href="/zh/api-reference/guides/examples/webhook-examples/whatsapp-inbound-message-webhook-examples">
    解析文本、媒体、位置、联系人、互动、商业和系统消息。
  </Card>

  <Card title="支付更新" icon="credit-card" href="/zh/api-reference/guides/examples/webhook-examples/whatsapp-payment-updated-webhook-examples">
    处理 WhatsApp 支付交易变更。
  </Card>
</CardGroup>

## 回响与 Agent 交接事件

对于通过公开 REST API 接入的 Agent，请使用这些特定事件的演练。
通过控制台创建的 Agent 使用独立的收件箱同步流程。

<CardGroup cols={2}>
  <Card title="回响消息已创建" icon="clone" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created">
    存储出站文本和媒体回响。
  </Card>

  <Card title="回响消息已更新" icon="message-check" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-updated">
    处理已送达、已读、延迟发送和失败的状态更新。
  </Card>

  <Card title="Agent 交接已更新" icon="arrow-right-arrow-left" href="/en/api-reference/guides/examples/webhook-examples/whatsapp-meta-business-agent-handover-updated">
    监控控制权交接并了解其关联限制。
  </Card>
</CardGroup>

## 账户、应用与 Flow 事件

<CardGroup cols={2}>
  <Card title="商业账户更新" icon="building" href="/zh/api-reference/guides/examples/webhook-examples/whatsapp-business-account-updated-webhook-examples">
    处理资格、位置、违规、限制和账户状态变更。
  </Card>

  <Card title="Business App 历史记录" icon="clock-rotate-left" href="/zh/api-reference/guides/examples/webhook-examples/whatsapp-business-app-history-message-webhook-examples">
    同步历史入站和出站消息。
  </Card>

  <Card title="Business App 消息回响" icon="clone" href="/zh/api-reference/guides/examples/webhook-examples/whatsapp-business-app-sent-message-sync-webhook-examples">
    同步从 WhatsApp Business App 发送的消息。
  </Card>

  <Card title="Flow 状态" icon="diagram-project" href="/zh/api-reference/guides/examples/webhook-examples/whatsapp-flow-webhook-examples">
    处理 Flow 生命周期状态变更。
  </Card>
</CardGroup>

## 通话与群组事件

<CardGroup cols={2}>
  <Card title="通话连接" icon="phone" href="/zh/api-reference/guides/examples/webhook-examples/whatsapp-calling-connect-webhook-examples">
    处理 WhatsApp 通话的 SDP Offer 和 Answer。
  </Card>

  <Card title="通话状态" icon="phone-volume" href="/zh/api-reference/guides/examples/webhook-examples/whatsapp-calling-status-update-webhook-examples">
    处理响铃、已接听和已拒绝的通话状态。
  </Card>

  <Card title="通话终止" icon="phone-slash" href="/zh/api-reference/guides/examples/webhook-examples/whatsapp-calling-terminate-webhook-examples">
    处理已完成和已失败的通话终止。
  </Card>

  <Card title="群组生命周期" icon="users" href="/zh/api-reference/guides/examples/webhook-examples/whatsapp-group-lifecycle-update-webhook-examples">
    处理群组创建和删除。
  </Card>

  <Card title="群组成员" icon="user-plus" href="/zh/api-reference/guides/examples/webhook-examples/whatsapp-group-participants-update-webhook-examples">
    处理成员及加群申请变更。
  </Card>

  <Card title="群组设置" icon="users-gear" href="/zh/api-reference/guides/examples/webhook-examples/whatsapp-group-settings-update-webhook-examples">
    处理群主题和群描述变更。
  </Card>

  <Card title="群组状态" icon="circle-exclamation" href="/zh/api-reference/guides/examples/webhook-examples/whatsapp-group-status-update-webhook-examples">
    处理群组封禁与恢复。
  </Card>
</CardGroup>

## 联系人事件

<CardGroup cols={2}>
  <Card title="联系人已创建" icon="user-plus" href="/zh/api-reference/guides/examples/webhook-examples/contact-created-webhook-examples">
    处理新创建的联系人。
  </Card>

  <Card title="联系人已删除" icon="user-minus" href="/zh/api-reference/guides/examples/webhook-examples/contact-deleted-webhook-examples">
    移除或对账已删除的联系人。
  </Card>

  <Card title="联系人属性已更改" icon="pen-to-square" href="/zh/api-reference/guides/examples/webhook-examples/contact-attributes-changed-webhook-examples">
    处理个人资料、自定义属性和标签的变更。
  </Card>

  <Card title="联系人已退订" icon="user-slash" href="/zh/api-reference/guides/examples/webhook-examples/contact-unsubscribe-created-webhook-examples">
    处理新创建的退订记录。
  </Card>

  <Card title="联系人已重新订阅" icon="user-check" href="/zh/api-reference/guides/examples/webhook-examples/contact-unsubscribe-deleted-webhook-examples">
    处理已删除的退订记录。
  </Card>
</CardGroup>

<Card title="打开完整的 Payload 目录" icon="brackets-curly" href="/zh/api-reference/guides/examples/webhook-examples/webhook-payload-examples">
  浏览 OpenAPI 规范中的所有事件类型和全部已命名的 Payload 示例。
</Card>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.