---
title: "Crie uma campanha SMS usando a API"
slug: "api-create-sms"
updated: 2026-06-12T10:30:51Z
published: 2026-06-12T10:30:51Z
canonical: "docs.xtremepush.com/api-create-sms"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xtremepush.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Crie uma campanha SMS usando a API

Se ainda não fez isso, primeiro revise a visão geral sobre o uso dos [métodos de criar e enviar campanhas](/documentation/docs/pt-br/api-campaign) para enviar mensagens via API.

Para criar um SMS, você precisará adicionar uma mensagem SMS nos seus parâmetros POST ao chamar o `create` método. Os parâmetros usados no conteúdo das mensagens SMS estão listados abaixo:

## Parâmetros

| Parâmetro | Descrição |
| --- | --- |
| Mensagens | Defina para o número 9 para SMS, ou seja, ```Code "messages": { "9": { "SMS_CONTENT PARAMS" } } ``` Um objeto JSON contendo os parâmetros SMS |
| SMS | ```Code "sms": { "from": "xtremepush", "text": "Hello" } ``` |
| de | O cabeçalho from que é usado para identificar sua marca |
| Texto | O texto principal da mensagem SMS |

> [!NOTE]
> SMS a partir de nomes
> 
> SMS de nomes substitui o número do remetente na sua mensagem SMS vista pelo seu público e é capturada pelo `from` parâmetro. Esses precisam ser pré-configurados na página [de configurações do SMS](/documentation/docs/pt-br/sms-settings) .

## Exemplo

O canal SMS é ativado com `"sms": 1` e o SMS tipo 9 é adicionado ao objeto mensagens com parâmetros para o conteúdo do SMS. Neste exemplo `"broadcast": 1` , é usado para atingir toda a sua base de usuários disponíveis. Condições que miram uma subseção do seu público, além de opções de agendamento e outras podem ser adicionadas conforme descrito no [guia de modelos de campanha](/ref:campaign-model).

Neste exemplo, uma tag de personalização foi adicionada no texto do SMS para puxar os primeiros nomes dos usuários.

```shell
curl --request POST \
  --url https://external-api.xtremepush.com/api/external/create/campaign \
  --header 'content-type: application/json' \
  --data '{
    "apptoken": "YOUR_APPTOKEN",
    "title": "SMS example via API",
    "sms": 1,
    "broadcast": 1,
    "messages": {
      "9": {
        "sms": {
          "from": "xtremepush",
          "text": "{{first_name}}, check out our SMS API test"
        }
      }
    }
  }'
```

Seu SMS resultante acima seria algo parecido com este:

![750](https://cdn.document360.io/b056e88b-f6c1-4bd2-b5b8-08e9336a17c9/Images/Documentation/481e12f-sms_example_message(1).png?sv=2026-02-06&spr=https&st=2026-11-04T08%3A56%3A59Z&se=2026-11-04T09%3A56%3A59Z&sr=c&sp=r&sig=8dNpGepRawBvJ3vHQkNsJsJjXhtAKTbSOAmrL7irrWQ%3D)