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`).
`FEATURE_IS_DISABLED`	Funcionalidade não activa para a organização.
`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
`INVALID_URL`	URL inválido
`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

Envio de RCS

Código	Descrição
`INVALID_REQUEST`	O pedido está incorrectamente formado ou contém propriedades inválidas.
`ORGANIZATION_NOT_FOUND`	A organização especificada não existe ou não está acessível ao utilizador autenticado.
`RCS_CHANNEL_NOT_ENABLED`	O canal RCS não está activado para a organização.
`INVALID_RECIPIENT`	O número do destinatário está em falta ou é inválido.
`INVALID_SENDER`	O remetente especificado está em falta, é inválido ou não está configurado para a organização.
`INVALID_EXPIRATION_DATE`	A data de expiração é inválida ou já passou.
`EMPTY_MESSAGES`	O array `messages` não contém elementos.
`MAX_MESSAGES_EXCEEDED`	O pedido contém mais de 10 mensagens.
`INVALID_CONTENT`	O conteúdo RCS não satisfaz as regras de validação aplicáveis.
`MULTIPLE_CONTENT_TYPES`	Foi fornecido mais do que um tipo de conteúdo primário RCS.
`TEXT_LENGTH_EXCEEDED`	O texto contém mais de 3 072 caracteres.
`MESSAGE_SIZE_EXCEEDED`	Uma mensagem excede o tamanho máximo de 250 KB.
`MAX_SUGGESTIONS_EXCEEDED`	O limite de sugestões aplicável foi excedido.
`INVALID_SUGGESTION`	Uma sugestão está incompleta ou contém propriedades inválidas.
`INVALID_MEDIA_URL`	Um URL de conteúdo multimédia ou de miniatura é inválido.
`MEDIA_NOT_ACCESSIBLE`	Não foi possível aceder ao recurso multimédia.
`UNSUPPORTED_MEDIA_TYPE`	O tipo MIME declarado não é suportado.
`INVALID_RICH_CARD`	A rich card não contém conteúdo válido.
`INVALID_CAROUSEL`	O carrossel contém um número inválido de cartões ou conteúdo de cartão inválido.
`INSUFFICIENT_BALANCE`	A organização não dispõe de saldo RCS suficiente.
`RATE_LIMIT_EXCEEDED`	O limite aplicável à taxa de pedidos foi excedido.
`INTERNAL_ERROR`	Ocorreu um erro interno inesperado.

Consultar saldo

Code	Descrição
`ORGANIZATION_ID_EMPTY`	Identificador de organização não especificado
`ORGANIZATION_BALANCE_CONFIG_NOT_FOUND`	Configuração de saldo inválida. Em caso de persistência, contactar a equipa de suporte

Transferir Email

Code	Descrição
`SOURCE_ORGANIZATION_ID_EMPTY`	Identificador de organização source não especificado
`DESTINATION_ORGANIZATION_ID_EMPTY`	Identificador de organização destination não especificado
`BALANCE_TRANSFER_FAILED`	Não foi possível realizar a transferência de saldo. Em caso de persistência, contactar a equipa de suporte

Transferir SMS

Code	Descrição
`SOURCE_ORGANIZATION_ID_EMPTY`	Identificador de organização source não especificado
`DESTINATION_ORGANIZATION_ID_EMPTY`	Identificador de organização destination não especificado
`COUNTRY_ID_EMPTY`	Código do país não especificado
`INVALID_COUNTRY_ID`	Código do país inválido. Este código deve seguir o formato ISO 3166-1 alpha-2
`BALANCE_TRANSFER_FAILED`	Não foi possível realizar a transferência de saldo. Em caso de persistência, contactar a equipa de suporte

Lista de erros

Objecto error​

Códigos de erro​

Geral​

Audiência​

Envio de Email​

Envio de SMS​

Envio de RCS​

Consultar saldo​

Transferir Email​

Transferir SMS​