Click to chat

Inicia um atendimento de WhatsApp via API (click-to-chat). type: "click_to_chat".

Atributos

• phone (string): Telefone que receberá a mensagem. Obrigatório se meta_user_id não for fornecido. Para celulares brasileiros, o dígito 9 pode ser adicionado automaticamente; nesse caso message e phone retornam na resposta com a correção aplicada.
• meta_user_id (string): Identificador Meta (BSUID) do destinatário; alternativa ao telefone para clientes sem número vinculado. Obrigatório se phone não for fornecido.
• inbound_number_id (number): Id do número WhatsApp usado para enviar. Obrigatório se inbound_number_phone não for fornecido.
• inbound_number_phone (string): Telefone do número WhatsApp usado para enviar. Obrigatório se inbound_number_id não for fornecido.
• template_id (number, opcional): Id do template WhatsApp a usar na mensagem.
• queue_id (number): Id da Fila de WhatsApp para encaminhar o atendimento. Obrigatório se target_type = 1.
• workflow_id (number): Id do Fluxo para encaminhar. Obrigatório se target_type = 2.
• user_id (number): Id do agente para encaminhar. Obrigatório se target_type = 3 ou 4.
• customer_id (number, opcional): Cliente a associar ao atendimento e popular variáveis de template.
• template_variables (JSON, opcional): Valores das variáveis do template. Formato { “body”: { “1”: “Valor 1”, “2”: “Valor 2” } } onde a chave é o nome da variável.
• target_type (enum): Para onde encaminhar o atendimento:
  • 1 — Fila de WhatsApp
  • 2 — Fluxo
  • 3 — Agente (sem confirmação)
  • 4 — Agente (com confirmação)
• terminate_ongoing_conversation (boolean, opcional): Encerra o atendimento em andamento do destino (só se estiver em ‘Esperando resposta’). true encerra; false mantém.

Resposta: protocol (number, exceto target_type = 4), success (boolean), message (string, quando dígito 9 é adicionado), phone (string, idem), error_code (string, em falha).