Ir para o conteúdo

Campanha — SMS

Entidade SMS da campanha. Este é o payload enviado via SMS quando a campanha é executada.

Nota

O ID do remetente SMS é configurado ao nível da plataforma e não pode ser definido por campanha. Contacte o gestor de conta para alterar o remetente registado.

Endpoint

Método URL
POST /campaign/<campaign>/sms
PUT /campaign/<campaign>/sms
DELETE /campaign/<campaign>/sms

POST /campaign/<campaign>/sms

Parâmetro Tipo Descrição
message string Texto da mensagem

Devolve: A campanha e o SMS editados.

Example:

curl -u "username:api_key" -H "Accept: application/json" \
  -d "message=Your+SMS+message+here" \
  https://app.duo.pt/campaign/{campaign_id}/sms

Response:

{
  "success": true,
  "data": {
    "sms": {
      "message": "Your order has been confirmed.",
      "send_scheduled": 1
    }
  }
}

PUT /campaign/<campaign>/sms

Parâmetro Tipo Descrição
message string Texto da mensagem

Nota

Os parâmetros devem ser enviados como query string (não como body), e devem incluir send_scheduled com o ID da campanha.

Devolve: A campanha e o SMS editados.

Example:

curl -u "username:api_key" -H "Accept: application/json" -X PUT \
  "https://app.duo.pt/campaign/{campaign_id}/sms?send_scheduled={campaign_id}&message=Updated+SMS+text"

Response:

{
  "success": true,
  "data": {
    "sms": {
      "message": "Updated SMS text",
      "send_scheduled": 1
    }
  }
}

DELETE /campaign/<campaign>/sms

Payload: Sem payload.

Devolve: O SMS eliminado.

Example:

curl -u "username:api_key" -H "Accept: application/json" -X DELETE \
  https://app.duo.pt/campaign/{campaign_id}/sms

Response:

{
  "success": true,
  "data": {
    "sms": {
      "message": "Your order has been confirmed.",
      "send_scheduled": 1
    }
  }
}