Ir para o conteúdo

Mensagem Transacional — Enviar

Enviar uma mensagem transacional para um ou mais destinatários.

Endpoint

Método URL
POST /transactional/<transactional>/message/<transactionalmessage>/send

POST

Parâmetro Tipo Descrição
event_callback string Opcional. URL de callback para eventos do ciclo de vida.
email[] array de string Opcional. Lista de endereços de email para enviar.
telephone[] array de string Opcional. Números de telefone para enviar SMS.
attachment[] array de object Opcional. Anexos para email. Ver estrutura abaixo.
<custom_field>[] array de string Opcional. Argumentos para placeholders %Transactional:[argument_name]%.

Nota

telephone[] ou email[] (ou ambos) devem estar definidos.

Enviar para múltiplos destinatários

Passe parâmetros de array repetindo o argumento:

?email[]=foo%40example.com&email[]=bar%40example.com

Ao enviar simultaneamente para email e SMS, as entradas com o mesmo índice em email[] e telephone[] são tratadas como o mesmo contacto. Utilize uma string vazia para contactos que têm apenas um canal.

email[], telephone[], attachment[] e os parâmetros de campos personalizados devem ter todos o mesmo comprimento.

Estrutura de anexo

Chave Descrição
filename Nome do ficheiro
content-type Tipo MIME
base64 Dados do anexo codificados em Base64

Dica

Para payloads grandes (especialmente com anexos), envie como JSON: defina Content-Type: application/json e submeta como dicionário JSON.

Devolve: Array de envelopes de sucesso da API, um por contacto submetido.

Exemplo:

curl -u "username:api_key" -H "Accept: application/json" \
  -d "to_email=recipient@example.com&to_telephone=351910000000" \
  https://app.duo.pt/transactional/{transactional_id}/message/{message_id}/send

Resposta:

{
  "success": true,
  "data": {
    "result": [
      {
        "success": true,
        "data": null
      }
    ]
  }
}

Comportamento do Callback

Mesmo comportamento de callback que Campanha.