VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Lives de vendas

Responder a um quiz

Envia a alternativa escolhida pelo cliente a um quiz aberto durante a live e informa se acertou.

Durante a live, o organizador pode abrir um quiz (uma pergunta de múltipla escolha com tempo limitado). Quem acerta ganha 10 pontos no ranking e pode receber prêmios quando o quiz fecha. Esta rota recebe a resposta do cliente e a corrige no servidor.

Pontos principais
  • A resposta é única e imutável: o cliente só responde uma vez a cada quiz.
  • O quiz_id e as alternativas chegam pelo evento quiz.open do WebSocket (veja a home da seção). Não existe rota REST para listar quizzes, e o gabarito nunca é enviado antes do fechamento.
  • answer_index é a posição da alternativa na lista options do evento, começando em 0.
  • Exige token de cliente.
POST/api/v1/storefront/live-sessions/{id}/quizzes/{quizId}/answerCliente

Responder a um quiz

Parâmetros de caminho

iduuidobrigatório
Id da live.
quizIduuidobrigatório
Id do quiz, recebido no evento quiz.open.

Corpo da requisição

answer_indexintegerobrigatório
Índice da alternativa escolhida, a partir de 0. Se omitido, vale 0 (a primeira alternativa), não é um erro.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/storefront/live-sessions/$SESSION_ID/quizzes/$QUIZ_ID/answer" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"answer_index":2}'

Resposta

200Resposta registrada
json
{ "correct": true }

Campos da resposta

correctboolean
true se a alternativa escolhida é a correta. Um acerto soma 1 ao contador de acertos que alimenta o ranking.

Erros

Os erros de regra devolvem um código curto no campo error.

StatusQuandoCorpo
400JSON inválido.{"error":"invalid request body","detail":"..."}
401Sem token de cliente.{"error":"authentication required"}
403Módulo live-commerce desligado.{"error":"module_disabled","module":"live-commerce"}
404A gamificação não está disponível.{"error":"gamification not available"}
409O cliente já respondeu a este quiz.{"error":"already_answered"}
409O quiz não está aberto (ainda é rascunho, já fechou ou o tempo acabou).{"error":"quiz_closed"}
422O quiz não existe nesta live.{"error":"quiz_not_found"}
500quizId ou id que não é UUID, ou falha interna.{"error":"gamification error","detail":"..."}
O primeiro envio vale, mesmo com índice errado

Se answer_index estiver fora da lista de alternativas, o servidor não rejeita: registra como resposta errada e a resposta fica travada. Valide o índice no cliente antes de enviar. E como o campo omitido vira 0, um corpo vazio responde "a primeira alternativa".

Veja também

  • Ranking
  • Voucher relâmpago
  • Chat da live
Anterior
Tempo assistido
Próxima
Ranking da live
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também