Envia uma mensagem de texto via WhatsApp usando o terminal especificado.

1. Requisição HTTP

POST https://www.keymessages.com.br/api/terminal/SendTextMessage
                

2. Cabeçalhos

3. Corpo da Requisição (JSON)

{
    "PhoneNumber": "+5537998256429",
    "Message": "Hello World"
}
                

4. Resposta Exemplo

Retorna HTTP 200 e um JSON confirmando o envio:

{
    "success": true,
    "messageId": "abc123",
    "timestamp": "2025-05-19T13:00:00Z"
}
                

5. Exemplo de cURL

curl --request POST \
    --url https://www.keymessages.com.br/api/terminal/SendTextMessage \
    --header 'Content-Type: application/json' \
    --header 'UserToken: TokenDoUsuario' \
    --header 'TerminalToken: TokenDoTerminal' \                      
    --data '{
    "PhoneNumber": "+5537990000000",
    "Message": "Hello World"
}'
                

6. Possíveis Erros

• 401 Unauthorized Ocorre quando algum token está ausente, inválido ou há crédito insuficiente:
  • **UserToken** ausente ou vazio
    Resposta:

    HTTP/1.1 401 Unauthorized
    {
        "mensagem": "O Token do usuario é necessário. [UserToken]"
    }
                                    

  • **TerminalToken** ausente ou vazio
    Resposta:

    HTTP/1.1 401 Unauthorized
    {
        "mensagem": "O Token do terminal é necessário. [TerminalToken]"
    }
                                    

  • **UserToken** inválido (não encontrado no repositório)
    Resposta:

    HTTP/1.1 401 Unauthorized
    {
        "mensagem": "O Token do usuario é inválido. [UserToken]"
    }
                                     

  • **TerminalToken** inválido (não pertence ao usuário)
    Resposta:

    HTTP/1.1 401 Unauthorized
    {
        "mensagem": "O Token do Terminal é inválido. [TerminalToken]"
    }
                                    

  • Crédito insuficiente para débito
    Resposta:

    HTTP/1.1 401 Unauthorized
    {
        "mensagem": "Você não possui crédito(s) suficiente."
    }
                                    

• 400 Bad Request Falha na validação do corpo da requisição ou erro no envio:
  • **Body** nulo
    Resposta:

    HTTP/1.1 400 Bad Request
    {
        "mensagem": "Os dados para envio é necessário. [Body]"
    }
                                    

  • **PhoneNumber** em branco ou nulo
    Resposta:

    HTTP/1.1 400 Bad Request
    {
        "mensagem": "O Telefone Whatsapp é necessário. [PhoneNumber]"
    }
                                    

  • **Message** em branco ou nulo
    Resposta:

    HTTP/1.1 400 Bad Request
    {
        "mensagem": "A mensagem é necessária. [Message]"
    }
                                    

  • **Erro genérico** durante o envio de mensagem
    Resposta (exemplo com mensagem de exceção):

    HTTP/1.1 400 Bad Request
    {
        "mensagem": "Descrição detalhada do erro interno"
    }
                                    

• 500 Internal Server Error Para exceções não tratadas fora do bloco de envio ou falhas inesperadas no servidor:

  HTTP/1.1 500 Internal Server Error
  {
      "mensagem": "Algo deu errado no servidor. Tente novamente mais tarde."
  }