BatZap

    Envio

    Enviar mensagem

    POSThttps://api.batzap.com/v1/send-message

    Envia uma mensagem de WhatsApp para uma pessoa ou grupo e registra na caixa de entrada. Aceita texto, imagem, vídeo, áudio e mensagem de voz, documento, cartão de contato, enquete, resposta a mensagem e @menções.

    Escolha um tipo de conteúdo por requisição. Se vierem vários, a precedência é: imagem, vídeo, documento, áudio, contatos, enquete, texto.

    A mídia pode ir embutida em base64 ou ser enviada antes com Subir mídia e referenciada por s3_key (recomendado acima de alguns MB). Limite: 20 MB.

    Se to for o id de uma conversa do Crisp, a resposta sai pelo Crisp.

    Em caso de falha o corpo traz error e um error_code: WHATSAPP_DISCONNECTED, TIMEOUT, RATE_LIMITED, INVALID_RECIPIENT ou SEND_FAILED.

    Escopo
    messages:send
    Limite de uso
    Envio · 10/min, 300/dia

    Parâmetros do corpo

    tostringobrigatório

    Destinatário: telefone em E.164 (+5511987654321), JID de grupo (...@g.us) ou id de uma conversa.

    integration_iduuidopcional

    Número de WhatsApp a partir do qual agir (veja Listar integrações). Preenchido automaticamente quando a chave está restrita a um único número.

    messagestringopcional

    Texto, ou a legenda de uma imagem, documento ou áudio.

    imagestring (base64)opcional

    Imagem a enviar.

    videostring (base64)opcional

    Vídeo a enviar. Exige mimetype.

    documentstring (base64)opcional

    Arquivo a enviar. Exige mimetype e filename.

    audiostring (base64)opcional

    Áudio a enviar. Use ptt: true para entregar como mensagem de voz.

    s3_keystringopcional

    Mídia enviada com Subir mídia, no lugar do base64. O tipo vem de mimetype.

    mimetypestringopcional

    Tipo da mídia. Vídeo: video/mp4, video/webm, video/quicktime. Documentos: PDF, CSV, Word, Excel, PowerPoint, texto puro, legendas.

    filenamestringopcional

    Nome do arquivo exibido para um documento.

    pttbooleanopcional

    Envia audio como mensagem de voz.

    quoted_message_idstringopcional

    _id da mensagem a responder. Se ela não for encontrada, a mensagem sai sem a citação.

    mentionsstring[]opcional

    Só em grupos. Telefones a @mencionar; cada um também precisa aparecer como @<numero> em message.

    contactsobjectopcional

    Cartão de contato: { displayName?, contacts: [{ name, phones: [{ number, type? }] }] }.

    pollobjectopcional

    Enquete: { name, values: [2 a 12 opções], selectableCount? }. selectableCount 0 permite marcar quantas opções quiser.

    sender_namestringopcional

    Autor exibido para esta mensagem na caixa de entrada.

    Erros

    400
    to ou conteúdo ausente, tipo de mídia não suportado, arquivo acima de 20 MB ou número sem WhatsApp.
    402
    BILLING_ACCESS_DENIED A assinatura da organização está inativa.
    404
    Conversa, contato ou mídia enviada não encontrados.
    428
    WHATSAPP_DISCONNECTED O número que envia está desconectado ou reconectando.
    503
    NO_SERVER_REASSIGNED O número está sendo movido entre servidores. Tente de novo em alguns segundos.

    Além dos erros que qualquer rota pode devolver: veja Erros.

    AnteriorAtualizar contatoPróximo Subir mídia