ZynzapAPI

Erros

Formato único de erro, categorias, todos os códigos de motivo (reason) com o significado e como resolver.

Toda resposta de erro da API tem o mesmo corpo e o cabeçalho x-request-id:

HTTP/1.1 428
{
  "error": {
    "code": "PAYMENT_REQUIRED",
    "message": "Revise os custos antes de continuar.",
    "requestId": "7f3c1a9e-2b4d-4c6e-8f10-a1b2c3d4e5f6",
    "reason": "BILLING_QUOTE_REQUIRED"
  }
}
CampoSignificado
codeCategoria estável (tabela abaixo). Decida a reação do seu código por ela.
reasonMotivo de domínio estável, quando houver. Use para tratar casos específicos.
messageTexto em pt-BR, seguro para mostrar ao usuário. Pode mudar: não compare strings.
requestIdIdentificador da chamada. Guarde nos seus logs e informe ao suporte.

Respostas de sucesso não têm envelope: o corpo é a própria resposta da operação.

Categorias

codeHTTPQuando aconteceO que fazer
UNAUTHENTICATED401Chave ausente, inválida, vencida ou revogada.Confira o cabeçalho e o estado da chave no painel. Não repita.
FORBIDDEN403Falta permissão, o número está fora da chave ou o IP não é permitido.Ajuste a chave (ou crie outra). Não repita.
NOT_FOUND404Operação, recurso ou número inexistente ou fora do alcance da chave.Confira o identificador.
VALIDATION_FAILED400, 413Corpo inválido, campo fora do contrato, prazo inválido ou corpo acima de 12 MiB.Corrija a requisição. Não repita igual.
CONFLICT409Conflito com o estado atual (cotação expirada, versão desatualizada...).Releia o estado e refaça.
PAYMENT_REQUIRED402, 428Operação paga sem cotação (428) ou sem saldo (402).Cote e garanta saldo. Veja Cobrança e cotações.
RATE_LIMITED429Limite por minuto da conta ou da chave.Espere e repita com backoff. Veja Limites.
UNAVAILABLE503, 504Indisponibilidade temporária ou prazo excedido.Repita com backoff. Em operações pagas, confira antes (veja abaixo).
INTERNAL500Erro inesperado.Repita mais tarde e informe o requestId.

Resultado incerto

Em envios, um 503/504 com reason: OUTCOME_UNCERTAIN ou RPC_DEADLINE_EXCEEDED significa que não sabemos se o WhatsApp aceitou a mensagem. Não reenvie às cegas: consulte o histórico (ListMessages) ou aguarde o evento MessageSent/MessageStatusUpdated. A mesma cotação nunca dispara duas vezes; se precisar reenviar, peça outra cotação. Veja Idempotência.

Erros em streams

Nos streams SSE (/events, /sessions/create, /sessions/resume) os erros depois de aberta a conexão chegam como um evento:

event: error
data: {"error":{"code":"UNAUTHENTICATED","message":"A credencial de API foi revogada.","requestId":"...","reason":"API_AUTH_REVOKED"}}

Todos os motivos (reason)

Lista gerada do código do Zynzap. Alguns motivos dependem do recurso (atendimento, CRM, fluxos) e só aparecem nas operações correspondentes.

Autenticação e acesso

reasonHTTP · codeMensagemComo resolver
AUTH_REQUIRED401 · UNAUTHENTICATEDSua sessão expirou. Entre novamente para continuar.Envie a chave no cabeçalho Authorization.
API_AUTH_REQUIRED401 · UNAUTHENTICATEDCredencial de API ausente, inválida ou revogada.Envie Authorization: Bearer <chave>. Confira se a chave não venceu nem foi revogada e se você não mistura chaves de teste e produção.
API_AUTH_REVOKED401 · UNAUTHENTICATEDA credencial de API foi revogada.A chave foi revogada (ou o segredo antigo saiu da carência de rotação). Crie ou rotacione a chave no painel.
AUTH_SESSION_REQUIRED403 · FORBIDDENEsta ação exige uma sessão do painel.A chave precisa da permissão/número indicado; crie outra chave com o necessário.
EMAIL_VERIFICATION_REQUIRED403 · FORBIDDENConfirme seu e-mail para continuar.A chave precisa da permissão/número indicado; crie outra chave com o necessário.
MFA_REQUIRED403 · FORBIDDENConfirme seu segundo fator para continuar.A chave precisa da permissão/número indicado; crie outra chave com o necessário.
REAUTHENTICATION_REQUIRED403 · FORBIDDENConfirme sua identidade em Perfil e segurança para continuar.A chave precisa da permissão/número indicado; crie outra chave com o necessário.
VERIFICATION_AND_MFA_REQUIRED403 · FORBIDDENConfirme seu e-mail e ative o segundo fator para continuar.A chave precisa da permissão/número indicado; crie outra chave com o necessário.
ORIGIN_FORBIDDEN403 · FORBIDDENOrigem não autorizada.A chave precisa da permissão/número indicado; crie outra chave com o necessário.
MFA_ENROLLMENT_REQUIRED403 · FORBIDDENAtive a autenticação em duas etapas antes de continuar.A chave precisa da permissão/número indicado; crie outra chave com o necessário.
RATE_LIMITED429 · RATE_LIMITEDMuitas solicitações em pouco tempo. Aguarde um instante e tente novamente.Limite da conta (120 req/min em /rpc; 60/min em cotações e downloads; 10/min em streams). Espere e use backoff exponencial.
ACCESS_CONTROL_UNAVAILABLE503 · UNAVAILABLEControle de acesso temporariamente indisponível.Repita com backoff; em operações pagas, confira antes.

Requisição

