Pegar chats – Central de Atendimento

Este método é responsável por retornar todos os chats.

/chats

Tipo	URL
`GET`	https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/chats

Atributos

Obrigatórios

Atributos	Tipo	Descrição
page	integer	Utilizado para paginação você de informar aqui a página de chats que quer buscar.
pageSize	integer	Especifica o tamanho do retorno de chats por página.

Request Body:

Tipo	URL
`GET`	https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/chats

Response

200

Atributos	Tipo	Descrição
name	string	Nome atribuído ao chat, lembrando que se for um grupo ou lista de transmissão deve retornar os respectivos IDs
phone	string	Phone do contato
unread	string	indica o número de mensagens não lidas em um chat
lastMessageTime	string	Timestamp com a data e hora da última interação com o chat
isMuted	string	0 ou 1 indica se você silenciou ou não este chat
isMarkedSpam	boolean	true ou false indica se você marcou este chat como spam
messagesUnread	integer	descontinuado

Exemplo:

[
 {
"name": "PlugMessage SUPORTE",
"phone": "5511999999999",
"unread": "0",
"lastMessageTime": "1622991687",
"isMuted": "0",
"isMarkedSpam": "false",
"profileThumbnail": null,
"messagesUnread": 0
 },
 {
"name": "PlugMessage - Team",
"phone": "5511999999999",
"unread": "0",
"lastMessageTime": "1622990503",
"isMuted": "0",
"isMarkedSpam": "false",
"profileThumbnail": "https://pps.whatsapp.net/v/t61.24694-24/170931400_212202650511993_3423338295209291992_n.jpg?ccb=11-4&oh=4b96b3bf7114122667f80d021b194f2c&oe=60C179E2",
"messagesUnread": 0
 }
]

405

Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o "Content-Type" do objeto que você está enviando, em sua grande maioria "application/json"

Alguns exemplos para auxiliar a implementação

Exemplo em C#

var client = new RestClient("https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/chats?page=1&pageSize=2");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);

Exemplo em PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/chats?page=1&pageSize=2",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo"cURL Error #:" . $err;
} else {
echo $response;
}

Exemplo em Node.js

var http = require("https");

var options = {
"method": "GET",
"hostname": "api.plugzapi.com.br",
"port": null,
"path": "/instances/SUA_INSTANCIA/token/SEU_TOKEN/chats?page=1&pageSize=2",
"headers": {}
};

var req = http.request(options, function (res) {
var chunks = [];

res.on("data", function (chunk) {
chunks.push(chunk);
});

res.on("end", function () {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
});

req.end();

/chats

Request Body:

Response

Artigos relacionados