Erros do RTC
Cada erro do RTC possui um código estável e legível por máquina código. Baseie-se no código, nunca no texto da mensagem: as mensagens podem ser reformuladas, enquanto os códigos nunca são renomeados ou reutilizados com outro significado.
Dois formatos de resposta
Seção intitulada “Dois formatos de resposta”Padrão. Sem um cabeçalho de versão, os erros mantêm seu formato original, de modo que as integrações existentes não são afetadas:
{ "error": "Your plan allows 2 webhook endpoints", "code": "WEBHOOK_ENDPOINT_LIMIT" }code está presente em erros que possuem um código específico. Erros mais antigos podem conter apenas ; o cabeçalho sempre indica o código. error; o X-Error-Code O cabeçalho sempre identifica o código.
Envelope estruturado. Enviar RTC-Version: 2026-11-01 com uma solicitação para receber o envelope estruturado:
curl https://api.rtc.champrep.com/v1/webhooks/endpoints \ --header "Authorization: Bearer $RTC_API_KEY" \ --header "RTC-Version: 2026-11-01" \ --header "Content-Type: application/json" \ --data '{ "url": "https://hooks.example.com/rtc" }'{ "error": { "code": "WEBHOOK_ENDPOINT_LIMIT", "message": "Your plan allows 2 webhook endpoints", "details": { "limit": 2, "used": 2 }, "requestId": "6f1c2b8e-1d2a-4c55-9a8e-0f4b9b1d7c21", "retryable": false, "docUrl": "https://docs.champrep.com/services/rtc/errors/#webhook-endpoint-limit" }}| Campo | Significado |
|---|---|
code | Código estável do catálogo |
message | Explicação legível por humanos; não a analise |
details | Contexto estruturado opcional, por exemplo limit e used, ou issues (os campos inválidos) para INVALID_REQUEST |
requestId | O ID desta solicitação, também enviado como X-Request-Id |
retryable | true ao tentar novamente a mesma solicitação mais tarde pode ser bem-sucedida |
docUrl | Link para a entrada deste código abaixo |
A resposta reflete a versão aplicada no RTC-Version . Uma data anterior a 2026-11-01 mantém o formato padrão. Consulte versões.
em todas as respostas
Seção intitulada “em todas as respostas”| Cabeçalho | Quando | Significado |
|---|---|---|
X-Request-Id | Toda resposta | ID exclusivo da solicitação. Inclua-o ao entrar em contato com o suporte. |
X-Error-Code | Todo erro | O código estável, em ambos os formatos de resposta |
Retry-After | 429e alguns 503 | Segundos a aguardar antes de tentar novamente |
X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset | Respostas autenticadas | Consulte Limites de taxa |
Tratamento de erros
Seção intitulada “Tratamento de erros”retryable: false(4xxque não seja429): corrija primeiro a solicitação, a credencial, o plano ou o estado. Repetir a solicitação sem alterações resultará na mesma resposta.retryable: true: tente novamente com recuo exponencial e jitter, respeitandoRetry-After. Repita as gravações somente quando a operação for idempotente ou após a reconciliação de seu resultado.401: a credencial está ausente, expirada ou revogada.403: a credencial é válida, mas não possui escopo, acesso ao projeto ou direito ao plano.404também abrange recursos que pertencem a terceiros. Nunca investigue os identificadores de outros clientes.
Catálogo de códigos
Seção intitulada “Catálogo de códigos”GET /v1/error-codes (sem autenticação) retorna o catálogo atual como
{ "codes": [{ "code", "status", "retryable", "description" }] }. Novos códigos podem ser adicionados a qualquer momento; trate um código desconhecido como o código genérico de seu status HTTP.
Códigos genéricos (um por status HTTP, utilizados quando nenhum código específico se aplica)
Seção intitulada “Códigos genéricos (um por status HTTP, utilizados quando nenhum código específico se aplica)”| Código | HTTP | Repetível | Significado |
|---|---|---|---|
INVALID_REQUEST | 400 | não | A solicitação está com formato incorreto ou um campo é inválido (details.issues (enumera os campos). |
UNAUTHENTICATED | 401 | não | Credenciais ausentes, inválidas ou vencidas. |
PAYMENT_REQUIRED | 402 | não | É necessário efetuar um pagamento antes que isso possa ser utilizado. |
FORBIDDEN | 403 | não | A credencial é válida, mas não está autorizada a realizar essa ação. |
NOT_FOUND | 404 | não | O recurso não existe ou não está visível para esta credencial. |
CONFLICT | 409 | não | A solicitação entra em conflito com o estado atual. |
PAYLOAD_TOO_LARGE | 413 | não | O corpo da solicitação é muito grande. |
UNSUPPORTED_MEDIA_TYPE | 415 | não | O tipo de conteúdo não é aceito. |
RANGE_NOT_SATISFIABLE | 416 | não | O intervalo de bytes solicitado é inválido ou indisponível. |
UNPROCESSABLE | 422 | não | O conteúdo foi compreendido, mas não pode ser processado. |
RATE_LIMITED | 429 | sim | Excesso de solicitações; aguarde Retry-After segundos. |
INTERNAL | 500 | sim | Erro inesperado do servidor; tente novamente mais tarde. |
SERVICE_UNAVAILABLE | 503 | sim | Temporariamente indisponível; tente novamente com intervalo de espera. |
Assinatura e cota
Seção intitulada “Assinatura e cota”Essas respostas também incluem offers (o que resolve o problema: um período de teste, uma assinatura, um upgrade, um pacote ou a adição de um cartão, cada um com um link de cobrançaCHAMPREP) e, quando se trata de uma cota ou recurso específico, feature.
| Código | HTTP | Repetível | Significado |
|---|---|---|---|
RTC_SUBSCRIPTION_REQUIRED | 402 | não | A conta não possui assinatura, período de teste ou cota incluída para o RTC (consulte offers). |
RTC_PAYMENT_REQUIRED | 402 | não | Uma fatura não paga bloqueia o RTC; pague-a no CHAMPREP Faturamento. |
RTC_ACCESS_DENIED | 403 | não | Uma política da organização, equipe ou plataforma impede o uso do RTC (reasonCode (especifica qual). |
RTC_ALLOWANCE_EXHAUSTED | 402 | não | A cota de RTC da assinatura foi esgotada (feature indica qual; consulte offers). |
RTC_FEATURE_NOT_IN_PLAN | 403 | não | A assinatura não inclui este recurso (consulte offers). |
RTC_PLAN_LIMIT | 403 | não | Foi atingido um limite da assinatura (tamanho da sala, salas abertas simultaneamente). |
PAYMENT_METHOD_REQUIRED | 402 | não | O período de avaliação requer um cartão cadastrado no espaço de trabalho pago (consulte offers). |
TRIAL_ALREADY_USED | 409 | não | A avaliação gratuita já foi utilizada por esta conta. |
TRIAL_NOT_ALLOWED | 403 | não | Esta conta não pode iniciar o período de avaliação gratuita. |
TRIAL_UNAVAILABLE | 409 | não | O período de avaliação gratuita não está disponível. |
ALREADY_SUBSCRIBED | 409 | não | A conta já possui uma assinatura RTC. |
PRIMARY_TOKEN_REQUIRED | 401 | não | Para iniciar um período de avaliação, é necessária a sessão do console do titular da conta. |
PRIMARY_TOKEN_INVALID | 401 | não | A sessão do console não é válida para iniciar um período de avaliação; faça login novamente. |
PRIMARY_TOKEN_MISMATCH | 403 | não | Somente o titular da conta pode iniciar este período de avaliação. |
Paginação e idempotência
Seção intitulada “Paginação e idempotência”| Código | HTTP | Repetível | Significado |
|---|---|---|---|
INVALID_CURSOR | 400 | não | O cursor está com formato inválido ou pertence a outra lista. |
IDEMPOTENCY_KEY_INVALID | 400 | não | O Idempotency-Key O cabeçalho está com formato incorreto. |
IDEMPOTENCY_KEY_REUSED | 409 | não | O Idempotency-Key foi utilizado em uma solicitação diferente. |
IDEMPOTENCY_IN_PROGRESS | 409 | sim | A primeira solicitação com este Idempotency-Key ainda está em execução. |
Salas, tokens de participantes e mídia
Seção intitulada “Salas, tokens de participantes e mídia”| Código | HTTP | Repetível | Significado |
|---|---|---|---|
ROOM_EXTERNAL_REF_CONFLICT | 409 | não | Uma sala aberta do projeto já utiliza este externalRef. |
ROOM_FULL | 409 | não | A sala atingiu seu limite de participantes. |
ROOM_LOCKED | 409 | não | A sala está bloqueada; somente os anfitriões podem entrar. |
ROOM_ALLOWANCE_UNAVAILABLE | 503 | sim | Não foi possível ler a cota de participantes da sala. |
PARTICIPANT_BANNED | 409 | não | Esta identidade está banida da sala. |
PARTICIPANT_REMOVED | 403 | não | Este participante foi removido da sala. |
MEDIA_CAPACITY | 503 | sim | Nenhum nó de mídia tem espaço para isso no momento; tente novamente mais tarde. |
MEDIA_NODE_UNAVAILABLE | 503 | sim | O nó de mídia da sala está indisponível; tente novamente. |
MEDIA_UNAVAILABLE | 503 | sim | O serviço de mídia está indisponível; tente novamente. |
HOST_MUTED | 403 | não | Um anfitrião silenciou esta fonte. |
DATA_NOT_PERMITTED | 403 | não | O participante não pode enviar mensagens do aplicativo. |
MESSAGE_TOO_LARGE | 400 | não | A mensagem do aplicativo é muito grande. |
MESSAGE_RATE_LIMITED | 429 | sim | Há um número excessivo de mensagens do aplicativo enviadas por este participante. |
ROOM_MESSAGE_RATE_LIMITED | 429 | sim | Há um número excessivo de mensagens do aplicativo nesta sala. |
RESERVED_TOPIC | 400 | não | O tópico da mensagem do aplicativo está reservado. |
INVALID_RECIPIENTS | 400 | não | Os destinatários da mensagem do aplicativo são inválidos. |
RESUME_REFUSED | 403 | não | A sessão não pode ser retomada. |
RESUME_UNAVAILABLE | 503 | sim | A função de retomada está temporariamente indisponível. |
FIRST_PARTY | 409 | não | Reservado para os produtos próprios CHAMPREPda . |
FIRST_PARTY_NOT_READY | 503 | sim | O locatário primário ainda não foi provisionado. |
Tokens de participação e chaves de assinatura do projeto
Seção intitulada “Tokens de participação e chaves de assinatura do projeto”| Código | HTTP | Repetível | Significado |
|---|---|---|---|
JOIN_GRANT_INVALID | 401 | não | O token de acesso está inválido, expirado, assinado incorretamente ou sua chave de assinatura foi revogada. |
JOIN_GRANT_USED | 409 | não | Este token de participação já foi utilizado (eles são de uso único). |
SIGNING_KEY_LIMIT | 409 | não | O projeto já possui o número máximo de chaves de assinatura ativas. |
SIGNING_KEY_INVALID | 400 | não | A chave pública não é um JWK P-256 válido. |
Gravações, transcrições e legendas
Seção intitulada “Gravações, transcrições e legendas”| Código | HTTP | Repetível | Significado |
|---|---|---|---|
COMPOSITE_UNAVAILABLE | 400 | não | A gravação composta não está disponível. |
DELETE_NOT_AVAILABLE | 403 | não | As gravações não podem ser excluídas pelos clientes (não são mais enviadas: DELETE /v1/recordings/:id envia a gravação para a Lixeira, onde será excluída automaticamente após 30 dias). |
RECORDING_ACTIVE | 409 | não | A gravação ainda está em andamento. |
RECORDING_SETTLING | 409 | sim | A gravação ainda está sendo armazenada. |
RECORDING_NOT_READY | 409 | não | A gravação ainda não foi concluída (as entregas exigem uma gravação pronta). |
RECORDING_NOT_IN_TRASH | 409 | não | Somente uma gravação na Lixeira pode ser excluída permanentemente; exclua-a primeiro. |
RECORDING_PURGED | 409 | não | A gravação foi excluída permanentemente (da Lixeira ou por um administrador) e não pode ser restaurada. |
CONFIRM_PURGE_REQUIRED | 400 | não | Para reduzir a janela da Lixeira, é necessário definir confirmPurge: true. |
TRANSCRIPTION_UNAVAILABLE | 400 | não | Não há transcrições disponíveis para esta conta. |
TRANSCRIPT_EXISTS | 409 | não | Já existe uma transcrição desta gravação ou ela está em execução. |
NO_AUDIO | 409 | não | A gravação não possui áudio para transcrição. |
TRANSCRIPT_NOT_READY | 409 | sim | A transcrição ainda não está concluída; somente uma transcrição concluída pode ser exportada como VTT, SRT ou TXT. |
TRANSCRIPT_RUNNING | 409 | não | A transcrição já está sendo gerada e não pode ser cancelada. |
TRANSCRIPT_NOT_CANCELLABLE | 409 | não | Apenas uma transcrição que ainda não tenha sido iniciada pode ser cancelada. |
WINDOW_TOO_LONG | 400 | não | O intervalo de tempo solicitado é muito longo. |
SUMMARY_TIMEOUT | 503 | sim | O resumo demorou muito; tente novamente. |
CAPTIONS_BUSY | 503 | sim | As legendas em tempo real estão no limite de capacidade; tente novamente mais tarde. |
CAPTIONS_LANGUAGE_LIMIT | 409 | não | Há idiomas de legenda em excesso nesta sala. |
CAPTIONS_NOT_PERMITTED | 403 | não | O participante não pode utilizar legendas. |
INVALID_LANGUAGE | 400 | não | O código do idioma não é compatível. |
Armazenamento de gravações
Seção intitulada “Armazenamento de gravações”| Código | HTTP | Repetível | Significado |
|---|---|---|---|
DESTINATION_LIMIT | 409 | não | A organização atingiu o número máximo de destinos de armazenamento. |
DESTINATION_ADMIN_DISABLED | 403 | não | CHAMPREP O suporte desativou este destino de armazenamento; ele não pode ser reativado pelo cliente. |
ENDPOINT_NOT_ALLOWED | 400 | não | O endpoint compatível com S3 não é permitido (HTTPS na porta 443 apenas para um endereço público). |
REDELIVERY_LIMIT | 429 | sim | A gravação foi enviada novamente recentemente, ou a organização enviou muitas gravações nesta hora; tente novamente mais tarde. |
NO_ACTIVE_DESTINATION | 409 | não | Não há nenhum destino de armazenamento ativo aplicável a esta gravação. |
EGRESS_UNAVAILABLE | 503 | sim | Não foi possível acessar o sistema de cobrança para cobrir este download; tente novamente em breve. |
DELIVERY_NOT_CONFIGURED | 503 | não | Os destinos de funções da AWS ainda não estão disponíveis; utilize chaves compatíveis com S3 (código e mensagem foram enviados). |
CREDENTIALS_UNAVAILABLE | 503 | não | O armazenamento de chaves de destino ainda não está disponível; utilize uma função da AWS. |
Webhooks
Seção intitulada “Webhooks”| Código | HTTP | Repetível | Significado |
|---|---|---|---|
WEBHOOK_NOT_CONFIGURED | 409 | não | Nenhum endpoint de webhook está configurado. |
WEBHOOK_URL_INVALID | 400 | não | A URL do webhook não é um endpoint HTTPS público na porta 443 fora dos domíniosCHAMPREP. |
WEBHOOK_ENDPOINT_LIMIT | 409 | não | O número de pontos de extremidade de webhook do plano foi atingido (details.limit, details.used). |
WEBHOOK_ENDPOINT_NOT_FOUND | 404 | não | O endpoint do webhook não existe. |
WEBHOOK_ENDPOINT_DISABLED | 409 | não | O endpoint do webhook está desativado; ative-o primeiro. |
WEBHOOK_ENDPOINT_ADMIN_DISABLED | 403 | não | CHAMPREP O suporte desativou o endpoint do webhook; entre em contato com o suporte. |
WEBHOOK_URL_ADMIN_DISABLED | 403 | não | CHAMPREP O suporte desativou esta URL de webhook; ela não pode ser adicionada novamente. Entre em contato com o suporte. |
WEBHOOK_EVENT_UNKNOWN | 400 | não | Um filtro de evento não corresponde a nenhum tipo de evento conhecido (details.patterns). |
REPLAY_LIMIT | 409 | não | Esta entrega foi repetida com muita frequência. |
REPLAY_QUOTA | 429 | sim | Excesso de reproduções; aguarde Retry-After segundos. |
DELIVERY_IN_PROGRESS | 409 | sim | A entrega está sendo enviada neste momento. |
Quadros brancos
Seção intitulada “Quadros brancos”| Código | HTTP | Repetível | Significado |
|---|---|---|---|
WHITEBOARD_UNAVAILABLE | 503 | sim | O serviço de quadro branco está indisponível. |
WHITEBOARD_DISABLED | 403 | não | Os quadros brancos estão desativados para esta conta. |
WHITEBOARD_ARCHIVED | 409 | não | O quadro branco está arquivado. |
WHITEBOARD_LIMIT | 409 | não | A sala atingiu o número máximo de quadros brancos. |
WHITEBOARD_QUOTA | 402 | não | A cota de quadros brancos está esgotada. |
WHITEBOARD_FILE_INVALID | 422 | não | Não foi possível ler o arquivo do quadro branco. |
WHITEBOARD_FILE_LIMIT | 409 | não | O quadro branco atingiu o número máximo de arquivos. |
WHITEBOARD_FILE_PENDING | 409 | sim | O upload do arquivo do quadro branco não foi concluído. |
WHITEBOARD_FILE_SIZE | 400 | não | O tamanho do arquivo declarado é inválido. |
WHITEBOARD_FILE_TOO_LARGE | 413 | não | O arquivo do quadro branco é muito grande. |
WHITEBOARD_FILE_TYPE | 415 | não | O tipo de arquivo do quadro branco não é permitido. |
SNAPSHOT_TOO_LARGE | 413 | não | O instantâneo do quadro branco é muito grande para ser retornado. |
Controle remoto
Seção intitulada “Controle remoto”| Código | HTTP | Repetível | Significado |
|---|---|---|---|
RC_BLOCKED | 403 | não | O controle remoto está bloqueado. |
RC_CLIPBOARD_OFF | 403 | não | O compartilhamento da área de transferência está desativado. |
RC_CLIPBOARD_TOO_LARGE | 413 | não | O conteúdo da área de transferência é muito grande. |
RC_CONFLICT | 409 | não | Há outro pedido de controle remoto em conflito. |
RC_INVALID_REQUEST | 400 | não | A solicitação de controle remoto é inválida. |
RC_NOT_PERMITTED | 403 | não | O controle remoto não é permitido. |
RC_NO_BUDGET | 402 | não | Não há mais cota de controle remoto disponível. |
RC_PENDING | 409 | não | Já há uma solicitação de controle remoto pendente. |
RC_RATE_LIMITED | 429 | sim | Excesso de solicitações de controle remoto. |
RC_REAUTH_REQUIRED | 401 | não | Reautentifique-se para continuar o controle remoto. |
RC_SHARER_BUSY | 409 | não | O compartilhador já está sob controle. |
RC_UNAVAILABLE | 404 | não | O controle remoto não está disponível. |
RC_WIDEN_REFUSED | 403 | não | A autorização de controle remoto não pode ser ampliada. |
Telemetria
Seção intitulada “Telemetria”| Código | HTTP | Repetível | Significado |
|---|---|---|---|
INVALID_TELEMETRY | 400 | não | A amostra de telemetria está inválida. |
TELEMETRY_RATE_LIMITED | 429 | sim | Excesso de amostras de telemetria. |