reasonHTTP · codeMensagemComo resolver
REQUEST_INVALID400 · VALIDATION_FAILEDRequisição inválida.Corrija o corpo conforme a referência.
JSON_INVALID400 · VALIDATION_FAILEDCorpo da requisição inválido: envie um objeto JSON.Envie JSON válido com Content-Type: application/json.
PAYLOAD_TOO_LARGE413 · VALIDATION_FAILEDO conteúdo enviado excede o limite permitido.Reduza o corpo (máximo 12 MiB). Para mídias grandes, use a biblioteca (UploadMedia) e envie por media_asset_id.
RPC_METHOD_NOT_FOUND404 · NOT_FOUNDOperação não disponível.Confira o nome exato da operação (PascalCase) em GET /v1 ou na referência.
RPC_METHOD_FORBIDDEN403 · FORBIDDENOperação não permitida.A chave precisa da permissão/número indicado; crie outra chave com o necessário.
RPC_REQUEST_INVALID400 · VALIDATION_FAILEDRequisição inválida para esta operação.O corpo precisa ser {"request": {...}} com campos do contrato em snake_case; arquivos em Base64; até 12 MiB.
RPC_DEADLINE_INVALID400 · VALIDATION_FAILEDPrazo da requisição inválido (1 a 30000 ms).deadlineMs deve ser um inteiro entre 1 e 30000.
RPC_DEADLINE_EXCEEDED504 · UNAVAILABLEA operação demorou mais que o esperado. Confira o resultado antes de repetir.A operação passou do prazo. Consulte o estado (ex.: liste as mensagens/campanhas) antes de repetir.
OUTCOME_UNCERTAIN503 · UNAVAILABLEResultado incerto. Confira o estado antes de repetir a operação.Não sabemos se o WhatsApp aceitou. Não repita às cegas: consulte o estado e só reenvie com uma nova cotação se não houver registro.
EVENT_CURSOR_INVALID400 · VALIDATION_FAILEDCursor de eventos inválido.Use apenas o id/cursor numérico recebido de um evento anterior.
EVENT_SESSION_INVALID400 · VALIDATION_FAILEDLista de sessões inválida.session_id deve ser UUID (até 1000 repetições).
EVENT_STREAM_UNAVAILABLE503 · UNAVAILABLEFluxo de eventos indisponível.Reconecte com backoff, enviando Last-Event-ID.
PAIRING_UNAVAILABLE503 · UNAVAILABLEPareamento temporariamente indisponível.Tente de novo em alguns segundos.
NOTICE_INVALID400 · VALIDATION_FAILEDAviso inválido.Corrija o corpo conforme a referência.
INVALID_NOTICE400 · VALIDATION_FAILEDAviso inválido.Corrija o corpo conforme a referência.
NOTIFICATIONS_UNAVAILABLE503 · UNAVAILABLENotificações indisponíveis no momento.Repita com backoff; em operações pagas, confira antes.

Chaves de API

reasonHTTP · codeMensagemComo resolver
API_KEY_INPUT_INVALID400 · VALIDATION_FAILEDNome, permissões e validade são obrigatórios.Corrija o corpo conforme a referência.
API_KEY_CREATION_INVALID400 · VALIDATION_FAILEDConfira as permissões, dispositivos e quota de criação da chave.Corrija o corpo conforme a referência.
API_KEY_DEVICES_INVALID400 · VALIDATION_FAILEDLista de dispositivos da chave inválida.Corrija o corpo conforme a referência.
API_KEY_RESTRICTED_SCOPE_INVALID400 · VALIDATION_FAILEDEsta permissão não pode ser restrita a dispositivos.Corrija o corpo conforme a referência.
API_KEY_EMPTY_DEVICES400 · VALIDATION_FAILEDSelecione ao menos um dispositivo.Corrija o corpo conforme a referência.
API_KEY_CREATION_SCOPE_REQUIRED400 · VALIDATION_FAILEDCriar dispositivos exige a permissão de gerenciar sessões.Corrija o corpo conforme a referência.
API_KEY_CREATION_QUOTA_REQUIRED400 · VALIDATION_FAILEDInforme a quota de dispositivos que a chave pode criar.Corrija o corpo conforme a referência.
API_KEY_INVALID400 · VALIDATION_FAILEDChave inválida.Corrija o corpo conforme a referência.
API_KEY_IP_FORBIDDEN403 · FORBIDDENEste endereço IP não está autorizado a usar esta chave de API.Chame a partir de um IP da lista da chave ou edite a lista em API e integrações.
API_KEY_RATE_LIMITED429 · RATE_LIMITEDLimite de solicitações por minuto desta chave atingido. Tente novamente em instantes.Aguarde e tente de novo com intervalo crescente; ou aumente o limite da chave (até 120/min).
API_KEY_EXPIRY_INVALID400 · VALIDATION_FAILEDEscolha uma validade entre 1 dia e 3 anos, ou sem expiração.Corrija o corpo conforme a referência.
API_KEY_IPS_INVALID400 · VALIDATION_FAILEDLista de IPs inválida: use endereços ou faixas CIDR (até 50).Corrija o corpo conforme a referência.
API_KEY_RATE_INVALID400 · VALIDATION_FAILEDLimite por minuto inválido: use de 1 a 120, ou deixe em branco.Corrija o corpo conforme a referência.
API_KEY_UPDATE_INVALID400 · VALIDATION_FAILEDConfira os dados da chave.Corrija o corpo conforme a referência.
API_KEY_ROTATION_INVALID400 · VALIDATION_FAILEDEscolha quando a chave atual deve parar de funcionar.Corrija o corpo conforme a referência.

Webhooks (cadastro no painel)

