API
5min
Através da API, é possível enviar mensagens de texto, áudio, vídeo, documentos e interagir com a plataforma / usuários de forma remota.
Abaixo, os endpoints disponíveis:
PHP
1<?php
2
3$curl = curl_init();
4
5curl_setopt_array($curl, array(
6 CURLOPT_URL => 'https://{BACKEND_URL}/api/messages/send',
7 CURLOPT_RETURNTRANSFER => true,
8 CURLOPT_ENCODING => '',
9 CURLOPT_MAXREDIRS => 10,
10 CURLOPT_TIMEOUT => 0,
11 CURLOPT_FOLLOWLOCATION => true,
12 CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13 CURLOPT_CUSTOMREQUEST => 'POST',
14 CURLOPT_POSTFIELDS =>'{
15 "number": "5511993231592", //Telefone em formato Whatsapp
16 "openTicket": "0", //0 Não abre ticket e 1 Abre Ticket
17 "queueId": "0", // Informe o ID da fila desejada (Se abrir ticket)
18 "body": "Teste"
19 }',
20 CURLOPT_HTTPHEADER => array(
21 'Content-Type: application/json',
22 'Authorization: Bearer seutokenaqui' //Token cadastrado na conexão
23 ),
24));
25
26$response = curl_exec($curl);
27
28curl_close($curl);
29echo $response;
30
Retorno com sucesso:
JSON
1{
2 "mensagem": "Mensagem enviada"
3}
PHP
1<?php
2
3$curl = curl_init();
4
5curl_setopt_array($curl, array(
6 CURLOPT_URL => 'https://{BACKEND_URL}/api/messages/send',
7 CURLOPT_RETURNTRANSFER => true,
8 CURLOPT_ENCODING => '',
9 CURLOPT_MAXREDIRS => 10,
10 CURLOPT_TIMEOUT => 0,
11 CURLOPT_FOLLOWLOCATION => true,
12 CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13 CURLOPT_CUSTOMREQUEST => 'POST',
14 CURLOPT_POSTFIELDS => array(
15 'medias'=> new CURLFILE('IMAGEM.JPEG'),
16 'number' => '5511993231592',
17 'openTicket' => '0', //0 Não abre ticket e 1 Abre Ticket
18 'queueId' => '0', // Informe o ID da fila desejada (Se abrir ticket)
19 'body' => 'Teste' // Se enviado aparecerá como caption (Se abrir ticket)
20 ),
21 CURLOPT_HTTPHEADER => array(
22 'Authorization: Bearer seutokenaqui' //Token cadastrado na conexão
23 ),
24));
25
26$response = curl_exec($curl);
27
28curl_close($curl);
29echo $response;
30
31
Retorno com sucesso:
JSON
1{
2 "mensagem": "Mensagem enviada"
3}
PHP
1<?php
2
3$curl = curl_init();
4
5curl_setopt_array($curl, array(
6 CURLOPT_URL => 'https://{BACKEND_URL}/api/messages/finish',
7 CURLOPT_RETURNTRANSFER => true,
8 CURLOPT_ENCODING => '',
9 CURLOPT_MAXREDIRS => 10,
10 CURLOPT_TIMEOUT => 0,
11 CURLOPT_FOLLOWLOCATION => true,
12 CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13 CURLOPT_CUSTOMREQUEST => 'POST',
14 CURLOPT_POSTFIELDS =>'{
15 "companyId": "1", //Id da Empresa
16 "ticketId": "98" // Id do Ticket
17 }',
18 CURLOPT_HTTPHEADER => array(
19 'Authorization: Bearer seutokenaqui' //Token cadastrado na conexão
20 ),
21));
22
23$response = curl_exec($curl);
24
25curl_close($curl);
26echo $response;
27
Retorno com sucesso:
JSON
1{
2 "res": {
3 "id": 98,
4 "status": "closed",
5 "unreadMessages": 0,
6 "lastMessage": "Mensagem de teste",
7 "isGroup": false,
8 "userId": null,
9 "contactId": 1,
10 "whatsappId": 2,
11 "queueId": null,
12 "chatbot": false,
13 "channel": "whatsapp",
14 "queueOptionId": null,
15 "companyId": 1,
16 "uuid": "82291813-86f8-4504-b7d5-c562c6123129",
17 "createdAt": "2023-07-25T14:20:59.917Z",
18 "updatedAt": "2023-08-13T15:56:14.759Z"
19 }
20}
Updated 25 Mar 2024
Did this page help you?
