Voltar para as Rotas da Twitch

Sistema de Fila com Espectadores

Propósito:

Um sistema completo para gerenciamento de filas em transmissões ao vivo, desenvolvido para proporcionar uma experiência organizada e interativa entre streamers e sua comunidade.

Com funcionalidades avançadas como prioridade para inscritos e fechamento automático programado, oferece controle total sobre a participação dos espectadores em jogos, sessões de perguntas, torneios e muito mais.

URL:

https://api.zezofelipe.com.br/twitch/queue/OPÇÃO/TOKEN/USUÁRIO 

Parâmetros da Rota Necessários:

Nome	Descrição	Obrigatório	Tipo
`option`	Opção de ação ou gerenciamento da Fila: `join`, `leave`, `position`, `list`, `link`, `open`, `close`, `clear`, `add`, `remove`, `next`, `stash`, `ban` ou `unban`.	Sim	`string`
`token`	Sequência de 16 caracteres que deve ser mantida em segredo.	Sim	`string`
`user`	Nome do usuário. Para a opção `link`, passa a ser o nome do canal.	Sim	`string`

Parâmetros de Consulta:

Nome	Descrição	Obrigatório	Tipo
`priority`	Permite que o usuário entre na Fila Prioritária.	Não	`boolean`
`scheduledClose`	Define na opção `open` o tempo em minutos para fechamento automático da Fila.	Não	`integer`
`maxSize`	Define na opção `open` a quantidade máxima de usuários na Fila.	Não	`integer`

Aviso

Filas inativas podem ser removidas após 2 meses, mas interações reiniciam esse período.

Configuração

Esse guia irá mostrar como configurar o Sistema de Fila para o seu canal. Atualmente, o bot mais fácil de usar com esse sistema é o StreamElements, portanto baseei-me nele para esse guia.

Passo 1

Acesse a página de configuração para gerar os comandos necessários.

Passo 2

Acesse o painel de comandos personalizados e clique em ADICIONAR NOVO COMANDO. Dê um nome adequado, garanta que não haja conflitos com os já existentes. Embora sejam sugeridos nomes, você pode usar qualquer palavra. Copie e cole o link da variável de API personalizada correspondente na área da resposta.

Passo 3

Configure o nível de permissão adequado para o comando. Garanta que a permissão de moderador esteja definida para todos os comandos de gerenciamento. Salve as alterações e repita o processo para cada um dos outros comandos.

LEMBRE-SE

Você pode atribuir um custo de uso ao comando, mas lembre-se de que esse custo está relacionado ao uso do comando e não tem ligação com a fila em si. Por exemplo, é possível definir um custo de 50 pontos para o comando !entrar, de modo que, ao utilizá-lo, o usuário gaste 50 pontos.

No entanto, se o usuário usar o comando novamente, ele gastará mais 50 pontos e receberá uma mensagem tipo: "Usuário está na posição #1 da Fila Prioritária". Para evitar que os usuários tenham custos adicionais, recomenda-se aplicar um tempo de espera ao comando e orientar os espectadores a verificarem sua posição na Fila antes de tentar entrar, caso já tenham participado. Além disso, seria prudente colocar um tempo de espera no comando !lista para evitar uso excessivo.

Agora a Fila está completamente configurada e pronta para uso. A seguir, uma análise detalhada de cada uma das opções disponíveis.

Opções de Ação

Entrar

Permite que o usuário entre na Fila.

Parâmetro da Rota:

Opção	Exemplo de Uso	Resposta	Observações
`join`	`!entrar`	Talita entrou na Fila! Posição: #1	O usuário pode ocupar apenas um lugar na Fila. Impedido se a Fila estiver fechada ou cheia.

Parâmetros de Consulta:

Nome	Descrição	Tipo
`priority`	O usuário é colocado na Fila Prioritária.	`boolean`

Sair

Permite que o usuário saia da Fila.

Parâmetro da Rota:

Opção	Exemplo de Uso	Resposta	Observações
`leave`	`!sair`	Talita saiu da Fila.	Remove usuário de qualquer lista: Normal, Prioritária ou Reserva.

Posição

Permite que o usuário verifique sua posição atual na Fila.

Parâmetro da Rota:

Opção	Exemplo de Uso	Resposta	Observações
`position`	`!posição`	Talita está na posição #1 da Fila Prioritária.	Permite verificar posição de outros usuários. Exemplo: `!posição @zezofelipe`

Lista

Mostra os usuários na Fila, suas posições e em qual lista estão.

Parâmetro da Rota:

Opção	Exemplo de Uso	Resposta	Observações
`list`	`!lista`	Prioridade: #1. Talita e #2. Zezo. Fila: #3. Milena e #4. Cadamuro. Reserva: #1. Fábio.	Mostra ordenadamente usuários prioritários, fila normal e reserva.

