Lista de erros

A API prevê o retorno dos seguintes códigos HTTP, caso não consiga satisfazer um determinado pedido com sucesso:

• 401 – Unauthorized - erro de autenticação (e.g. API Key inválida)
• 400 – Bad Request - parametrização inválida ou violação de uma regra de negócio que impede a satisfação do pedido

Objecto error

Em certos cenários de erro, é retornado no corpo do pedido um objecto contendo detalhes sobre o erro ocorrido:

{
    code: "",
    param: "",
    description: ""
}

O significado dos campos é o seguinte:

• code - código do erro ocorrido;
• param - nome do parâmetro que originou o erro (caso aplicável);
• description - descrição textual do erro.

Códigos de erro

É previsto o retorno dos seguintes códigos de erro:

Geral

Code	Descrição
PARAM_INVALID	Valor de parâmetro inválido (nome do parâmetro indicado no campo param).
PARAM_EXCEEDS_MAX_LENGTH	Valor de parâmetro excede o tamanho máximo (nome do parâmetro indicado no campo param).
PAYLOAD_EXCEEDS_MAX_SIZE	Tamanho máximo de payload do pedido excedido
GENERIC_ERROR	Erro genérico. Contactar a equipa de suporte

Audiência

Code	Descrição
INCOMPLETE_KEY_COLUMN_MAPPING	Não encontrados todos os campos-chave necessários no objecto parametrizado.
INVALID_KEY_CONFIGURATION	Valor de campo-chave inválido
SCHEMA_MISMATCH	Schema incompatível
AUDIENCE_SCHEMA_NOT_FOUND	Schema de organização inexistente
RECIPIENT_ALREADY_EXISTS	Contacto já existente
MAX_PLAN_RECIPIENT_COUNT_REACHED	Atingido o número máximo de contactos da audiência permitidos pelo plano

Envio de Email

Code	Descrição
FROM_NOT_ALLOWED	Remetente de Email não autorizado. Consultar secção de configuração de domínio
NO_CONTENT_DEFINED	Não foi definido conteúdo a enviar nos campos TextContent ou HtmlContent
EMAIL_ATTACHMENTS_NOT_ALLOWED	Não tem permissão para envios de anexos de Email
ATTACHMENT_PARAM_EMPTY	Parâmetro de anexo vazio
ATTACHMENT_PARAM_TOO_LONG	Parâmetro de anexo excede o tamanho máximo
ATTACHMENT_PARAM_INVALID	Parâmetro de anexo inválido
INVALID_WEBHOOK_URL	URL de webhook inválido
INSUFFICIENT_BALANCE	Organização não dispõe de saldo suficiente para enviar a mensagem
TOO_MANY_RECIPIENTS	Demasiados destinatários configurados nas propriedades To, CC, BCC - há um limite cumulativo de 50 destinatários para cada Email individual configurado

Envio de SMS

Code	Descrição
FROM_NOT_ALLOWED	Remetente de SMS não autorizado. Consultar secção de configuração de domínio
MOBILE_OPERATOR_NOT_FOUND	Operador móvel não encontrado
INVALID_WEBHOOK_URL	URL de webhook inválido
INSUFFICIENT_BALANCE	Organização não dispõe de saldo suficiente para enviar a mensagem
WEBHOOK_CUSTOM_PAYLOAD_EXCEEDS_MAX_LENGTH	Conteúdo de campo CustomPayload excede o tamanho máximo de 1KB