API de SMS

createSMSMessage Obsoleto

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

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

Corpo da solicitação

Nome	Obrigatório	Tipo	Descrição
auth*	Sim	string	Token de acesso à API do Painel de Controle da Pushwoosh.
application*	Sim	string	Código do aplicativo Pushwoosh
notifications*	Sim	array	Configurações de conteúdo. Array JSON de parâmetros da mensagem. Veja os detalhes abaixo.

Parâmetros de notificação

Nome	Obrigatório	Tipo	Descrição
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	Placeholders de conteúdo dinâmico para personalizar o conteúdo da mensagem. Cada placeholder será substituído pelos valores dinâmicos correspondentes.
preset	Não	string	Código de Preset de SMS do seu Painel de Controle.

Exemplo de solicitação

{
  "request": {
    "application": "12345-67891",    // obrigatório. Código do aplicativo Pushwoosh.
    "auth": "yxoPUlwqm…………pIyEX4H",  // obrigatório. Token de acesso à API do Painel de Controle da Pushwoosh.
    "notifications": [{
      "send_date": "now",            // obrigatório. YYYY-MM-DD HH:mm OU "now".
      "content": "Hello!",           // obrigatório. Texto do SMS (string).
      "devices": ["+1234567890"],    // obrigatório. 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.
      "preset": "XXXXX-XXXXX",       // opcional. Código de Preset de SMS do seu Painel de Controle.
      "use_auto_registration": true  // opcional. Registra automaticamente o número de telefone especificado
                                     //           no parâmetro "devices".
    }]
  }
}

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 as estatísticas de cada mensagem na seção Histórico de Mensagens.