Skip to Content
1MSG
ReferenceCampaigns API

Enviar um teste

POST
/api/v1/campaigns/{campaignId}/test

Envia o conteúdo do rascunho para um destinatário e não muda o status nem a análise da campanha. Informe exatamente um: phone (E.164) ou bsuid (formato do provedor). Uma recusa do provedor é um erro, não um envio aceito. conversationId é a conversa no Inbox. messageId e providerMessageId são o mesmo id da mensagem no provedor, ou null quando o provedor aceitou o envio sem id.

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.

Request Body

application/json
  1. body
phone?string

Telefone E.164, por exemplo +15551234567. Envie exatamente um: phone ou bsuid. Não muda o status nem a análise da campanha.

bsuid?string

BSUID do provedor, por exemplo ab.abc123xyz. Um @lid no final é aceito. Envie exatamente um: phone ou bsuid.

Response Body

application/json
  1. response
accepted*boolean

Sempre true quando o teste foi aceito.

campaignId*string

id da campanha.

campaignStatus*string

Status da campanha depois do teste. O teste não muda o status.

Value in"draft""sending""pause""completed""failed""scheduled"
excludedFromAnalytics*boolean

Sempre true. Este envio fica fora da análise.

conversationId*|

id da conversa no Inbox, ou null quando o provedor não retornou um.

messageId*|

id da mensagem no provedor, ou null quando o provedor aceitou o envio sem id.

providerMessageId*|

Mesmo valor de messageId.

phone?string

Telefone E.164. Presente quando o teste foi enviado para um telefone. Vem exatamente um: phone ou bsuid.

bsuid?string

BSUID do provedor. Presente quando o teste foi enviado para um BSUID. Vem exatamente um: phone ou bsuid.

Example Request
curl -X POST 'https://api.1msg.io/api/v1/campaigns/string/test' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response200
{  "accepted": true,  "campaignId": "cm3campaign01",  "campaignStatus": "draft",  "excludedFromAnalytics": true,  "conversationId": "cm3dialog01",  "messageId": "wamid.HBgM",  "providerMessageId": "wamid.HBgM",  "phone": "+15551234567",  "bsuid": "ab.abc123xyz"}