Consultar instância

Consulte todos os dados da sua instância.

A partir deste serviço você poderá consultar os dados da sua instância, assim como inicializar o disparo do Webhooks de qrcode para realizar a sincronização.

Este serviço possuí uma limitação de rate-limit diferente dos demais serviços. Neste serviço o limite são de 2 (duas) requisições a cada 120 segundos.

Estado da instância

As informações dadas neste serviço sobre a instância é referente ao último estado e não o atual.

Qrcode para sincronização

Os dados do qrcode para a sincronização do seu número a instância serão enviados por Webhooks ao endpoint que você registrar em nosso Portal.

O envio dos dados será iniciado quando o último estado da instância for identificado como FALSE em paired

Estado e emissão de qrcode

GET https://api-v2.smsfire.com.br/whatsapp/instances/:Token

Atenção: Campos com * (asterisco) são obrigatórios

Path Parameters

Name	Type	Description
token*	string	Token da instância

Headers

Name	Type	Description
Authorization*	string	Basic <Token>

200: OK Objeto JSON

{
	"name": "minha instância",
 	"cost": 45,
	"markAsRead": true,
	"ignoreList": ['5511944556677','15555550001'],
	"paired": true,
	"statusCode": 1,
	"statusName": "ONLINE",
	"updateDate": "2022-02-03T15:47:53-0300",
	"creationDate": "2022-02-03T12:06:11-0300"
}

Campos JSON da instância

A API retornará o código HTTP 204 No Content quando não encontrar nenhum dado da instância pesquisada e o corpo da resposta será vazio.

Campo	Tipo	Descrição
name	string	Nome da instância
cost	float	Valor pago na criação da instância
markAsRead	boolean	Marca mensagens recebidas como lida no aplicativo
ignoreList	array	Lista de números a serem ignorados no recebimento de mensagens
paired	boolean	Indica se a instância está sincronizada a alguma conta
statusCode	int	Código do último status da instância
statusName	string	Nome do último status da instância
updateDate	string	Data da última atualização de estado da instância (ISO8601)
creationDate	string	Data de criação da instância (ISO8601)

Acesse a página Código de status para ter informações detalhadas sobre cada um dos códigos fornecidos pelo serviço.