Skip to Content
1MSG
ReferenceCampaigns API

Pré-visualizar uma campanha

GET
/api/v1/campaigns/{campaignId}/preview

Conta os destinatários e quantos estão fora da janela de 24 horas. tierDailyLimit é o limite do canal. Não retorna preço nem custo. Nada é enviado.

Authorization

bearer
headerAuthorizationBearer <API key>

Chave gerada em Settings → Developer → API key. Os métodos do Inbox precisam do escopo Inbox. Os métodos de Campaigns precisam do escopo Campaigns.

Path Parameters

campaignId*string

id da campanha retornado na criação ou na lista.

Response Body

application/json
  1. response
campaignId*string

id da campanha.

segmentId*string

id do segmento usado como público.

contentMode*string

Se a campanha envia um template ou texto da sessão.

Value in"template""text"
recipientCount*number

Membros do segmento.

closedWindowCount*number

Membros fora da janela de 24 horas.

tierDailyLimit*|

Quantos envios de template este canal pode iniciar em 24 horas corridas. Vem do limite do canal, não de um campo que você define. null quando o limite é desconhecido ou ilimitado.

exceedsTierDailyLimit*boolean

true quando um envio de template passaria do limite do canal.

warnings*array<>

Avisos desta pré-visualização. Nada é enviado.

Example Request
curl -X GET 'https://api.1msg.io/api/v1/campaigns/string/preview'
Example Response200
{  "campaignId": "cm3campaign01",  "segmentId": "cm3segment01",  "contentMode": "template",  "recipientCount": 12,  "closedWindowCount": 3,  "tierDailyLimit": 1000,  "exceedsTierDailyLimit": false,  "warnings": [    {      "code": "closed_window_skipped",      "message": "Closed-window recipients will be skipped."    }  ]}