Visão Geral
Comece em Minutos
A API REST da Yup Chat permite enviar e receber mensagens através de múltiplos canais com uma única integração. Suporte completo para SMS, WhatsApp, RCS e Email.
- Autenticação HTTP Basic segura
- Respostas JSON estruturadas
- Webhooks para notificações em tempo real
- Rate limiting generoso (10.000 req/min)
- Sandbox para testes sem custo
URL Base
url
https://api.yup.chat/v1Versão da API
v1 (Atual)
Autenticação
A API utiliza autenticação HTTP Basic. Inclua suas credenciais no header Authorization.
bash
curl -u "seu_usuario:sua_senha" https://api.yup.chat/v1/sms/sendBase URL
url
https://api.yup.chat/v1Endpoints Principais
SMS
Endpoints para enviar e gerenciar mensagens SMS.
bash
POST /sms/send\nGET /sms/:id\nGET /sms/listEndpoints para enviar e gerenciar mensagens WhatsApp.
bash
POST /whatsapp/send\nGET /whatsapp/:id\nGET /whatsapp/listRCS
Endpoints para enviar e gerenciar mensagens RCS.
bash
POST /rcs/send\nGET /rcs/:id\nGET /rcs/listEndpoints para enviar e gerenciar mensagens de Email.
bash
POST /email/send\nGET /email/:id\nGET /email/listVoice
Endpoints para fazer chamadas de voz.
bash
POST /voice/call\nGET /voice/:id\nGET /voice/listTratamento de Erros
A API retorna códigos de erro HTTP padrão. Verifique o corpo da resposta para detalhes.
json
{\n "error": "invalid_phone_number",\n "message": "O número de telefone não é válido",\n "code": 400\n}Status Retornados
- 200 OKRequisição bem-sucedida
- 400 Bad RequestParâmetros inválidos
- 401 UnauthorizedCredenciais inválidas
- 429 Too Many RequestsLimite de requisições excedido
- 500 Server ErrorErro interno do servidor
Exemplos de Uso
javascript
const response = await fetch("https://api.yup.chat/v1/sms/send", {\n method: "POST",\n headers: {\n "Authorization": "Basic " + btoa("usuario:senha"),\n "Content-Type": "application/json"\n },\n body: JSON.stringify({\n to: "+5511999999999",\n message: "Olá! Esta é uma mensagem de teste."\n })\n});Webhooks
Configure webhooks para receber notificações em tempo real sobre o status das mensagens.
json
{\n "event": "message.sent",\n "message_id": "msg_123456",\n "status": "sent",\n "timestamp": "2024-01-19T13:30:00Z"\n}Recursos Adicionais
- Documentação Completa: Acesse nossa documentação interativa
- SDKs: Bibliotecas disponíveis para Node.js, Python e PHP
- Sandbox: Teste a API em ambiente seguro
Suporte
Precisa de ajuda? Entre em contato com nosso time de suporte.