API Mensagem de Texto

🧩 Envia uma mensagem de texto, com opções de abrir um ticket e atribuir a conversa à uma fila.

API: Básica, Pro

Verifique aqui os Pré-Requisitos para utilizar APIs

Endpoint

https://{BACKEND_URL}/api/messages/send

Método

POST

Autenticação

Bearer {seutokenaqui}

Payload

{
    "number": "554498108792",
    "openTicket": "1",
    "queueId": "16", 
    "body": "Bem vindo Lead"
  }

➡️ “number”: telefone do destinatário no formato ddi ddd numero (somente números). ➡️ “openTicket”: 0 Não abre ticket 1 Ticket – Atenção: para abrir ticket é obrigatório definir uma fila. – ao abrir ticket a conversa irá para aguardando mesmo que já esteja em atendimento. ➡️ “queueId”: ID da fila desejada ( Só funciona quando "openTicket": "1" )

➡️ “body”: Mensagem. ###### Modelos

PHP Utilize o código em requisições HTTPS com ferramentas como cURL ou bibliotecas de integração.

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{BACKEND_URL}/api/messages/send',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "number": "554498108792",
    "openTicket": "0",
    "queueId": "0", 
    "body": "Olá, tudo bem?"
  }',
  // "openTicket": "0", 0 Não abre ticket e 1 Abre Ticket
  // "queueId": "0", ID da fila desejada (necessário definir se abrir ticket)
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer {seutokenaqui}' //Token cadastrado na conexão
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

FLOWBUILDER Insira o código em um bloco de “Http Request / Code” do tipo REQUISIÇÃO.

Os trechos delimitados por {{...}} são placeholders no formato Mustaches e não precisam ser alterados. Eles serão automaticamente substituídos pelos valores correspondentes no momento da execução.

// definir
let endpoint = "https://{{backendURL}}/api/messages/send";
let method = "POST";
let payload = {
    "number": "{{number}}",
    "openTicket": "0",
    "queueId": "0",
    "body": "Mensagem enviada pelo FlowBuilder"
};
let authorization = "{{connection_token}}";
// estrutura
try {
    const response = await axios({
      url: endpoint,
      method: method,
      headers: {
        'Content-Type': 'application/json',
        'Authorization': 'Bearer ' + authorization
      },
      data: payload,
      maxBodyLength: Infinity
    });
    return response.data;
} catch (error) {
    return "Algo deu errado: " + error.message;
}

PHP Utilize o código em requisições HTTPS com ferramentas como cURL ou bibliotecas de integração.

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{BACKEND_URL}/api/messages/send',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "number": "554498108792",
    "openTicket": "0",
    "queueId": "0", 
    "body": "Olá, tudo bem?"
  }',
  // "openTicket": "0", 0 Não abre ticket e 1 Abre Ticket
  // "queueId": "0", ID da fila desejada (necessário definir se abrir ticket)
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer {seutokenaqui}' //Token cadastrado na conexão
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

FLOWBUILDER Insira o código em um bloco de "Http Request / Code" do tipo REQUISIÇÃO.

Os trechos delimitados por {{...}} são placeholders no formato Mustaches e não precisam ser alterados. Eles serão automaticamente substituídos pelos valores correspondentes no momento da execução.

// definir
let endpoint = "https://{{backendURL}}/api/messages/send";
let method = "POST";
let payload = {
    "number": "{{number}}",
    "openTicket": "0",
    "queueId": "0",
    "body": "Mensagem enviada pelo FlowBuilder"
};
let authorization = "{{connection_token}}";
// estrutura
try {
    const response = await axios({
      url: endpoint,
      method: method,
      headers: {
        'Content-Type': 'application/json',
        'Authorization': 'Bearer ' + authorization
      },
      data: payload,
      maxBodyLength: Infinity
    });
    return response.data;
} catch (error) {
    return "Algo deu errado: " + error.message;
}