Gateway (endpoint HTTP)

Este endpoint retorna a URL do Gateway para bots, a contagem de shards recomendada e os limites de início de sessão anunciados. Consulte a visão geral do Gateway para o protocolo WebSocket.

Use um token de bot. Clientes de usuário lêm endpoints.gateway da descoberta de instância e enviam seu token de sessão em Identify.

Objeto de informações do Gateway

Todos os campos estão sempre presentes.

Estrutura

Campo	Tipo	Descrição
url	string	A URL ws ou wss, idêntica a endpoints.gateway na descoberta de instância
shards	integer	Contagem de shards recomendada, sempre 1
session_start_limit	limite de início de sessão object	Valores fixos de início de sessão

O Decoding Chat não anexa query string, portanto um cliente adiciona os parâmetros de conexão ele mesmo. Um cliente NÃO DEVE reescrever um valor ws publicado como wss, pois uma implantação que deliberadamente serve HTTP simples anuncia um valor ws.

Exemplo

{
  "url": "wss://gateway.example.com",
  "shards": 1,
  "session_start_limit": {
    "total": 1000,
    "remaining": 999,
    "reset_after": 14400000,
    "max_concurrency": 1
  }
}

Identify aceita um par shard cujo elemento shard_count vai de 1 a 16.384 conforme o contrato de sharding, qualquer que seja o valor reportado por shards. Uma sessão de bot cujo shard é atribuído com mais de 2.500 servidores fecha com 4011, e o bot deve usar mais shards. Uma sessão de usuário nunca é verificada contra o teto de servidores.

Objeto de limite de início de sessão

Estes são valores fixos de compatibilidade, não contadores de uso em tempo real.

Estrutura

Campo	Tipo	Descrição
total	integer	Inícios de sessão permitidos reportados, sempre 1000
remaining	integer	Inícios de sessão restantes reportados, sempre 999
reset_after	integer	Intervalo de reinício reportado em milissegundos, sempre 14400000 (quatro horas)
max_concurrency1	integer	Buckets de Identify concorrentes reportados, sempre 1

¹ Um bot não precisa controlar o ritmo de requisições Identify contra este valor

Os limites que o Gateway aplica estão em Ciclo de vida da sessão. O Decoding Chat aplica rate limit de Identify por endereço de origem e limita uma conta de usuário a um número fixo de sessões concorrentes. Nenhum dos dois limites é reportado aqui.

Um início de sessão restante não garante admissão

Estes valores não reservam capacidade. A admissão de sessão ainda pode suspender ou rejeitar uma conexão.

Obter informações do Gateway

GET/v1/gateway/botBot

Retorna um objeto de informações do Gateway.

As formas aceitas são Bot <token>, Bearer <token> e <token>. Os prefixos ignoram capitalização e espaços em torno do token são removidos. O token deve conter um ponto com dígitos decimais antes dele e pelo menos um caractere após, e não deve começar com flx_.

Apenas o formato do token é verificado

A rota verifica apenas a forma da credencial. Um valor bem formado que não nomeia nenhuma aplicação ativa recebe o mesmo 200 que um token de bot real.

Valide um token com Identify ou Obter aplicação de bot.

Um 200 tem os cabeçalhos de rate limit informativos apenas para o prefixo Bot . Para a forma simples e o prefixo Bearer , o Decoding Chat associa o bucket de rate limit ao endereço IP do cliente.

Resposta

Status	Corpo	Condição
200	informações do Gateway object	A credencial está no formato de token de bot
4011	resposta de erro	A credencial está ausente, está vazia após seu prefixo de esquema, ou não está no formato de token de bot

¹ Uma credencial ausente ou vazia usa MISSING_AUTHORIZATION, e todo outro valor rejeitado usa INVALID_AUTH_TOKEN

Efeitos colaterais

Use o prefixo de autorização Bot . Autenticação inválida repetida pode acionar as proteções contra abuso.

Rate limit

60 requisições por minuto para cada conta autenticada, ou para cada endereço IP do cliente quando nenhuma conta foi resolvida, no bucket gateway:bot_info.