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

# Guias

> Guias práticos para criar integrações com a API da YCloud.

Use estes guias para ir da sua primeira requisição a uma integração em produção.

## Escolha um fluxo de trabalho

Comece com um guia de tarefas quando você souber o que deseja criar. Cada guia de tarefas
explica a funcionalidade do recurso, os pré-requisitos, o funcionamento, uma requisição completa,
a resposta, o status final e os modos comuns de falha.

<CardGroup cols={2}>
  <Card title="Enviar uma mensagem de WhatsApp" icon="whatsapp" href="/pt/api-reference/guides/whatsapp-platform/send-whatsapp-message">
    Escolha entre o envio direto ou enfileirado.
  </Card>

  <Card title="Enviar um SMS" icon="comment-sms" href="/pt/api-reference/guides/messaging/send-sms">
    Envie mensagens de texto e acompanhe a entrega.
  </Card>

  <Card title="Enviar um e-mail" icon="envelope" href="/pt/api-reference/guides/messaging/send-email">
    Envie e-mails em HTML ou texto sem formatação.
  </Card>

  <Card title="Gerenciar mensagens recebidas" icon="inbox" href="/pt/api-reference/guides/whatsapp-platform/handle-whatsapp-inbound-messages">
    Receba mensagens, marque-as como lidas e exiba indicadores de digitação.
  </Card>

  <Card title="Enviar um código de voz" icon="volume-high" href="/pt/api-reference/guides/messaging/send-voice-code">
    Envie um código de verificação por meio de uma chamada automatizada.
  </Card>
</CardGroup>

## Desenvolver no WhatsApp

<CardGroup cols={2}>
  <Card title="Contas empresariais" icon="building" href="/pt/api-reference/guides/whatsapp-platform/manage-whatsapp-business-accounts">
    Inspecione WABAs conectadas, verificação, restrições e limites de mensagens.
  </Card>

  <Card title="Números de telefone" icon="phone" href="/pt/api-reference/guides/whatsapp-platform/manage-whatsapp-phone-numbers">
    Registre remetentes e gerencie configurações de perfis, comércio e chamadas.
  </Card>

  <Card title="Preços de mensagens do WhatsApp" icon="receipt" href="/pt/api-reference/guides/whatsapp-platform/whatsapp-message-pricing-integration-guide">
    Entenda os campos de preços, as regras de cobrança e quando os preços das mensagens se tornam definitivos.
  </Card>

  <Card title="Modelos" icon="rectangle-list" href="/pt/api-reference/guides/whatsapp-platform/manage-whatsapp-templates">
    Crie e gerencie estruturas de mensagens aprovadas.
  </Card>

  <Card title="Flows" icon="diagram-project" href="/pt/api-reference/guides/whatsapp-platform/manage-whatsapp-flows">
    Crie, visualize, publique e descontinue experiências estruturadas.
  </Card>

  <Card title="Mídia" icon="image" href="/pt/api-reference/guides/whatsapp-platform/upload-whatsapp-media">
    Faça upload de mídia reutilizável para mensagens do WhatsApp.
  </Card>

  <Card title="Chamadas" icon="phone-volume" href="/pt/api-reference/guides/whatsapp-platform/manage-whatsapp-calls">
    Conecte, atenda, rejeite e encerre chamadas.
  </Card>

  <Card title="IDs de usuário no escopo da empresa" icon="user-tag" href="/pt/api-reference/guides/whatsapp-platform/use-business-scoped-user-ids">
    Envie mensagens e faça chamadas sem depender do número de telefone do usuário.
  </Card>
</CardGroup>

## Gerenciar dados de clientes

<CardGroup cols={2}>
  <Card title="Contatos" icon="address-card" href="/pt/api-reference/guides/customer-data-and-operations/manage-contacts">
    Crie e mantenha perfis de clientes.
  </Card>

  <Card title="Eventos personalizados" icon="bolt" href="/pt/api-reference/guides/customer-data-and-operations/track-custom-events">
    Defina e envie eventos de atividade do cliente.
  </Card>

  <Card title="Cancelamentos de inscrição" icon="user-slash" href="/pt/api-reference/guides/customer-data-and-operations/manage-unsubscribers">
    Registre e aplique opções de cancelamento de inscrição (opt-out) por canal.
  </Card>

  <Card title="Saldo" icon="wallet" href="/pt/api-reference/guides/customer-data-and-operations/check-account-balance">
    Monitore os fundos disponíveis e a moeda da conta.
  </Card>
</CardGroup>

## Entenda a API

<CardGroup cols={2}>
  <Card title="Autenticação" icon="key" href="/pt/api-reference/guides/api-fundamentals/authentication">
    Autentique-se com segurança usando uma chave de API.
  </Card>

  <Card title="Erros" icon="triangle-exclamation" href="/pt/api-reference/guides/api-fundamentals/handle-errors">
    Trate falhas e novas tentativas com segurança.
  </Card>

  <Card title="Paginação" icon="list" href="/pt/api-reference/guides/api-fundamentals/pagination">
    Itere por endpoints de listagem.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/pt/api-reference/guides/api-fundamentals/configure-webhooks">
    Receba eventos da YCloud.
  </Card>
</CardGroup>

## Adapte um exemplo prático

<CardGroup cols={2}>
  <Card title="Exemplos comentados" icon="book-open" href="/pt/api-reference/guides/examples/overview">
    Acompanhe orientações visuais com instruções, requisições, respostas e notas de implementação.
  </Card>

  <Card title="Criação de modelo de mensagem do WhatsApp" icon="rectangle-list" href="/pt/api-reference/guides/examples/api-examples/whatsapp-template-creation-examples">
    Crie variantes de modelos com capturas de tela e exemplos de requisição anotados.
  </Card>

  <Card title="Passo a passo de Webhooks" icon="webhook" href="/pt/api-reference/guides/examples/webhook-examples/overview">
    Revise pré-requisitos, comportamento dos eventos e payloads específicos de cada cenário.
  </Card>

  <Card title="Todos os payloads de webhook" icon="brackets-curly" href="/pt/api-reference/guides/examples/webhook-examples/webhook-payload-examples">
    Explore todos os tipos de eventos compatíveis e exemplos de payload nomeados.
  </Card>
</CardGroup>

## Do guia à referência

Use um guia para entender o comportamento e as escolhas de integração. Use a Referência da API
para inspecionar cada campo de requisição, campo de resposta e valor enum. Use
exemplos de webhook para testar seu manipulador de eventos antes do tráfego em produção.


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