Szablony SMS

Przeglądanie szablonów w dashboardzie

• Name: nazwa wyświetlana szablonu i jego slug (na przykład bird_order_confirmation). Slug to identyfikator, który przekazujesz przy wysyłce; jest ustalany przy tworzeniu.
• Status: szablony wbudowane mają status Active i są gotowe do wysyłki. Szablony obszaru roboczego mają status Draft do momentu publikacji, potem Active. Traktuj wspólne pole statusu jako zbiór otwarty.
• Category: klasyfikacja treści (transactional, marketing lub authentication) stosowana do wiadomości wysyłanych z danego szablonu.
• Language: języki, w których szablon jest dostępny, jako tagi BCP 47. Pierwsze kilka wyświetla się jako chipy z przepełnieniem +N, gdy szablon jest zlokalizowany na wiele języków.
• Scope: System dla szablonów wbudowanych Bird. Workspace oznacza szablony tworzone przez Ciebie w wersji API preview.
• Updated: data ostatniej zmiany szablonu. Wbudowane szablony nie pokazują daty.

Co zawiera szablon

Pobieranie listy szablonów z 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_..."

Tworzenie szablonów w obszarze roboczym w wersji API preview

1. Utwórz szablon za pomocą POST /v1/sms/templates i {"slug":"order-shipped","category":"transactional"}. Odpowiedź 201 zawiera id i draft_version_id; szablon zaczyna od pustej wersji roboczej w języku angielskim. Zapisz oba ID do kolejnych wywołań.
2. Zapisz tekst za pomocą PUT /v1/sms/templates/{id}/versions/{draft_version_id}/languages/en i {"text":"Your order {{ order_number }} has shipped."}. Odpowiedź 200 zawiera draft_revision.
3. Opublikuj za pomocą POST /v1/sms/templates/{id}/versions/{draft_version_id}/submit, przekazując tę rewizję jako {"expected_revision":1} (zastąp 1 zwróconą wartością). Odpowiedź 200 z valid: true identyfikuje opublikowaną wersję. 422 zgłasza nieprawidłową treść wersji roboczej; popraw zwrócone problemy językowe i wyślij ponownie z nowym kluczem idempotentności.

Wysyłka z szablonem

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" }
    }
  }'

Następne kroki

• Wysyłanie SMS: dodaj pole template do ładunku wysyłki.
• Dziennik SMS: znajdź wysłaną wiadomość i śledź jej cykl życia.
• Zdarzenia: odbieraj zdarzenia dostarczenia każdej wiadomości.
• Wysyłanie SMS z szablonem: film pokazujący wysyłkę jednego z zatwierdzonych szablonów z terminala