> ## 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.

# 指南

> 使用 YCloud API 进行构建的实用指南。

使用这些指南，从您的第一次请求逐步过渡到生产级集成。

## 选择工作流

当您明确想要构建的内容时，请从任务指南开始。每个任务指南都会说明该功能的作用、前置要求、工作原理、完整的请求与响应、最终状态以及常见失败模式。

<CardGroup cols={2}>
  <Card title="发送 WhatsApp 消息" icon="whatsapp" href="/zh/api-reference/guides/whatsapp-platform/send-whatsapp-message">
    在排队发送和直接发送之间进行选择。
  </Card>

  <Card title="发送 SMS" icon="comment-sms" href="/zh/api-reference/guides/messaging/send-sms">
    发送短信并跟踪送达状态。
  </Card>

  <Card title="发送电子邮件" icon="envelope" href="/zh/api-reference/guides/messaging/send-email">
    发送 HTML 或纯文本电子邮件。
  </Card>

  <Card title="处理入站消息" icon="inbox" href="/zh/api-reference/guides/whatsapp-platform/handle-whatsapp-inbound-messages">
    接收消息、将消息标记为已读并显示输入状态提示。
  </Card>

  <Card title="发送语音验证码" icon="volume-high" href="/zh/api-reference/guides/messaging/send-voice-code">
    通过自动语音呼叫发送验证码。
  </Card>
</CardGroup>

## 在 WhatsApp 上构建

<CardGroup cols={2}>
  <Card title="商业账户" icon="building" href="/zh/api-reference/guides/whatsapp-platform/manage-whatsapp-business-accounts">
    查看已连接的 WABA、认证状态、限制以及消息发送限额。
  </Card>

  <Card title="电话号码" icon="phone" href="/zh/api-reference/guides/whatsapp-platform/manage-whatsapp-phone-numbers">
    注册发送方并管理个人资料、商业设置和呼叫设置。
  </Card>

  <Card title="WhatsApp 消息定价" icon="receipt" href="/zh/api-reference/guides/whatsapp-platform/whatsapp-message-pricing-integration-guide">
    了解计费字段、扣费规则以及消息价格最终确定的时间。
  </Card>

  <Card title="模板" icon="rectangle-list" href="/zh/api-reference/guides/whatsapp-platform/manage-whatsapp-templates">
    创建并管理已获批的消息结构。
  </Card>

  <Card title="Flows" icon="diagram-project" href="/zh/api-reference/guides/whatsapp-platform/manage-whatsapp-flows">
    构建、预览、发布和弃用结构化体验。
  </Card>

  <Card title="媒体" icon="image" href="/zh/api-reference/guides/whatsapp-platform/upload-whatsapp-media">
    上传用于 WhatsApp 消息的可复用媒体文件。
  </Card>

  <Card title="呼叫" icon="phone-volume" href="/zh/api-reference/guides/whatsapp-platform/manage-whatsapp-calls">
    建立、接听、拒绝和终止呼叫。
  </Card>

  <Card title="企业作用域用户 ID" icon="user-tag" href="/zh/api-reference/guides/whatsapp-platform/use-business-scoped-user-ids">
    无需依赖用户电话号码即可发送消息和发起呼叫。
  </Card>
</CardGroup>

## 管理客户数据

<CardGroup cols={2}>
  <Card title="联系人" icon="address-card" href="/zh/api-reference/guides/customer-data-and-operations/manage-contacts">
    创建并维护客户资料。
  </Card>

  <Card title="自定义事件" icon="bolt" href="/zh/api-reference/guides/customer-data-and-operations/track-custom-events">
    定义并发送客户活动事件。
  </Card>

  <Card title="退订用户" icon="user-slash" href="/zh/api-reference/guides/customer-data-and-operations/manage-unsubscribers">
    记录并执行各渠道的退订设置。
  </Card>

  <Card title="余额" icon="wallet" href="/zh/api-reference/guides/customer-data-and-operations/check-account-balance">
    监控可用账户资金和币种。
  </Card>
</CardGroup>

## 了解 API

<CardGroup cols={2}>
  <Card title="身份验证" icon="key" href="/zh/api-reference/guides/api-fundamentals/authentication">
    使用 API 密钥进行安全身份验证。
  </Card>

  <Card title="错误" icon="triangle-exclamation" href="/zh/api-reference/guides/api-fundamentals/handle-errors">
    安全地处理失败和重试。
  </Card>

  <Card title="分页" icon="list" href="/zh/api-reference/guides/api-fundamentals/pagination">
    遍历列表端点。
  </Card>

  <Card title="Webhook" icon="webhook" href="/zh/api-reference/guides/api-fundamentals/configure-webhooks">
    接收来自 YCloud 的事件。
  </Card>
</CardGroup>

## 参考实际示例

<CardGroup cols={2}>
  <Card title="带注解的示例" icon="book-open" href="/zh/api-reference/guides/examples/overview">
    按照包含操作说明、请求、响应和实现注意事项的直观演示进行操作。
  </Card>

  <Card title="WhatsApp 模板创建" icon="rectangle-list" href="/zh/api-reference/guides/examples/api-examples/whatsapp-template-creation-examples">
    参考屏幕截图和带注解的请求示例创建模板变体。
  </Card>

  <Card title="Webhook 演练" icon="webhook" href="/zh/api-reference/guides/examples/webhook-examples/overview">
    查看前置要求、事件行为和针对具体场景的有效负载。
  </Card>

  <Card title="所有 Webhook 有效负载" icon="brackets-curly" href="/zh/api-reference/guides/examples/webhook-examples/webhook-payload-examples">
    探索所有受支持的事件类型和指定的有效负载示例。
  </Card>
</CardGroup>

## 从指南深入参考文档

通过指南了解功能行为和集成方案选择。使用 API 参考查看每个请求字段、响应字段和枚举值。在生产流量到来之前，使用 Webhook 示例测试您的事件处理程序。


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