SMSFire Docs
Criar contaLogin
  • Bem vindo(a)
  • Atualizações
  • Documentação Técnica
  • Autenticação
  • Rate limiter
  • Account
    • Consulta saldo
  • SMS
    • Enviar mensagem
    • Consulta Status
    • Inbox
    • Caracteres e concatenação
    • Agendamento de mensagens
    • Fracionador de envios
    • Código de status
  • WhatsApp
    • Consultar instância
    • Enviar mensagem
    • Consulta Status
    • Mensagens recebidas
    • Código de status
    • Sessões
  • Bigdata
    • Enviar consulta
    • Consultar queries
    • Código de status
  • HTTP CODES
  • SDKs
Powered by GitBook
On this page
  • Listar sessões
  • Sessões ativas
  • Campos JSON das sessões
  1. WhatsApp

Sessões

Acesse a sua lista de sessões ativas

PreviousCódigo de statusNextBigdata

Last updated 3 years ago

Listar sessões

A partir deste serviço você terá acesso aos detalhes de cada uma das sessões abertas e ativas relacionada a instância informada na query.

Fique atento quanto ao de requisições para o correto funcionamento da API.

Sessões ativas

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

Obtenha a lista completa de sessões ativas na instância pesquisada. Sessões finalizadas são descartadas do sistema.

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

Path Parameters

Name
Type
Description

token*

string

Token da instância

Headers

Name
Type
Description

Auhorization*

string

Basic <Token>

[
  {
    "id": 0002,
    "tags": null,
    "cost": 0.1,
    "country": "55",
    "phone": "5511944556677",
    "openDate": "2021-08-06T10:00:56-0300",
    "closeDate": "2021-08-07T10:00:56-0300"
  },
  {
    "id": 0001,
    "tags": ['cliente','potencial'],
    "cost": 0.1,
    "country": "55",
    "phone": "5511966778899",
    "openDate": "2021-08-03T18:15:12-0300",
    "closeDate": "2021-08-04T18:15:12-0300"
  }
]

Campos JSON das sessões

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

Campo

Tipo

Descrição

id

int

Id da sessão

tags

array/null

Matriz de etiquetas de identificação

As tags são adicionadas somente via Dashboard

cost

float

Valor debitado do usuário principal na abertura da sessão

phone

string

Telefone do contato em formato internacional

openDate

string

Data da abertura da sessão (ISO8601)

closeDate

string/null

Data de encerramento da sessão (ISO8601)

rate-limit
Sessões