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 possui um rate-limit diferente dos demais serviços. O limite de consumo deste serviço são de 2 requisições a cada 60 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> |
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 |
---|---|---|
| string | Nome da instância |
| float | Valor pago na criação da instância |
| boolean | Marca mensagens recebidas como lida no aplicativo |
| array | Lista de números a serem ignorados no recebimento de mensagens |
| boolean | Indica se a instância está sincronizada a alguma conta |
| int | Código do último status da instância |
| string | Nome do último status da instância |
| string | Data da última atualização de estado da instância (ISO8601) |
| 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.
Last updated