Templates SMS

Navegando pelos templates no dashboard

• Name: o nome de exibição do template e seu slug (por exemplo bird_order_confirmation). O slug é o identificador que você passa ao enviar; ele é fixado na criação.
• Status: templates integrados estão Active e prontos para envio. Templates de espaço de trabalho ficam em Draft até serem publicados, depois Active. Trate o campo de status compartilhado como um conjunto aberto.
• Category: a classificação de conteúdo (transactional, marketing ou authentication) aplicada às mensagens enviadas a partir do template.
• Language: os idiomas em que o template está disponível, como tags BCP 47. Os primeiros são exibidos como chips, com um overflow +N quando o template é localizado em muitos idiomas.
• Scope: System para templates integrados do Bird. Workspace identifica templates que você cria através do preview API.
• Updated: quando o template foi alterado pela última vez. Templates integrados não exibem data.

O que há em um template

Listando templates a partir da API

for await (const tpl of bird.smsTemplates.list({ scope: "system" })) {
  console.log(tpl.id, tpl.slug);
}

for template in client.sms_templates.list(scope="system"):
    print(template.id, template.slug)

for tpl, err := range client.SmsTemplates.List(context.Background(), bird.SMSTemplateListParams{
	Scope: "system",
}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(tpl.Id, *tpl.Slug)
}

foreach ($bird->smsTemplates->list(['scope' => 'system']) as $template) {
    echo $template->getId(), ' ', $template->getSlug(), "\n";
}

bird sms templates list

curl "https://eu1.platform.bird.com/v1/sms/templates?category=authentication" \
  -H "Authorization: Bearer bk_eu1_..."

Criação no espaço de trabalho em preview API

1. Crie o template com POST /v1/sms/templates e {"slug":"order-shipped","category":"transactional"}. A resposta 201 contém id e draft_version_id; o template começa com um rascunho em inglês em branco. Salve ambos os IDs para as próximas chamadas.
2. Salve o texto com PUT /v1/sms/templates/{id}/versions/{draft_version_id}/languages/en e {"text":"Your order {{ order_number }} has shipped."}. A resposta 200 inclui draft_revision.
3. Publique com POST /v1/sms/templates/{id}/versions/{draft_version_id}/submit, passando essa revisão como {"expected_revision":1} (substitua 1 pelo valor retornado). Uma resposta 200 com valid: true identifica a versão publicada. Uma 422 reporta conteúdo de rascunho inválido; corrija os problemas de idioma retornados e envie novamente com uma nova chave de idempotência.

Enviando com um template

await bird.sms.send({
  to: "+14155550100",
  template: { slug: "bird_otp_verification", parameters: { code: "123456" } },
});

client.sms.send(
    to="+14155550100",
    template="bird_otp_verification",
    parameters={"code": "123456"},
)

msg, err := client.Sms.Send(context.Background(), bird.SmsSendParams{
	To:         "+14155550100",
	Template:   "bird_otp_verification",
	Parameters: map[string]any{"code": "123456"},
})
if err != nil {
	log.Fatal(err)
}
fmt.Println(msg.Id)

$message = $bird->sms->send(
    to: '+14155550100',
    template: 'bird_otp_verification',
    parameters: ['code' => '123456'],
);
echo $message->getId(), ' ', $message->getStatus();

bird sms send \
  --parameters '{"code":"123456"}' \
  --template bird_otp_verification \
  --to +14155550100

curl -X POST "https://eu1.platform.bird.com/v1/sms/messages" \
  -H "Authorization: Bearer bk_eu1_..." \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+14155550100",
    "template": {
      "slug": "bird_otp_verification_ttl",
      "language": "en",
      "parameters": { "code": "481920", "ttl": "10" }
    }
  }'

Próximos passos

• Enviando SMS: adicione o campo template ao payload de envio.
• Log de SMS: encontre uma mensagem enviada e acompanhe seu ciclo de vida.
• Eventos: receba os eventos de entrega de cada mensagem.
• Enviar um SMS com um template: um vídeo que envia um dos templates pré-aprovados a partir de um terminal