# API de SMS

import { Badge } from '@astrojs/starlight/components';

<Aside type="caution" title="/createSMSMessage está obsoleto">
Novas integrações devem usar a [API de Mensagens v2](/pt/developer/api-reference/messaging-api-v2/) — passe `platforms: ["SMS"]` para `Notify`. Consulte o [guia de migração](/pt/developer/api-reference/messaging-api-v2/migration-from-v1/#from-createsmsmessage).
</Aside>

<Aside type="note">
Antes de enviar mensagens SMS, conecte seu provedor de SMS no Painel de Controle. [Saiba mais](/pt/developer/first-steps/connect-messaging-services/sms-configuration/)
</Aside>

## createSMSMessage <Badge text="Obsoleto" variant="caution" size="small" />

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](/pt/developer/api-reference/api-identifiers/#api-access-token) do Painel de Controle da Pushwoosh.                                                               |
| **application***               | Sim         | string  | [Código do aplicativo Pushwoosh](/pt/developer/api-reference/api-identifiers/#application-code)                                                                                 |
| **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 usar `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 predefinição (Preset Code)](/pt/developer/api-reference/api-identifiers/#preset-code) de SMS do seu Painel de Controle.                                                                                                                                                      |

### Exemplo de solicitação

```json
{
  "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 usar "use_auto_registration").
                                     //           Apenas um número pode ser especificado aqui.
      "preset": "XXXXX-XXXXX",       // opcional. Código de predefinição (Preset Code) 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

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

### Resposta de erro
```json
{
  "status_code": 210,
  "status_message": "Invalid devices list. \"devices\" must be an array.",
  "response": {
    "Messages": []
  }
}
```

<Aside type="note">
 Atualmente, cada SMS deve ser enviado em uma solicitação separada para cada cliente.
</Aside>

Para obter estatísticas de SMS, use o método [totalsByIntervals](/pt/developer/api-reference/statistics-api/message-statistics-api/#totalsbyintervals).

Você também pode visualizar as estatísticas de cada mensagem na seção [Histórico de Mensagens](/pt/product/statistics-and-analytics/message-history/).

<Aside type="caution">
Observe que algumas operadoras de telefonia móvel não transmitem dados de status de entrega, portanto, as estatísticas podem não ser precisas. Você pode verificar os detalhes com as operadoras de telefonia móvel que fornecem números para seus clientes.
</Aside>