reasonHTTP · codeMensagemComo resolver
WEBHOOK_INVALID400 · VALIDATION_FAILEDConfira os dados do webhook.Corrija o corpo conforme a referência.
WEBHOOK_URL_INVALID400 · VALIDATION_FAILEDEndereço inválido. Use uma URL https:// completa, sem usuário e senha.Corrija o corpo conforme a referência.
WEBHOOK_URL_INSECURE400 · VALIDATION_FAILEDUse um endereço https://.Corrija o corpo conforme a referência.
WEBHOOK_URL_PORT400 · VALIDATION_FAILEDPorta não permitida: use a 443 ou a 8443.Corrija o corpo conforme a referência.
WEBHOOK_URL_PRIVATE400 · VALIDATION_FAILEDEndereços locais, de rede privada ou reservados não são permitidos.Corrija o corpo conforme a referência.
WEBHOOK_URL_UNRESOLVED400 · VALIDATION_FAILEDNão foi possível encontrar este endereço (DNS). Confira o domínio.Corrija o corpo conforme a referência.
WEBHOOK_EVENTS_INVALID400 · VALIDATION_FAILEDEscolha ao menos um evento válido.Corrija o corpo conforme a referência.
WEBHOOK_EVENTS_FORBIDDEN403 · FORBIDDENEsta chave não pode receber um ou mais desses eventos (permissões ou números da chave).A chave precisa da permissão/número indicado; crie outra chave com o necessário.
WEBHOOK_KEY_CANNOT_READ_EVENTS403 · FORBIDDENEsta chave não pode receber eventos: falta a permissão Receber eventos ou ela foi revogada ou expirou.A chave precisa da permissão/número indicado; crie outra chave com o necessário.
WEBHOOK_LIMIT_REACHED409 · CONFLICTCada chave aceita até 5 webhooks.Releia o estado atual e tente de novo.
WEBHOOK_DUPLICATE409 · CONFLICTEsta chave já tem um webhook para este endereço.Releia o estado atual e tente de novo.
WEBHOOK_NOT_FOUND404 · NOT_FOUNDWebhook não encontrado.Confira o identificador e se ele está no alcance da chave.
WEBHOOK_DISABLED409 · CONFLICTAtive o webhook antes de enviar um teste.Releia o estado atual e tente de novo.
WEBHOOK_TEST_RATE_LIMITED429 · RATE_LIMITEDAguarde um minuto para enviar outro teste a este webhook.Espere e repita com backoff.
WEBHOOKS_UNAVAILABLE503 · UNAVAILABLEWebhooks ainda não foram configurados neste servidor.Repita com backoff; em operações pagas, confira antes.
DEVICE_UNAVAILABLE404 · NOT_FOUNDDispositivo indisponível.O número não está pronto. Confira a conexão em GetSession.

Números

reasonHTTP · codeMensagemComo resolver
SESSION_NOT_FOUND404 · NOT_FOUNDEste número foi removido ou você não tem mais acesso a ele. Não é possível enviar mensagens por ele.O número não existe ou não está liberado para a chave. Liste com ListSessions.
SESSION_DISCONNECTED409 · CONFLICTEste número está desconectado. Reconecte-o em Dispositivos para enviar mensagens.O número está desconectado. Reconecte com POST /sessions/resume ou pelo painel.

IA

reasonHTTP · codeMensagemComo resolver
AI_CONFIG_INVALID400 · VALIDATION_FAILEDConfiguração inválida.Corrija o corpo conforme a referência.
AI_CONFIG_REJECTED400 · VALIDATION_FAILEDNão foi possível salvar. Confira provedor, modelo e credencial.Corrija o corpo conforme a referência.
AI_CONFIG_UNAVAILABLE503 · UNAVAILABLENão foi possível acessar a configuração de IA.Repita com backoff; em operações pagas, confira antes.
AI_PROVIDER_NOT_CONFIGURED409 · CONFLICTConfigure e ative o provedor de IA da empresa em Assistente IA antes de usar este recurso.Configure e ative o provedor de IA no painel (Assistente IA) antes de cotar.

Mídia

reasonHTTP · codeMensagemComo resolver
MEDIA_NOT_FOUND404 · NOT_FOUNDMídia não encontrada.A mídia não existe ou é de outra conta. Use o id de ListMedia/UploadMedia.
MEDIA_STORAGE_UNAVAILABLE503 · UNAVAILABLEArmazenamento de mídia indisponível.Repita com backoff; em operações pagas, confira antes.
MEDIA_DOWNLOAD_UNAVAILABLE503 · UNAVAILABLEDownload de mídia indisponível.Repita com backoff; em operações pagas, confira antes.
MEDIA_DEADLINE_EXPIRED504 · UNAVAILABLEO download da mídia expirou.Repita com backoff; em operações pagas, confira antes.
MEDIA_TOO_LARGE413 · VALIDATION_FAILEDA mídia excede o tamanho máximo.Reduza o arquivo ou use outro formato.
INVALID_MEDIA_SIZE400 · VALIDATION_FAILEDTamanho de mídia inválido.Corrija o corpo conforme a referência.

Atendimento

