API de SMS

createSMSMessage

Usado para enviar notificações SMS para usuários

POST https://api.pushwoosh.com/json/1.3/createSMSMessage

Corpo da requisição

Name	Required	Type	Description
auth*	Sim	string	Token de acesso da API do Painel de Controle Pushwoosh.
application*	Sim	string	Código da aplicação Pushwoosh
notifications*	Sim	array	Configurações de conteúdo. Array JSON de parâmetros da mensagem. Veja detalhes abaixo.

Parâmetros de notificação

Name	Required	Type	Description
send_date*	Sim	string	Data e hora para enviar a notificação. Use o formato `YYYY-MM-DD HH:mm` ou `now` para enviar imediatamente.
content*	Sim	string	Conteúdo de texto da mensagem SMS.
devices*	Sim	array	Número de telefone do cliente (deve estar associado a um UserId usando `/registerDevice` e especificado no parâmetro `hwid` ou use `use_auto_registration`). Apenas um número pode ser especificado aqui.
use_auto_registration	Não	boolean	Se definido como `true`, o número de telefone especificado no parâmetro `devices` será registrado automaticamente.
dynamic_content_placeholders	Não	object	Marcadores de conteúdo dinâmico para personalizar o conteúdo da mensagem. Cada marcador será substituído pelos valores dinâmicos correspondentes.
preset	Não	string	Código de Predefinição de SMS do seu Painel de Controle.

Exemplo de requisição

{
  "request": {
    "application": "12345-67891",    // required. Pushwoosh application code.
    "auth": "yxoPUlwqm…………pIyEX4H",  // required. API access token from Pushwoosh Control Panel.
    "notifications": [{
      "send_date": "now",            // required. YYYY-MM-DD HH:mm OR "now".
      "content": "Hello!",           // required. SMS text (string).
      "devices": ["+1234567890"],    // required. Customer phone number (must be associated with
                                     //           a UserId using. /registerDevice and specified in
                                     //           the "hwid" parameter or use "use_auto_registration").
                                     //           Only one number can be specified here.
      "preset": "XXXXX-XXXXX",       // optional. SMS Preset Code from your Control Panel.
      "use_auto_registration": true  // optional. Automatically register phone number specified
                                     //           in "devices" parameter.
    }]
  }
}

Exemplo de resposta

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "9648-0B10ECB6-0D9F214D"
    ]
  }
}

Resposta de erro

{
  "status_code": 210,
  "status_message": "Invalid devices list. \"devices\" must be an array.",
  "response": {
    "Messages": []
  }
}

Para obter estatísticas de SMS, use o método totalsByIntervals.

Você também pode visualizar estatísticas para cada mensagem na seção Histórico de Mensagens.