> ## Documentation Index > Fetch the complete documentation index at: https://docs.escrybe.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Enviar uma mensagem de WhatsApp > O telefone do destinatário é normalizado para E.164 e verificado como número de WhatsApp — requisições para números fora do WhatsApp são rejeitadas com 400. ## OpenAPI ````yaml /openapi/escrybe.pt.yaml post /api/whatsapp/v1/post openapi: 3.1.0 info: title: API Escrybe version: 1.0.0 description: >- REST API da plataforma Escrybe — envie cartas físicas, cartas registradas, telegramas e e-Carta pelos Correios, dispare e-mails registrados juridicamente e envie mensagens de WhatsApp com carimbo de tempo certificado. ## Autenticação Toda conta possui um **`securityToken`** pessoal (disponível no painel em *Minhas configurações → Acesso a API*). Três produtos o utilizam de formas diferentes: | Produto | Esquema | Como | |---------|---------|------| | Cartas / Telegrama / e-Carta, E-mail Registrado, Recibos | Token de API | Envie `userSecurityToken` como parâmetro (query/body) ou `securityToken` como header | | WhatsApp | HTTP Basic | `Authorization: Basic base64(email:securityToken)` | > As rotas de **consulta** de carta e e-mail (`get`, `balance`, `download`, > `delete`) recebem o token como o primeiro segmento de **caminho** da URL — > ex.: `/api/v2/get/{securityToken}/{job_id}`. ## Envelopes de resposta A maioria dos endpoints responde com o envelope padrão `{"status": , "status_message": "...", "data": ...}` — isso cobre Cartas/Telegrama, E-mail Registrado e os endpoints de mensagens e remetentes de WhatsApp. Os endpoints de **modelos** de WhatsApp (e a sincronização de modelos) usam `{"code": , "status": "success|error", "message": "...", "data": ..., "request_id": "..."}`; o endpoint de logo usa o mesmo formato sem `request_id`. Consulte o schema de cada endpoint. Uma requisição aceita retorna HTTP `200` com o payload de sucesso; problemas de validação retornam `400`, credenciais inválidas `401` e acesso negado `403`. Métodos HTTP não suportados retornam `405`, tentativas repetidas de autenticação falhas retornam `429` e os endpoints de carta e e-mail retornam `503` durante janelas de manutenção. contact: name: Suporte Escrybe url: https://escrybe.com.br servers: - url: https://app.escrybe.com.br description: Produção - url: https://homolog.escrybe.com.br description: Homologação security: - securityTokenQuery: [] tags: - name: Letters & Telegram description: Crie e gerencie pedidos de carta, telegrama e e-Carta (Correios). - name: Account & Favorites description: Saldo da conta, contatos salvos e logo do remetente. - name: Registered E-mail description: Envie e acompanhe e-mails registrados juridicamente. - name: WhatsApp Messages description: Envie mensagens de WhatsApp e baixe atestações com carimbo de tempo. - name: WhatsApp Senders description: Gerencie números do WhatsApp Business (remetentes). - name: WhatsApp Templates description: Crie, sincronize e gerencie modelos de mensagem do WhatsApp. - name: Receipts description: Baixe recibos legais de qualquer pedido. paths: /api/whatsapp/v1/post: post: tags: - WhatsApp Messages summary: Enviar uma mensagem de WhatsApp description: > O telefone do destinatário é normalizado para E.164 e verificado como número de WhatsApp — requisições para números fora do WhatsApp são rejeitadas com 400. operationId: sendWhatsappMessage requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SendWhatsappRequest' multipart/form-data: schema: $ref: '#/components/schemas/SendWhatsappRequest' responses: '200': description: Mensagem criada e aguardando pagamento content: application/json: schema: allOf: - $ref: '#/components/schemas/WaMessagesEnvelope' - properties: data: $ref: '#/components/schemas/WhatsappCreateResult' '400': $ref: '#/components/responses/WaMsgBadRequest' '401': $ref: '#/components/responses/WaMsgUnauthorized' '403': $ref: '#/components/responses/WaMsgForbidden' '500': $ref: '#/components/responses/WaMsgServerError' security: - basicAuth: [] components: schemas: SendWhatsappRequest: type: object required: - sender_name - sender_document - recipient_name - recipient_phone - recipient_document - template_id - paymentMethod properties: sender_name: type: string sender_document: type: string description: CPF/CNPJ do remetente. recipient_name: type: string recipient_phone: type: string description: Normalizado para E.164. recipient_document: type: string template_id: type: integer description: > Deve ser um modelo aprovado pertencente ao remetente selecionado. Com remetentes de sistema, o modelo deve ter sido criado por você (ou pelo dono do seu time) ou ser compartilhado. paymentMethod: type: string enum: - escrybe_credits - invoice - team team_member_id: type: integer description: Obrigatório quando paymentMethod=team. body: type: string maxLength: 4096 template_variables: type: object description: >- Mapa de substituições das variáveis do modelo. Deve cobrir ao menos a quantidade de variáveis do modelo. media_url: type: string description: >- Um entre media_url/media_file/media_base64 é obrigatório quando o formato do cabeçalho do modelo é IMAGE ou DOCUMENT. media_filename: type: string media_file: type: string format: binary description: >- IMAGE JPEG/PNG ≤5MB; DOCUMENT PDF ≤100MB. PDFs com senha são rejeitados. media_base64: type: string sender_choice: type: string default: system description: '`system` ou um remetente específico.' sender_id: type: integer description: Remetente específico a utilizar. WaMessagesEnvelope: type: object description: > Envelope padrão usado pelos endpoints de mensagens e remetentes de WhatsApp (mesmo formato dos envelopes de cartas e e-mail). properties: status: type: integer example: 200 status_message: type: string data: oneOf: - type: object - type: string - type: 'null' WhatsappCreateResult: type: object properties: message_id: type: integer visual_id: type: string status: type: string example: processing paymentMethod: type: string stored_payment_method: type: string description: >- Método de pagamento efetivamente armazenado (faturamento por time é armazenado como invoice). team_member_id: type: integer nullable: true template_id: type: integer template_name: type: string sender_id: type: integer responses: WaMsgBadRequest: description: Requisição inválida content: application/json: schema: $ref: '#/components/schemas/WaMessagesEnvelope' example: status: 400 status_message: Campos obrigatórios não preenchidos data: null WaMsgUnauthorized: description: Não autorizado — credenciais inválidas content: application/json: schema: $ref: '#/components/schemas/WaMessagesEnvelope' example: status: 401 status_message: Unauthorized - invalid credentials data: null WaMsgForbidden: description: Acesso negado content: application/json: schema: $ref: '#/components/schemas/WaMessagesEnvelope' WaMsgServerError: description: Erro interno content: application/json: schema: $ref: '#/components/schemas/WaMessagesEnvelope' securitySchemes: securityTokenQuery: type: apiKey in: query name: userSecurityToken description: >- Seu token de segurança, enviado como parâmetro `userSecurityToken` (query ou form). basicAuth: type: http scheme: basic description: >- HTTP Basic onde o usuário é o e-mail da conta e a senha é o token de segurança. ````