reasonHTTP · codeMensagemComo resolver
ASSIGNMENT_CONFLICT409 · CONFLICTOutra pessoa assumiu esta conversa. Atualizamos os dados; confira antes de continuar.Outra pessoa mudou o responsável. Releia a conversa e use o assignment_version atual.
CONVERSATION_HAS_NO_CONTACT409 · CONFLICTEsta conversa não tem um contato com telefone confiável para editar.Releia o estado atual e tente de novo.
MEDIA_UNAVAILABLE404 · NOT_FOUNDA mídia desta mensagem não está disponível para download.Confira o identificador e se ele está no alcance da chave.
AUDIO_TRANSCODE_UNAVAILABLE503 · UNAVAILABLEA conversão de áudio está indisponível no momento. Tente novamente mais tarde.Repita com backoff; em operações pagas, confira antes.
AUDIO_TRANSCODE_FAILED400 · VALIDATION_FAILEDNão foi possível converter o áudio. Grave novamente.Corrija o corpo conforme a referência.
AUDIO_INVALID400 · VALIDATION_FAILEDÁudio inválido ou vazio. Grave novamente.Corrija o corpo conforme a referência.
AUDIO_TOO_LARGE413 · VALIDATION_FAILEDO áudio excede o limite de 16 MB ou 15 minutos.Corrija o corpo conforme a referência.
STICKER_FORMAT_INVALID400 · VALIDATION_FAILEDFigurinhas precisam ser imagens WebP.Corrija o corpo conforme a referência.
STICKER_TOO_LARGE413 · VALIDATION_FAILEDFigurinha grande demais: até 5 MB (animadas: 500 KB e 512×512).Corrija o corpo conforme a referência.
STICKER_CONVERT_UNAVAILABLE503 · UNAVAILABLEA conversão de figurinhas está indisponível no momento.Repita com backoff; em operações pagas, confira antes.
IMAGE_FORMAT_INVALID400 · VALIDATION_FAILEDImagens precisam ser JPEG, PNG ou WebP com até 16 MB.Corrija o corpo conforme a referência.
VIDEO_FORMAT_INVALID400 · VALIDATION_FAILEDVídeos precisam ser MP4 com até 64 MB.Corrija o corpo conforme a referência.
DOCUMENT_TOO_LARGE413 · VALIDATION_FAILEDDocumentos podem ter no máximo 64 MB.Corrija o corpo conforme a referência.
STORAGE_ALLOWANCE_REACHED402 · PAYMENT_REQUIREDO armazenamento contratado foi atingido. Amplie o pacote ou remova mídias.O armazenamento do plano acabou. Apague mídias ou contrate mais espaço.

Cobrança

