Este método é responsável por retornar todos os contatos do Whatsapp. Lembre-se do que foi dito na introdução sobre número de contatos, caso tenha pulado essa parte, sugiro que você volte um passo e leia a nossa introdução sobre contatos.
/contacts
Tipo | URL |
GET |
https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/contacts |
Atributos obrigatórios
Atributos | Tipo | Descrição |
---|---|---|
page | integer | Utilizado para paginação você deve informar aqui a página de contatos que quer buscar. |
pageSize | integer | Especifica o tamanho do retorno de contatos por página. |
Request Body:
Tipo | URL |
GET |
https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/contacts?page=1&pageSize=20 |
Response
200
Atributos | Tipo | Descrição |
---|---|---|
phone | string | Phone do contato |
name | string | Nome e sobrenome do contato, só vai retornar preenchido caso você tenha o número em seus contatos |
short | string | Nome do contato, só vai retornar preenchido caso você tenha o número em seus contatos |
vname | string | Nome do contato caso você tenha ele como contato |
notify | string | Nome informado nas configurações de nome do Whatsapp |
Exemplo:
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/contacts?page=1&pageSize=100");
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/contacts?page=1&pageSize=100",
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/contacts?page=1&pageSize=100",
"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();
Comentários
0 comentário
Por favor, entre para comentar.