Método utilizado para listar todas as instâncias criadas.
/instances
Tipo | URL |
GET |
https://api.plugzapi.com.br/instances |
Atributos obrigatórios
Atributos | Tipo | Descrição |
---|---|---|
page | integer | Utilizado para paginação você de informar aqui a pagina de chats que quer buscar |
pageSize | integer | Especifica o tamanho do retorno de chats por pagina |
Opcionais
Atributos | Tipo | Descrição |
---|---|---|
query | number | Busca pelo nome e id da instancia |
Request Body:
Tipo | URL |
GET |
https://api.plugzapi.com.br/instances |
Key | Value | Description |
query | 999999999999 | |
pageSize | 1 | |
page | 1 |
Response
200
Atributos | Tipo | Descrição |
---|---|---|
id | string | ID da instância criada |
token | string | TOKEN da instância criada |
due | timestamp | Data de validade da instância |
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 PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.plugzapi.com.br/instances",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => "{\"pageSize\": \"1\", \"page\": \"1\", \"query\": \"8823XWIE982KII99012K2L\"}",
CURLOPT_HTTPHEADER => array(
"authorization: Bearer SEU-TOKEN-AQUI",
"content-type: application/json"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo"cURL Error #:" . $err;
} else {
echo $response;
}
var http = require("https");
var options = {
"method": "GET",
"hostname": "api.plugzapi.com.br",
"port": null,
"path": "/instances",
"headers": {
"authorization": "Bearer SEU-TOKEN-AQUI"
}
};
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.write(JSON.stringify({pageSize: '1', page: '1', query: '8823XWIE982KII99012K2L'}));
req.end();
var client = new RestClient("https://api.plugzapi.com.br/instances");
var request = new RestRequest(Method.GET);
request.AddHeader("content-type", "application/json");
request.AddHeader("authorization", "Bearer SEU-TOKEN-AQUI");
request.AddParameter("undefined", "{\"pageSize\": \"1\", \"page\": \"1\", \"query\": \"8823XWIE982KII99012K2L\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Comentários
0 comentário
Por favor, entre para comentar.