reasonHTTP · codeMensagemComo resolver
BILLING_UNAVAILABLE503 · UNAVAILABLECobrança temporariamente indisponível.Repita com backoff; em operações pagas, confira antes.
BILLING_INPUT_INVALID400 · VALIDATION_FAILEDDados de cobrança inválidos.Envie method (string) e request (objeto).
BILLING_METHOD_INVALID400 · VALIDATION_FAILEDOperação sem tarifa definida.Só operações pagas são cotáveis (veja a lista em Cobrança e cotações).
BILLING_MODE_INVALID400 · VALIDATION_FAILEDModo de pagamento inválido.paymentMode aceita budget ou individual.
BILLING_QUOTE_INVALID400 · VALIDATION_FAILEDCotação inválida.billing.quoteId deve ser o UUID devolvido pela cotação.
BILLING_QUOTE_REQUIRED428 · PAYMENT_REQUIREDRevise os custos da operação antes de continuar.Peça a cotação em POST /billing/quotes e envie billing.quoteId junto.
BILLING_QUOTE_EXPIRED409 · CONFLICTA cotação expirou. Revise os custos novamente.Cotações valem 15 minutos. Peça outra.
BILLING_QUOTE_MISMATCH409 · CONFLICTA cotação não corresponde a esta operação.O request mudou depois da cotação (texto, destino, número...). Cote de novo com o corpo final.
BILLING_QUOTE_CAP_EXCEEDED409 · CONFLICTA operação excede o valor revisado. Revise os custos novamente.Releia o estado atual e tente de novo.
BILLING_PAYMENT_REQUIRED402 · PAYMENT_REQUIREDSaldo insuficiente. Adicione créditos ou ajuste o plano.Saldo insuficiente. Compre créditos ou habilite o excedente em Plano e consumo.
CARD_PAYMENT_METHOD_REQUIRED402 · PAYMENT_REQUIREDCadastre um cartão para habilitar esta opção.Cote a operação e garanta saldo.
MINIMUM_CREDIT_CONFIRMATION_REQUIRED402 · PAYMENT_REQUIREDConfirme a compra do crédito mínimo para continuar.Cote a operação e garanta saldo.
BILLING_OPERATION_REJECTED403 · FORBIDDENA operação foi recusada pela cobrança.A chave precisa da permissão/número indicado; crie outra chave com o necessário.
BILLING_TENANT_INVALID403 · FORBIDDENConta de cobrança inválida.A chave precisa da permissão/número indicado; crie outra chave com o necessário.
BILLING_CATALOG_UNAVAILABLE503 · UNAVAILABLECatálogo comercial indisponível.Repita com backoff; em operações pagas, confira antes.
BILLING_CATALOG_TEST_ONLY503 · UNAVAILABLECatálogo comercial em modo de teste.Repita com backoff; em operações pagas, confira antes.
BILLING_LIVE_NOT_CONFIGURED503 · UNAVAILABLECobrança ainda não configurada.Repita com backoff; em operações pagas, confira antes.
BILLING_TARIFF_UNAVAILABLE503 · UNAVAILABLETarifa indisponível no momento.Repita com backoff; em operações pagas, confira antes.
BILLING_AI_TARIFF_UNAVAILABLE503 · UNAVAILABLETarifa de IA indisponível no momento.Repita com backoff; em operações pagas, confira antes.
BILLING_RECONCILIATION_REQUIRED409 · CONFLICTHá uma operação anterior em conciliação. Aguarde antes de repetir.Releia o estado atual e tente de novo.
BILLING_IDEMPOTENCY_CONFLICT409 · CONFLICTEsta operação já foi registrada.Esta cotação já foi usada com outro conteúdo. Cada cotação executa uma única operação.
COMMERCIAL_CATALOG_NOT_PUBLISHED503 · UNAVAILABLECatálogo comercial não publicado.Repita com backoff; em operações pagas, confira antes.
CORE_BILLING_NOT_READY503 · UNAVAILABLECobrança ainda não está pronta.Repita com backoff; em operações pagas, confira antes.
CHECKOUT_EXPIRED409 · CONFLICTO checkout expirou. Inicie um novo pagamento.Releia o estado atual e tente de novo.
CHECKOUT_RECONCILIATION_REQUIRED409 · CONFLICTUm pagamento anterior ainda está em conciliação.Releia o estado atual e tente de novo.
CHECKOUT_SUBSCRIPTION_CHANGED409 · CONFLICTA assinatura mudou. Revise e tente novamente.Releia o estado atual e tente de novo.
CHECKOUT_QUOTE_PAYMENT_CHANGED409 · CONFLICTO pagamento da cotação mudou. Revise novamente.Releia o estado atual e tente de novo.
CHECKOUT_CREDIT_PAYMENT_CHANGED409 · CONFLICTO pagamento de crédito mudou. Revise novamente.Releia o estado atual e tente de novo.
CREDIT_AMOUNT_INVALID400 · VALIDATION_FAILEDValor de crédito inválido.Corrija o corpo conforme a referência.
CREDIT_ALREADY_SUFFICIENT400 · VALIDATION_FAILEDO saldo atual já é suficiente.Corrija o corpo conforme a referência.
CREDIT_MINT_FORBIDDEN403 · FORBIDDENEmissão de crédito não permitida.A chave precisa da permissão/número indicado; crie outra chave com o necessário.
OFFER_NOT_AVAILABLE400 · VALIDATION_FAILEDOferta indisponível.Corrija o corpo conforme a referência.
EXTRA_SLOTS_INVALID400 · VALIDATION_FAILEDQuantidade de dispositivos extras inválida.Corrija o corpo conforme a referência.
STORAGE_QUANTITY_INVALID400 · VALIDATION_FAILEDQuantidade de armazenamento inválida.Corrija o corpo conforme a referência.
SUBSCRIPTION_ALREADY_EXISTS409 · CONFLICTJá existe uma assinatura ativa.Releia o estado atual e tente de novo.
DEVICE_SUBSCRIPTION_ALREADY_EXISTS409 · CONFLICTJá existe uma assinatura de dispositivos.Releia o estado atual e tente de novo.
STORAGE_SUBSCRIPTION_ALREADY_EXISTS409 · CONFLICTJá existe uma assinatura de armazenamento.Releia o estado atual e tente de novo.
DEVICE_SLOT_LIMIT_REACHED402 · PAYMENT_REQUIREDLimite de dispositivos do plano atingido. Contrate um plano ou vagas extras; sem plano, os 2 dispositivos gratuitos exigem o segundo fator ativo.O plano não tem vaga para outro número. Libere uma vaga ou contrate mais.
OVERAGE_INPUT_INVALID400 · VALIDATION_FAILEDConfiguração de excedente inválida.Corrija o corpo conforme a referência.
OVERAGE_CAP_INVALID400 · VALIDATION_FAILEDLimite de excedente inválido.Corrija o corpo conforme a referência.
OVERAGE_CAP_BELOW_COMMITTED409 · CONFLICTO limite é menor que o valor já comprometido.Releia o estado atual e tente de novo.
OVERAGE_AUTHORIZATION_FORBIDDEN403 · FORBIDDENAutorização de excedente não permitida.A chave precisa da permissão/número indicado; crie outra chave com o necessário.
OVERAGE_IS_BILLED_MONTHLY410 · NOT_FOUNDO excedente é cobrado na fatura mensal.Confira o identificador e se ele está no alcance da chave.
OPERATION_DRAFT_UNAVAILABLE409 · CONFLICTA operação revisada não está mais disponível.Releia o estado atual e tente de novo.
SUPPORT_INPUT_INVALID400 · VALIDATION_FAILEDSolicitação de suporte inválida.Corrija o corpo conforme a referência.
SUPPORT_REQUEST_UNAVAILABLE409 · CONFLICTSolicitação de suporte indisponível.Releia o estado atual e tente de novo.
SUPPORT_TRANSITION_INVALID409 · CONFLICTEsta solicitação já foi decidida.Releia o estado atual e tente de novo.
SUPPORT_OWNER_APPROVAL_REQUIRED403 · FORBIDDENExige aprovação do titular da conta.A chave precisa da permissão/número indicado; crie outra chave com o necessário.
STRIPE_NOT_CONFIGURED503 · UNAVAILABLEPagamentos indisponíveis no momento.Repita com backoff; em operações pagas, confira antes.
STRIPE_DATABASE_NOT_CONFIGURED503 · UNAVAILABLEPagamentos indisponíveis no momento.Repita com backoff; em operações pagas, confira antes.
SESSION_OWNER_MISMATCH403 · FORBIDDENEste dispositivo pertence a outra conta.A chave precisa da permissão/número indicado; crie outra chave com o necessário.
TENANT_CONTEXT_MISMATCH403 · FORBIDDENContexto de conta inválido.A chave precisa da permissão/número indicado; crie outra chave com o necessário.

Atendimento: anexos, telefones e chamadas

