Este método é responsável por retornar todas mensagens que estão em sua fila aguardando para ser processada.
/queue
| Tipo | URL |
GET |
https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/queue |
Atributos opcionais
| Atributos | Tipo | Descrição |
|---|---|---|
| count | string | Atributo utilizado para retornar o número de mensagens na fila |
Request Body:
| Tipo | URL |
GET |
https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/queue |
Ou
| Tipo | URL |
GET |
https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/queue/count |
Response
200
| Atributos | Tipo | Descrição |
|---|---|---|
| messages | array string | Array com as mensagens da fila |
Array Messages
| Atributos | Tipo | Descrição |
|---|---|---|
| _id | string | ID da mensagem no PlugMessage |
| DelayMessage | string | Tempo em segundos entre o envio das mensagens |
| Message | string | Texto da Mensagem |
| IsTrial | boolean | Indica se a instância está utilizando trial |
| InstanceId | string | ID da instância |
| Phone | string | Número do destinatário |
| ZaapId | string | ID da mensagem no PlugMessage |
| DelayTyping | string | Duração do indicador do chat "digitando..." |
| MessageId | string | ID da mensagem |
| Created | timetamp | Data da mensagem |
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 PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/queue",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"accept: application/json"
),
));
$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/queue",
"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();
Exemplo em C#
var client = new RestClient("https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/queue");
var request = new RestRequest(Method.GET);
request.AddHeader("accept", "application/json");
IRestResponse response = client.Execute(request);
Comentários
0 comentário
Por favor, entre para comentar.