Enviar mensagem HSM

POST

/chatclient/mediagateway/v1/whatsapp/hsm_send_message

Envia uma mensagem HSM (template) para um contato do WhatsApp. Requer o token da submídia no cabeçalho da requisição.

Requisição

Parâmetros Bodyapplication/json

Exemplo

{
    "destination": "5548999999999",
    "template": {
        "id": "5b0ssderwer-01fd-4e56-8a40-581c29213eda",
        "text_params": {
            "name": "Fulano",
            "productName": "Carro"
        }
    },
    "contact": {
        "associated_data": "CPF: 00000000000",
        "fidelization": {
            "application": "interact",
            "user": "testador",
            "service": "servico_teste"
        },
        "expire_time": 5
    }
}

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/chatclient/mediagateway/v1/whatsapp/hsm_send_message' \
--header 'Content-Type: application/json' \
--data-raw '{
    "destination": "5548999999999",
    "template": {
        "id": "5b0ssderwer-01fd-4e56-8a40-581c29213eda",
        "text_params": {
            "name": "Fulano",
            "productName": "Carro"
        }
    },
    "contact": {
        "associated_data": "CPF: 00000000000",
        "fidelization": {
            "application": "interact",
            "user": "testador",
            "service": "servico_teste"
        },
        "expire_time": 5
    }
}'

Respostas

🟢200OK

application/json

Sucesso

Body

Exemplo

{
    "response": {
        "command": "hsm_send_message",
        "destination": "5548999999999",
        "status": "ok"
    }
}

🟠400Pedido inválido

🟠401Não autorizado

🔴500Erro do servidor

🔴504Timeout gateway

Modificado em 2024-09-11 19:18:31

Página anterior

Listar templates HSM

Próxima página

Obter informações de fidelização