reasonHTTP · codeMensagemComo resolver
PHONE_INVALID400 · VALIDATION_FAILEDTelefone inválido. Confira o país (DDI), o código de área e o número.Use só dígitos com DDI e DDD (ex.: 5511987654321).
UPLOAD_EMPTY400 · VALIDATION_FAILEDO arquivo está vazio.Corrija o corpo conforme a referência.
UPLOAD_TYPE_INVALID415 · VALIDATION_FAILEDFormato de arquivo não aceito para este tipo de anexo.Corrija o corpo conforme a referência.
UPLOAD_TOO_LARGE413 · VALIDATION_FAILEDAnexo acima do limite: imagem e voz até 16 MB, vídeo e documento até 64 MB.Corrija o corpo conforme a referência.
UPLOAD_INVALID400 · VALIDATION_FAILEDEnvio de anexo inválido. Tente anexar o arquivo de novo.Corrija o corpo conforme a referência.
UPLOAD_UNAVAILABLE503 · UNAVAILABLEO envio de anexos está indisponível no momento. Tente novamente em instantes.Repita com backoff; em operações pagas, confira antes.
SESSION_OWNER_INVALID400 · VALIDATION_FAILEDEscolha um número desta empresa e um membro ativo que atenda por ele.Corrija o corpo conforme a referência.
SESSION_OWNER_NO_ACCESS409 · CONFLICTEste membro não tem acesso ao número. Libere o número em Acesso antes de delegar.Releia o estado atual e tente de novo.
SESSION_OWNERS_UNAVAILABLE503 · UNAVAILABLEResponsáveis por número ainda não estão disponíveis. Tente novamente mais tarde.Repita com backoff; em operações pagas, confira antes.
INBOX_SETTINGS_INVALID400 · VALIDATION_FAILEDConfira as configurações do atendimento.Corrija o corpo conforme a referência.
INBOX_SETTINGS_UNAVAILABLE503 · UNAVAILABLEAs configurações do atendimento estão indisponíveis no momento.Repita com backoff; em operações pagas, confira antes.
CONVERSATION_NOT_GROUP409 · CONFLICTEsta conversa não é de um grupo.Releia o estado atual e tente de novo.
OWNER_MANAGER_REQUIRED403 · FORBIDDENSó administradores e gestores definem o responsável por um número.A chave precisa da permissão/número indicado; crie outra chave com o necessário.
OWNER_MEMBER_INVALID400 · VALIDATION_FAILEDO responsável precisa ser um membro ativo (administrador, gestor ou atendente).Corrija o corpo conforme a referência.
OWNER_CHANNEL_REQUIRED409 · CONFLICTEste atendente não tem acesso ao número. Libere o número em Acesso antes de delegar.Releia o estado atual e tente de novo.
OWNER_IMMUTABLE409 · CONFLICTEste responsável não pode ser alterado desta forma.Releia o estado atual e tente de novo.
INBOX_SETTINGS_MANAGER_REQUIRED403 · FORBIDDENSó administradores e gestores alteram as configurações do atendimento.A chave precisa da permissão/número indicado; crie outra chave com o necessário.
INBOX_SETTINGS_IMMUTABLE409 · CONFLICTEstas configurações não podem ser alteradas desta forma.Releia o estado atual e tente de novo.
CALLS_UNAVAILABLE503 · UNAVAILABLEChamadas indisponíveis no momento.Repita com backoff; em operações pagas, confira antes.
CALL_NOT_FOUND404 · NOT_FOUNDEsta chamada já terminou.Confira o identificador e se ele está no alcance da chave.
CALL_ALREADY_ACCEPTED409 · CONFLICTOutra pessoa já atendeu esta chamada.Releia o estado atual e tente de novo.
CALL_OWNER_ONLY403 · FORBIDDENEste número tem responsável: só ele (ou um administrador) atende as chamadas.A chave precisa da permissão/número indicado; crie outra chave com o necessário.
CALL_SESSION_OFFLINE409 · CONFLICTO número desta conversa está desconectado.Releia o estado atual e tente de novo.
CALL_GROUP_UNSUPPORTED400 · VALIDATION_FAILEDChamadas em grupo não são atendidas pelo painel.Corrija o corpo conforme a referência.
CALL_MEDIA_TOKEN_INVALID403 · FORBIDDENAcesso à mídia da chamada expirou. Atenda novamente.A chave precisa da permissão/número indicado; crie outra chave com o necessário.
CALL_FAILED502 · UNAVAILABLENão foi possível conectar a chamada. Tente de novo.Repita com backoff; em operações pagas, confira antes.
API_KEY_DEVICES_EXCEED_ROLE403 · FORBIDDENSelecione apenas números liberados para você.A chave precisa da permissão/número indicado; crie outra chave com o necessário.

Público: listas e segmentos

reasonHTTP · codeMensagemComo resolver
SEGMENT_RULE_INVALID400 · VALIDATION_FAILEDComplete a regra do segmento: há uma condição sem valor ou com valor inválido.Corrija o corpo conforme a referência.
SEGMENT_INVALID400 · VALIDATION_FAILEDSegmento inválido. Revise o nome e as regras.Corrija o corpo conforme a referência.
AUDIENCE_LIST_INVALID400 · VALIDATION_FAILEDLista inválida. Revise o nome e os contatos escolhidos.Corrija o corpo conforme a referência.
AUDIENCE_EMPTY400 · VALIDATION_FAILEDEscolha pelo menos uma lista, segmento, etiqueta ou filtro.Corrija o corpo conforme a referência.
AUDIENCE_INVALID400 · VALIDATION_FAILEDPúblico inválido: revise as listas, segmentos e etiquetas escolhidos.Corrija o corpo conforme a referência.
AUDIENCE_TOO_LARGE400 · VALIDATION_FAILEDO público passou do limite de destinatários por campanha. Restrinja as fontes ou o filtro.Corrija o corpo conforme a referência.
AUDIENCE_LIST_ARCHIVED409 · CONFLICTA lista está arquivada. Restaure-a antes de adicionar contatos.Releia o estado atual e tente de novo.
AUDIENCE_MEMBERS_INVALID400 · VALIDATION_FAILEDQuantidade de contatos fora do limite por operação. Envie em partes menores.Corrija o corpo conforme a referência.
AUDIENCE_COMM_INVALID400 · VALIDATION_FAILEDNão foi possível alterar o status de comunicação. Revise os contatos e o motivo.Corrija o corpo conforme a referência.
AUDIENCE_SETTINGS_INVALID400 · VALIDATION_FAILEDRegras de envio inválidas. Revise palavras-chave, frequência e janela de atribuição.Corrija o corpo conforme a referência.
AUDIENCE_DUPLICATE_NAME409 · CONFLICTJá existe uma lista ou segmento com esse nome.Releia o estado atual e tente de novo.
AUDIENCE_REFERENCE_INVALID400 · VALIDATION_FAILEDUma etiqueta, lista, campo ou etapa usada aqui não existe mais.Corrija o corpo conforme a referência.
AUDIENCE_VALUE_INVALID400 · VALIDATION_FAILEDHá um valor inválido. Revise os dados informados.Corrija o corpo conforme a referência.

