Sign in
latestOpenAPI 3.0.12026-08-1914141.6 MB

c656412a58bc

Chats

Enviar mensagem via Whatsapp

Este método envia uma mensagem via integrações WhatsApp

post/chats/send_message

Request body

numberinteger required

Número de telefone, para o qual a mensagem será enviada.

Por padrão, o sistema vai tentar validar esse telefone como um número brasileiro. Se você deseja inserir um número de outro país, será necessário utilizar o atributo country_code junto no corpo da sua requisição

country_codestring

Código de país no formato <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2" target="_blank">ISO 3166-1 alpha-2</a>

Este atributo será utilizado para validar se o número de telefone informado é um número válido em um outro país diferente do Brasil

messagestring

Conteúdo da mensagem. Utilize esse atributo apenas se você deseja enviar uma mensagem que não é um modelo HSM ou modelo de chat

integration_idinteger required

Identificador de integração

O tipo de integrações permitidas nessa rota são: 'gupshup' e 'whatsapp_cloud'

template_idinteger

Identificador de template - modelo de chat, ou modelo de Início de chat (Gupshup).

Utilize esse atributo se você deseja enviar um modelo HSM ou modelo de chat.

Extra: Se você está utilizando um HSM e deseja enviar parâmetros personalizados no valor das variáveis, utilize o atributo parameters em conjunto a este

namestring

Nome do solicitante

department_idinteger

Identificador de departamento, se você deseja vincular o chat criado a um departamento

ticket_numberinteger

Número do ticket, se você deseja vincular o chat criado a um ticket

client_idinteger

Identificador de cliente, se você deseja vincular o chat criado a um cliente

parametersstring[]

Lista de strings, com os valores personalizados das variáveis do modelo HSM (template_id) que será enviado

header_parametersstring[]

Utilizado apenas em integrações whatsapp_cloud. Lista de strings, com os valores personalizados das variáveis que vão no cabeçalho do modelo HSM (template_id) que será enviado

archiveboolean

Arquivar chat após o envio?

Ao enviar esse atributo como true, o chat será criado e enviado direto para a caixa de encerrados

Example request

{
  "country_code": "US"
}

Response

Agendado o envio da mensagem

statusstring required

Indica que a solicitação foi enfileirada com sucesso

job_idstring required

Identificador do agendamento da solicitação. Em caso de problemas com o envio da mensagem, informe esse ID ao suporte