Pular para o conteúdo principal

Remetentes SMS

Aprovação de Remetentes SMS​

O envio de mensagens SMS através do Arpoone implica que o remetente pretendido se encontre devidamente autorizado.

O processo de autorização consiste nos seguintes passos:

  • Solicitar o remetente via plataforma ou programaticamente, via API:
    • Em ambos os casos, é necessário especificar o texto do remetente e anexar (ou parametrizar) um ficheiro comprovativo da legitimidade de utilização do remetente a solicitar;
    • Via Plataforma: Acedido através de: Fotografia de Perfil → Configurações → Remetentes → Remetentes de SMS; Este vídeo ilustra o processo.
    • Via API: Invocar endpoint para criação de remetentes sms
  • Aguardar aprovação por parte da equipa do Arpoone. Será enviado um Email de notificação após a solicitação ser aceite.
  • Após aprovação, o utilizador que requisitou o pedido será automaticamente associado ao remetente, podendo a partir desse momento efectuar envios utilizando o remetente aprovado. Caso seja necessário associar outros utilizadores da organização ao remetente, a configuração de associações pode ser efectuada via plataforma, acedendo aos detalhes do remetente.

Regras sintáticas para Remetentes SMS​

Os remetentes de SMS podem ser alfanuméricos ou numéricos e devem obedecer às seguintes regras sintáticas:

  • Remetentes alfanuméricos: Permite entre 1 e 11 caracteres alfanuméricos, incluindo espaço e os seguintes caracteres especiais: _, ,, ., + e -.
  • Remetentes numéricos: Permite entre 1 e 16 caracteres, contendo apenas números (0-9). É permitido o carácter + como primeiro carácter.

Endpoint de criação de Remetente SMS​

O endpoint de criação de remetente SMS permite criar um pedido de remetente SMS. Este pedido será submetido ao processo de aprovação, por parte da equipa Arpoone, e após aprovação estará disponível para utilização nos envios.

É possível consultar o estado de aprovação do remetente via plataforma Arpoone em: Fotografia de Perfil → Configurações → Remetentes → Remetentes de SMS;

A operação permite especificar os seguintes campos:

  • organizationId - Identificador da organização onde o remetente será configurado
  • sender - Texto do remetente
  • file - Objecto contendo o ficheiro submetido para aprovação
    • mimeType - Tipo MIME do ficheiro
      • Valores suportados: text/plain, application/pdf, image/png, image/jpeg
    • name - Nome do ficheiro
      • Extensões suportadas: .txt, .pdf, .png, .jpg, .jpeg
    • base64Content - Conteúdo do ficheiro, codificado em base64. Tamanho máximo de 10MB.

Exemplo:

{
  "organizationId": "02f5d8fc-1317-487c-82ba-7d9b900e0c46",
  "sender": "sender",
  "file": {
    "mimeType": "image/png",
    "name": "proof.png",
    "base64Content": "iVBORw0KGgoAA..."
  }
}

Resposta​

Uma resposta bem sucedida retornará informação sobre o pedido de criação de remetente:

  • senderRequestId – Identificador do pedido de remetente
  • requestingOrganizationId – Organização que requisitou o pedido
  • sender – Texto do remetente
  • status – Estado de aprovação do remetente (por omissão, PENDING)
    • Valores: PENDING, APPROVED, REFUSED

Exemplo:

"senderRequest": {
    "senderRequestId": "8a681239-2630-4f38-bd42-f1e184e436e7",
    "requestingOrganizationId": "02f5d8fc-1317-487c-82ba-7d9b900e0c46",
    "sender": "sender",
    "status": "PENDING"
  },
  "error": {
    "code": null,
    "param": null,
    "description": null
  }
}

Erros​

Em situações de erro, a propriedade error.code especifica que tipo de erro ocorreu. A lista completa de códigos de erro pode ser consultada neste link

Aceder à API Reference