Pular para o conteúdo principal

Pegar contatos

Método#

/contacts#

GET https://www.plugchat.com.br/api/whatsapp/contacts

Header#

Toda requisição http feita precisa passar sua header de autorização.#

KeyValue
Authorization:1nEFbU3EktLnV7LIIzX

Conceituação#

Este método é reponsável por retornar todos os contatos do Whatsapp. Lembre-se do que foi dito na introdução sobre número de contatos, caso tenho pulado esta parte, sugiro que você volte um passo e leia a nossa introdução sobre contatos.


Atributos#

Obrigatórios#

AtributosTipoDescrição
pageintegerUtilizado para paginação você deve informar aqui a página de contatos que quer buscar
pageSizeintegerEspecifica o tamanho do retorno de contatos por página

Opcionais#

AtributosTipoDescrição

Request Params#

URL exemplo#

Método

GET https://www.plugchat.com.br/api/whatsapp/contacts?page=1&pageSize=20


Response#

200#

AtributosTipoDescrição
phonestringPhone do contato
namestringNome e sobrenome do contato, só vai retornar preenchido caso você tenha o número em seus contatos
shortstringNome do contato, só vai retornar preenchido caso você tenha o número em seus contatos
vnamestringNome do contato caso você tenha ele como contato
notifystringNome informado nas configurações de nome do Whatsapp

Exemplo

[
{
"name": "Nome e sobrenome do contato 1",
"short": "Nome do contato 1",
"notify": "Nome no Whatsapp 1",
"vname": "Nome no vcard",
"phone": "559999999999"
}
]

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"


Code#