Api de músicas

Scope api.chatpls.live

Respostas

Todas as respostas da API terão o seguinte formato

{
    "status": "int - Código HTTP (200, 404, 403, etc)",
    "message": "string - Descrição do que aconteceu",
    "error": "bool - Se houve erro ou não"
}

Receber a queue de músicas

Definição

GET /queue

Argumentos

Não há argumentos.

Resposta

• 200 OK Quando houver sucesso
• 404 Not Found Quando não houver pessoas na queue.
• 405 Method Not Allowed Quando o método não for GET
• 429 Too Many Requests Quando exceder o limite de requests/minuto

{
    "status": 200,
    "message": "OK",
    "error": false,
    "data": [
        {"username": "user", "queue_song": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"}
    ]
}

Sair da queue

Definição

POST /queue/leave

Argumentos

• "token":string token da sessão do usuário. (obrigatório)

Resposta

• 200 OK Quando houver sucesso
• 404 Not Found Quando não estiver na queue.
• 405 Method Not Allowed Quando o método não for POST
• 429 Too Many Requests Quando exceder o limite de requests/minuto
• 422 Unprocessable Entity Quando qualquer argumento obrigatório estiver faltando.

{
    "status": 200,
    "message": "OK",
    "error": false,
    "queue_place": 0
}

Entrar na queue

Definição

POST /queue/join

Argumentos

• "token":string token da sessão do usuário. (obrigatório)
• "link":str link da música (obrigatório)

Resposta

• 200 OK Quando houver sucesso
• 403 Unauthorized Quando o usuário estiver em timeout ou banido do chat.
• 404 Not Found Quando a música estiver pausada.
• 405 Method Not Allowed Quando o método não for POST
• 429 Too Many Requests Quando exceder o limite de requests/minuto
• 422 Unprocessable Entity Quando qualquer argumento obrigatório estiver faltando.

{
    "status": 200,
    "message": "OK",
    "error": false,
    "queue_place": 0
}

Manter posição na queue

Definição

POST /queue/keepalive

Argumentos

• "token":string token da sessão do usuário. (obrigatório)

Resposta

• 200 OK Quando houver sucesso
• 403 Unauthorized Quando o token estiver expirado/inexistente ou usuário estiver em timeout ou banido do chat.
• 404 Not Found Quando não houver músicas tocando.
• 405 Method Not Allowed Quando o método não for POST
• 429 Too Many Requests Quando exceder o limite de requests/minuto
• 422 Unprocessable Entity Quando qualquer argumento obrigatório estiver faltando.

{
    "status": 200,
    "message": "OK",
    "error": false,
    "queue_place": 0
}

Receber a música atual

Definição

GET /current

Argumentos

Não há argumentos.

Resposta

• 200 OK Quando houver sucesso
• 404 Not Found Quando não houver músicas tocando.
• 429 Too Many Requests Quando exceder o limite de requests/minuto

{
    "status": 200,
    "message": "OK",
    "error": false,
    "data": {
        "link": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
        "likes": 0,
        "dislikes": 0,
        "time": 0
    }
}

Adicionar reação à música

Definição

POST /current/reaction

Argumentos

• "token":string token da sessão do usuário. (obrigatório)
• "username":string username do usuário. (obrigatório)
• "action_id":int ID da ação (0: Adicionar like, 1: Remover like, 2: Adicionar dislike, 4: Remover dislike) (obrigatório)

Resposta

• 200 OK Quando houver sucesso
• 403 Unauthorized Quando o token estiver expirado/inexistente ou usuário estiver em timeout ou banido do chat.
• 404 Not Found Quando não houver músicas tocando.
• 405 Method Not Allowed Quando o método não for POST
• 429 Too Many Requests Quando exceder o limite de requests/minuto
• 422 Unprocessable Entity Quando qualquer argumento obrigatório estiver faltando.

{
    "status": 200,
    "message": "OK",
    "error": false,
}

Ações

Definição

POST /current/action Este endpoint é uma diferenciação para ações de mods

Argumentos

• "token":string token da sessão do usuário. (obrigatório)
• "username":string username do usuário. (obrigatório)
• "action_id":int ID da ação (0: Pular música) (obrigatório)

Resposta

• 200 OK Quando houver sucesso
• 403 Unauthorized Quando o token estiver expirado/inexistente ou usuário não tiver status de mod, vip ou streamer no chat.
• 404 Not Found Quando não houver músicas tocando.
• 405 Method Not Allowed Quando o método não for POST
• 429 Too Many Requests Quando exceder o limite de requests/minuto
• 422 Unprocessable Entity Quando qualquer argumento obrigatório estiver faltando.

{
    "status": 200,
    "message": "OK",
    "error": false,
}