Recuperação

reasonHTTP · codeMensagemComo resolver
RECOVERY_INVALID400 · VALIDATION_FAILEDSequência inválida. Revise nome, descrição, segmento e contatos.Corrija o corpo conforme a referência.
RECOVERY_STEPS_INVALID400 · VALIDATION_FAILEDRevise as etapas: cada mensagem precisa de texto e cada tarefa de título e prazo válidos.Corrija o corpo conforme a referência.
RECOVERY_ARCHIVED409 · CONFLICTA sequência está arquivada.Releia o estado atual e tente de novo.
RECOVERY_NOT_ACTIVE409 · CONFLICTEsta execução já terminou.Releia o estado atual e tente de novo.
RECOVERY_NOT_ARCHIVED409 · CONFLICTArquive a sequência antes de excluí-la permanentemente.Releia o estado atual e tente de novo.
RECOVERY_DELETE_CONFIRM_MISMATCH400 · VALIDATION_FAILEDDigite o nome da sequência exatamente como aparece para confirmar.Corrija o corpo conforme a referência.

CRM

reasonHTTP · codeMensagemComo resolver
CRM_UNAVAILABLE503 · UNAVAILABLECRM indisponível no momento.Repita com backoff; em operações pagas, confira antes.
CRM_LOSS_REASON_REQUIRED400 · VALIDATION_FAILEDInforme o motivo da perda.Corrija o corpo conforme a referência.
CRM_LOSS_REASON_INVALID400 · VALIDATION_FAILEDEscolha um motivo de perda da lista.Corrija o corpo conforme a referência.
CRM_LOSS_REASON_LABEL_INVALID400 · VALIDATION_FAILEDO motivo precisa ter de 1 a 120 caracteres.Corrija o corpo conforme a referência.
CRM_LOSS_REASON_EXISTS409 · CONFLICTJá existe um motivo de perda com esse texto.Releia o estado atual e tente de novo.
CRM_LOSS_NOTE_TOO_LONG400 · VALIDATION_FAILEDA observação da perda aceita até 500 caracteres.Corrija o corpo conforme a referência.
CRM_FIELD_REQUIRED400 · VALIDATION_FAILEDPreencha os campos obrigatórios.Corrija o corpo conforme a referência.
CRM_FIELD_INVALID400 · VALIDATION_FAILEDAlgum campo personalizado tem um valor inválido para o tipo dele.Corrija o corpo conforme a referência.
CRM_FIELD_UNKNOWN400 · VALIDATION_FAILEDCampo personalizado desconhecido ou arquivado.Corrija o corpo conforme a referência.
CRM_FIELD_KEY_EXISTS409 · CONFLICTJá existe um campo com essa chave.Releia o estado atual e tente de novo.
CRM_FIELD_KEY_INVALID400 · VALIDATION_FAILEDUse na chave letras minúsculas, números e _ (até 40), começando por letra.Corrija o corpo conforme a referência.
CRM_FIELD_LABEL_INVALID400 · VALIDATION_FAILEDO nome do campo precisa ter de 1 a 80 caracteres.Corrija o corpo conforme a referência.
CRM_FIELD_IMMUTABLE409 · CONFLICTA chave e o tipo de um campo não mudam. Arquive e crie outro.Releia o estado atual e tente de novo.
CRM_FIELD_OPTION_REMOVED409 · CONFLICTOpções existentes não podem ser removidas. Arquive o campo para trocar a lista.Releia o estado atual e tente de novo.
CRM_FIELD_OPTIONS_REQUIRED400 · VALIDATION_FAILEDListas precisam de 1 a 100 opções.Corrija o corpo conforme a referência.
CRM_FIELD_OPTION_DUPLICATE400 · VALIDATION_FAILEDHá opções repetidas na lista.Corrija o corpo conforme a referência.
CRM_FIELD_OPTION_INVALID400 · VALIDATION_FAILEDOpções de lista múltipla não podem conter vírgula.Corrija o corpo conforme a referência.
CRM_FIELD_OPTION_TOO_LONG400 · VALIDATION_FAILEDCada opção aceita até 80 caracteres.Corrija o corpo conforme a referência.
CRM_FIELD_LIMIT400 · VALIDATION_FAILEDLimite de 100 campos personalizados atingido.Corrija o corpo conforme a referência.
CRM_TAG_EXISTS409 · CONFLICTJá existe uma etiqueta com esse nome.Releia o estado atual e tente de novo.
CRM_TAG_ARCHIVED409 · CONFLICTEssa etiqueta está arquivada.Releia o estado atual e tente de novo.
CRM_TAG_UNKNOWN400 · VALIDATION_FAILEDEtiqueta não encontrada.Corrija o corpo conforme a referência.
CRM_TAG_NAME_REQUIRED400 · VALIDATION_FAILEDInforme o nome da etiqueta.Corrija o corpo conforme a referência.
CRM_TAG_NAME_TOO_LONG400 · VALIDATION_FAILEDO nome da etiqueta aceita até 64 caracteres.Corrija o corpo conforme a referência.
CRM_TAG_NAME_INVALID400 · VALIDATION_FAILEDNome de etiqueta inválido.Corrija o corpo conforme a referência.
CRM_TAG_TARGET_REQUIRED400 · VALIDATION_FAILEDSelecione ao menos um contato ou conversa.Corrija o corpo conforme a referência.
CRM_TAGS_REQUIRED400 · VALIDATION_FAILEDSelecione ao menos uma etiqueta.Corrija o corpo conforme a referência.
CRM_TAG_ADD_AND_REMOVE400 · VALIDATION_FAILEDUma etiqueta não pode ser aplicada e removida ao mesmo tempo.Corrija o corpo conforme a referência.
CRM_BULK_LIMIT400 · VALIDATION_FAILEDSelecione até 500 contatos e 50 etiquetas por vez.Corrija o corpo conforme a referência.
CRM_COLOR_INVALID400 · VALIDATION_FAILEDCor inválida.Corrija o corpo conforme a referência.
CRM_DUPLICATE409 · CONFLICTJá existe um item com esse nome.Releia o estado atual e tente de novo.
CRM_PIPELINE_EXISTS409 · CONFLICTJá existe um funil com esse nome.Releia o estado atual e tente de novo.
CRM_PIPELINE_INVALID400 · VALIDATION_FAILEDFunil não encontrado.Corrija o corpo conforme a referência.
CRM_PIPELINE_NAME_INVALID400 · VALIDATION_FAILEDO nome do funil precisa ter de 1 a 80 caracteres.Corrija o corpo conforme a referência.
CRM_PIPELINE_CLOSED_STAGES400 · VALIDATION_FAILEDO funil precisa de exatamente uma etapa de ganho e uma de perda.Corrija o corpo conforme a referência.
CRM_PIPELINE_OPEN_STAGE_REQUIRED400 · VALIDATION_FAILEDO funil precisa de ao menos uma etapa em andamento.Corrija o corpo conforme a referência.
CRM_PIPELINE_DEFAULT_ARCHIVED409 · CONFLICTEscolha outro funil padrão antes de arquivar este.Releia o estado atual e tente de novo.
CRM_PIPELINE_TOO_MANY_STAGES400 · VALIDATION_FAILEDUm funil aceita até 30 etapas.Corrija o corpo conforme a referência.
CRM_STAGE_INVALID400 · VALIDATION_FAILEDEtapa inválida para este funil.Corrija o corpo conforme a referência.
CRM_STAGE_NOT_FOUND404 · NOT_FOUNDEtapa não encontrada.Confira o identificador e se ele está no alcance da chave.
CRM_STAGE_IN_USE409 · CONFLICTMova as oportunidades antes de remover a etapa.Releia o estado atual e tente de novo.
CRM_STAGE_KIND_IN_USE409 · CONFLICTMova as oportunidades antes de mudar o tipo da etapa.Releia o estado atual e tente de novo.
CRM_STAGE_NAME_DUPLICATE400 · VALIDATION_FAILEDHá etapas com o mesmo nome.Corrija o corpo conforme a referência.
CRM_STAGE_NAME_INVALID400 · VALIDATION_FAILEDO nome da etapa precisa ter de 1 a 60 caracteres.Corrija o corpo conforme a referência.
CRM_STAGE_PROBABILITY_INVALID400 · VALIDATION_FAILEDProbabilidade de 0 a 100 (ganho = 100, perdido = 0).Corrija o corpo conforme a referência.
CRM_OPPORTUNITY_TITLE_INVALID400 · VALIDATION_FAILEDO título precisa ter de 1 a 160 caracteres.Corrija o corpo conforme a referência.
CRM_OPPORTUNITY_VALUE_INVALID400 · VALIDATION_FAILEDValor inválido.Corrija o corpo conforme a referência.
CRM_CURRENCY_INVALID400 · VALIDATION_FAILEDMoeda inválida (use o código de 3 letras, como BRL).Corrija o corpo conforme a referência.
CRM_DATE_INVALID400 · VALIDATION_FAILEDData inválida.Corrija o corpo conforme a referência.
CRM_OWNER_INVALID400 · VALIDATION_FAILEDO responsável precisa ser membro da empresa.Corrija o corpo conforme a referência.
CRM_REFERENCE_INVALID400 · VALIDATION_FAILEDUm dos itens relacionados não existe mais.Corrija o corpo conforme a referência.
CRM_VALUE_INVALID400 · VALIDATION_FAILEDValor inválido.Corrija o corpo conforme a referência.
CRM_TASK_TITLE_INVALID400 · VALIDATION_FAILEDO título da tarefa precisa ter de 1 a 200 caracteres.Corrija o corpo conforme a referência.
CRM_TASK_NOTES_TOO_LONG400 · VALIDATION_FAILEDAs notas da tarefa aceitam até 4.000 caracteres.Corrija o corpo conforme a referência.
CRM_NOT_ARCHIVED409 · CONFLICTArquive o item antes de excluí-lo permanentemente.Releia o estado atual e tente de novo.
CRM_PIPELINE_IN_USE409 · CONFLICTAinda há oportunidades neste funil. Mova ou exclua as oportunidades antes de excluir o funil.Releia o estado atual e tente de novo.
CRM_LOSS_REASON_IN_USE409 · CONFLICTHá oportunidades perdidas com este motivo; ele não pode ser excluído (mantenha-o arquivado).Releia o estado atual e tente de novo.

Fluxos

reasonHTTP · codeMensagemComo resolver
FLOW_REVISION_CONFLICT409 · CONFLICTEste fluxo foi salvo em outro lugar (outra aba ou outra pessoa) depois que você abriu o editor.O fluxo mudou desde a leitura. Leia de novo e reaplique a alteração.
FLOW_NOT_PUBLISHED409 · CONFLICTPublique o fluxo antes de ativá-lo.Releia o estado atual e tente de novo.
FLOW_ARCHIVED409 · CONFLICTDesarquive o fluxo antes de publicar.Releia o estado atual e tente de novo.
FLOW_NOT_ARCHIVED409 · CONFLICTArquive o fluxo antes de excluí-lo permanentemente.Releia o estado atual e tente de novo.
FLOW_DELETE_CONFIRM_MISMATCH400 · VALIDATION_FAILEDDigite o nome do fluxo exatamente como aparece para confirmar.Corrija o corpo conforme a referência.