GET api/v1/fila

Retorna evento da fila

Limite: 80 requisições por minuto

Descrição

Retorna evento da fila.

Para que o sistema possa adicionar os eventos na fila:
1 - acesse sua conta de desenvolvedor
2 - clique em sua aplicação
3 - clique na loja que deseja configurar
4 - clique no ícone modulo de comunicação (editar modulo: webhook ou fila)
5 - em tipo de comunicação: selecione a opção fila
6 - em eventos selecione o deseja adicionar na fila
7 - clique em confirmar

Após o GET - api/v1/fila o documento irá para o final da fila e será removido somente após a execução do DELETE - api/v1/fila/{idDocumento}

Você também pode optar em receber os eventos por Webhook ou pesquisar os eventos na fila.

Parâmetros de Retorno

Campo Descrição Tipo Tamanho
documento Código do documento para utilização do método delete string 255
tipo Tipo do JSON. Exemplo: Conversa, Aplicativo, novoAgente, etc string 255
dados informações do webhook object
Aplicativo Para desinstalação de aplicativo
codigo código da loja string
situacao situação do evento string
mensagem mensagem detalhada do evento string
idApp código da sua aplicação string
nomeApp nome da sua aplicação string
data data do processamento string

Exemplo de Resposta

JSON 
Para conversa:
{
	"documento": "",
	"tipo": "Conversa",
	"dados": {
		"idSession": "",
		"mensagem": "",
	}
}

Para desinstalação de aplicativo:
{
	"documento": "",
	"tipo": "Aplicativo",
	"dados": {
		"codigo": "",
		"situacao": "delete",
		"mensagem": "A aplicação foi desinstalada",
		"idApp": 0,
		"nomeApp": "",
		"data": "2022-08-11 09:53:00"
	}
}