Ir para o conteúdo

Transacional — Mensagem

Uma mensagem transacional é uma mensagem preparada e parametrizável enviada para um único contacto.

As mensagens podem utilizar códigos de merge padrão, além de códigos Transactional:[argument_name] onde argument_name é uma palavra livre passada através de argumentos fornecidos a /transactional/message/send/.

Endpoints

Método URL
GET /transactional/<transactional>/message/<transactionalmessage>
POST /transactional/<transactional>/message
PUT /transactional/<transactional>/message/<transactionalmessage>
DELETE /transactional/<transactional>/message/<transactionalmessage>

GET /transactional/<transactional>/message/<transactionalmessage>

Payload: Sem payload.

Devolve: A mensagem.

Example:

curl -u "username:api_key" -H "Accept: application/json" \
  https://app.duo.pt/transactional/{transactional_id}/message/{message_id}

Response:

{
  "success": true,
  "data": {
    "transactionalMessage": {
      "id": 1,
      "name": "Order Confirmation",
      "send_transactional": 1,
      "event_callback": null
    },
    "transactional": {
      "id": 1,
      "owner": 1,
      "name": "Order Confirmation",
      "list": 1,
      "domain": 1,
      "smtp_submission": false,
      "send_dsn": false
    },
    "email": null,
    "sms": null
  }
}

POST /transactional/<transactional>/message

Parâmetro Tipo Descrição
name string Nome da mensagem
event_callback string Opcional. URL chamado quando ocorrem eventos.

Devolve: A nova mensagem.

Example:

curl -u "username:api_key" -H "Accept: application/json" \
  -d "name=My+Message" \
  https://app.duo.pt/transactional/{transactional_id}/message

Response:

{
  "success": true,
  "data": {
    "transactional": {
      "id": 1,
      "owner": 1,
      "name": "Order Confirmation",
      "list": 1,
      "domain": 1,
      "smtp_submission": false,
      "send_dsn": false
    },
    "transactionalMessage": {
      "id": 1,
      "name": "Order Confirmation",
      "send_transactional": 1,
      "event_callback": null
    }
  }
}

PUT /transactional/<transactional>/message/<transactionalmessage>

Mesmo payload que o POST.

Devolve: A mensagem editada.

Example:

curl -u "username:api_key" -H "Accept: application/json" -X PUT \
  -d "name=Updated+Message" \
  https://app.duo.pt/transactional/{transactional_id}/message/{message_id}

Response:

{
  "success": true,
  "data": {
    "transactionalMessage": {
      "id": 1,
      "name": "Order Confirmation",
      "send_transactional": 1,
      "event_callback": null
    }
  }
}

DELETE /transactional/<transactional>/message/<transactionalmessage>

Payload: Sem payload.

Devolve: A mensagem eliminada.

Example:

curl -u "username:api_key" -H "Accept: application/json" -X DELETE \
  https://app.duo.pt/transactional/{transactional_id}/message/{message_id}

Comportamento do Callback

Mesmo comportamento de callback que Campanha.