Skip to main content
GET
Consultar campanha de WhatsApp ou SMS

Autorizações

Authorization
string
header
obrigatório

API key criada nas configurações da organização.

Parâmetros de caminho

template_campaign_id
string
obrigatório

ID público da campanha de WhatsApp ou SMS.

Pattern: ^tcp_[A-Za-z0-9_-]+$

Resposta

Campanha de WhatsApp ou SMS encontrada.

object
string
obrigatório
Allowed value: "template_campaign"
id
string
obrigatório
Pattern: ^tcp_[A-Za-z0-9_-]+$
status
string
obrigatório
channel
enum<string>
obrigatório
Opções disponíveis:
whatsapp,
sms
is_official
boolean
obrigatório
scheduling_type
string
obrigatório
recipient_type
string
obrigatório
created_at
string<date-time>
obrigatório
updated_at
string<date-time>
obrigatório
name
string
scheduled_for
string<date-time>
sent_at
string<date-time>
templates
object[]
metrics
object
html_url
string<uri>