Pular para o conteúdo principal

Listando instâncias

Método#

/instances#

GET https://api.z-api.io/instances


Conceituação#

Método utilizado para listar todas as instâncias criadas.


Atributos#

Obrigatórios#

AtributosTipoDescrição
pageintegerUtilizado para paginação você de informar aqui a pagina de chats que quer buscar
pageSizeintegerEspecifica o tamanho do retorno de chats por pagina

Opcionais#

AtributosTipoDescrição
querynumberBusca pelo nome e id da instancia
middlewarestring (web, mobile)Busca pelo tipo da instancia: web ou mobile. Ao não enviar esse parametro, todas as instancias são retornadas

Request Body#

Método

GET https://api.z-api.io/instances?page=1&pageSize=2/

Exemplo

Query params#

keyvaluedescription
query15
middlewareweb
pageSize1
page1

Response#

201#

AtributosTipoDescrição
idstringID da instância criada
tokenstringTOKEN da instância criada
duetimestampData de validade da instância

Exemplo

{
"total": 1,
"totalPage": 1,
"pageSize": 1,
"page": 1,
"content": [
{
"token": "",
"tenant": "",
"created": "",
"due": 1648565999675,
"paymentStatus": "",
"deliveryCallbackUrl": "",
"receivedCallbackUrl": "",
"disconnectedCallbackUrl": "",
"messageStatusCallbackUrl": "",
"receivedAndDeliveryCallbackUrl": "",
"presenceChatCallbackUrl": "",
"connectedCallbackUrl": "",
"receivedStatusCallbackUrl": "",
"phoneConnected": false,
"whatsappConnected": false,
"middleware": "web",
"name": "",
"id": ""
}
]
}

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 inicio 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"


Webhook Response#

Link para a response do webhook (ao receber)

Webhook


Code#