Skip to main content
YCloud 为客户沟通和互动工作流提供统一的 API。您可以发送 WhatsApp、SMS、电子邮件和语音消息。您还可以验证用户、管理联系人、跟踪自定义事件,并通过 Webhook 接收状态更新。

请求工作原理

所有服务端请求均使用此基础 URL:
在 X-API-Key 请求头中使用 API 密钥对请求进行身份验证。请将密钥保存在您的服务器上,切勿在浏览器或移动应用代码中暴露该密钥。

快速入门

配置您的 API 密钥并发出第一个经过身份验证的请求。

身份验证

安全存储并使用您的 YCloud API 密钥。

Webhook

接收消息状态更新和入站消息。

指南

按照实用指南了解常见集成工作流。

您可以构建的内容

WhatsApp 体验

发送模板、文本、媒体、交互式消息等。

SMS 与语音

发送全球 SMS 消息和自动语音验证码。

电子邮件

从已激活的域名发送 HTML 或纯文本电子邮件。

WhatsApp 平台

管理 WABA、电话号码、模板、Flows、媒体和呼叫。

客户数据

管理联系人、自定义事件和渠道退订。

请求

通过 Content-Type: application/json 发送 JSON 请求体。路径和查询参数已在各个端点页面中记录。
当您需要完整的请求架构、枚举值或交互式请求构建器时,请参考 API 参考文档。

响应

成功响应使用 JSON 格式。创建或发送响应确认 YCloud 已接受该请求。它并不总是代表最终送达或完成。请存储返回的资源 ID,并将其与检索结果或 Webhook 事件进行关联。 错误信息包括机器可读的 code、面向开发人员的 message 以及可提供给 YCloud 支持团队的 requestId。
某些产品需要先激活账户、获得批准的发送方或连接 WhatsApp 商业账户,然后才能发送消息。

从指南到 API 参考

WhatsApp 指南

了解消息窗口、发送模式、请求字段和送达状态。

WhatsApp 端点

查看完整的直发请求和响应架构。

SMS 指南

了解 SMS 请求和送达状态更新的工作原理。

SMS 端点

查看完整的 SMS 请求和响应架构。