Página

Associa o token ao canal e gera o link para visualização da Fila em tempo real.

Parâmetro da Rota:

Opção	Exemplo de Uso	Resposta	Observações
`link`	`!link`	Veja a Fila aqui: https://zezofelipe.com.br/q/jinxtally	Recomenda-se ser usado pelo menos uma vez.

Opções de Gerenciamento

Abrir

Permite que usuários entrem na Fila.

Parâmetro da Rota:

Opção	Exemplo de Uso	Resposta	Observações
`open`	`!abrir`	A Fila foi aberta!	Retorna um erro se a Fila já estiver aberta.

Parâmetros de Consulta:

Nome	Descrição	Tipo
`maxSize`	Define a quantidade máxima de usuários na Fila.	`integer`
`scheduledClose`	Define o tempo em minutos para fechamento automático da Fila.	`integer`

Fechar

Impede novas entradas e cancela fechamentos automáticos.

Parâmetro da Rota:

Opção	Exemplo de Uso	Resposta	Observações
`close`	`!fechar`	A Fila foi fechada!	Retorna um erro se a Fila já estiver fechada.

Limpar

Remove todos os usuários de todas as listas.

Parâmetro da Rota:

Opção	Exemplo de Uso	Resposta	Observações
`clear`	`!limpar`	A Fila foi limpa.	Retorna um erro se a Fila já estiver vazia.

Adicionar

Adiciona um usuário na Fila.

Parâmetro da Rota:

Opção	Exemplo de Uso	Resposta	Observações
`add`	`!adicionar @xCadamuro`	xCadamuro foi adicionado à Fila.	Usuário é adicionado no final da Fila Normal. Também é possível adicionar vários na mesma requisição. Exemplo: `!adicionar @zezofelipe, @fneons, @xcadamuro`

Remover

Remove um usuário da Fila.

Parâmetro da Rota:

Opção	Exemplo de Uso	Resposta	Observações
`remove`	`!remover @FNeonS`	FNeonS foi removido da Fila.	Retorna um erro se o usuário especificado não estiver em nenhuma lista.

Chama o usuário que estiver na frente da Fila, removendo-o da lista.

Parâmetro da Rota:

Opção	Exemplo de Uso	Resposta	Observações
`next`	`!próximo`	Agora é a sua vez: Talita	Ordem de chamada: Reserva → Prioridade → Normal.

Passar

Coloca usuário na Fila Reserva e seleciona o próximo.

Parâmetro da Rota:

Opção	Exemplo de Uso	Resposta	Observações
`stash`	`!passar`	xCADAMURO foi colocado na Reserva. Agora é a sua vez: FNeonS	O usuário colocado na Reserva será chamado novamente na próxima vez que a ação `next` for executada.

Banir

Impede o usuário de entrar na Fila.

Parâmetro da Rota:

Opção	Exemplo de Uso	Resposta	Observações
`ban`	`!banir FneonS`	FneonS foi banido da Fila.	O usuário ainda será capaz de enviar comentários no chat.

Desbanir

Permite ao usuário entrar na Fila novamente.

Parâmetro da Rota:

Opção	Exemplo de Uso	Resposta	Observações
`unban`	`!desbanir FneonS`	FneonS foi desbanido da Fila.	Remove restrições, permitindo entrada normal na Fila.

Voltar para as Rotas da Twitch

Sistema de Fila com Espectadores

Propósito:

URL:

Parâmetros da Rota Necessários:

Nome

Descrição

Obrigatório

Tipo

Parâmetros de Consulta:

Nome

Descrição

Obrigatório

Tipo

Aviso

Configuração

Passo 1

Passo 2

Passo 3

LEMBRE-SE

Opções de Ação

Entrar

Parâmetro da Rota:

Opção

Exemplo de Uso

Resposta

Observações

Parâmetros de Consulta:

Nome

Descrição

Tipo

Sair

Parâmetro da Rota:

Opção

Exemplo de Uso

Resposta

Observações

Posição

Parâmetro da Rota:

Opção

Exemplo de Uso

Resposta

Observações

Lista

Parâmetro da Rota:

Opção

Exemplo de Uso

Resposta

Observações

Página

Parâmetro da Rota:

Opção

Exemplo de Uso

Resposta

Observações

Opções de Gerenciamento

Abrir

Parâmetro da Rota:

Opção

Exemplo de Uso

Resposta

Observações

Parâmetros de Consulta:

Nome

Descrição

Tipo

Fechar

Parâmetro da Rota:

Opção

Exemplo de Uso

Resposta

Observações

Limpar

Parâmetro da Rota:

Opção

Exemplo de Uso

Resposta

Observações

Adicionar

Parâmetro da Rota: