Skip to main content
A YCloud oferece uma única API para comunicação com clientes e fluxos de engajamento. Você pode enviar mensagens de WhatsApp, SMS, e-mail e voz. Também pode verificar usuários, gerenciar contatos, rastrear eventos personalizados e receber atualizações de status por meio de webhooks.

​
Como funcionam as requisições

Todas as requisições do lado do servidor utilizam esta URL base:
Autentique as requisições com uma chave de API no cabeçalho X-API-Key. Mantenha a chave no seu servidor e nunca a exponha no código do navegador ou do aplicativo móvel.

Início rápido

Configure sua chave de API e faça sua primeira requisição autenticada.

Autenticação

Armazene e use sua chave de API da YCloud com segurança.

Webhooks

Receba atualizações de status de mensagens e mensagens recebidas.

Guias

Siga guias práticos para fluxos de integração comuns.

​
O que você pode criar

Experiências no WhatsApp

Envie modelos, textos, mídias, mensagens interativas e muito mais.

SMS e voz

Envie mensagens SMS globais e códigos de voz automatizados.

E-mail

Envie e-mails em HTML ou texto simples a partir de um domínio ativado.

Plataforma WhatsApp

Gerencie WABAs, números de telefone, modelos, Flows, mídias e chamadas.

Dados de clientes

Gerencie contatos, eventos personalizados e cancelamentos de assinatura por canal (opt-outs).

​
Requisição

Envie corpos de requisição JSON com Content-Type: application/json. Os parâmetros de caminho (path) e de consulta (query) estão documentados na página de cada endpoint.
Use a Referência da API quando precisar do schema completo da requisição, dos valores de enum ou de um construtor de requisições interativo.

​
Resposta

As respostas bem-sucedidas usam JSON. Uma resposta de criação ou envio confirma que a YCloud aceitou a requisição. Ela nem sempre confirma a entrega final ou a conclusão. Armazene o ID do recurso retornado e correlacione-o com resultados de consulta ou eventos de Webhook. Os erros incluem um code legível por máquina, um message voltado para desenvolvedores e um requestId que você pode fornecer ao suporte da YCloud.
Alguns produtos exigem a ativação da conta, um remetente aprovado ou uma conta do WhatsApp Business conectada antes que você possa enviar mensagens.

​
Do guia à referência da API

Guia do WhatsApp

Entenda as janelas de mensagens, os modos de envio, os campos de requisição e os status de entrega.

Endpoint do WhatsApp

Inspecione o schema completo de requisição e resposta de envio direto.

Guia de SMS

Saiba como funcionam as requisições de SMS e as atualizações de entrega.

Endpoint de SMS

Inspecione o schema completo de requisição e resposta de SMS.