Template SMS

Menjelajahi template di dashboard

• Name: nama tampilan template dan slug-nya (misalnya bird_order_confirmation). Slug adalah handle yang Anda kirim saat mengirim pesan; nilainya tetap sejak pembuatan.
• Status: template bawaan berstatus Active dan siap dikirim. Template workspace berstatus Draft hingga dipublikasikan, lalu menjadi Active. Perlakukan field status bersama ini sebagai set terbuka.
• Category: klasifikasi konten (transactional, marketing, atau authentication) yang diterapkan pada pesan yang dikirim dari template.
• Language: bahasa yang tersedia dalam template, sebagai tag BCP 47. Beberapa yang pertama ditampilkan sebagai chip dengan overflow +N jika template dilokalkan ke banyak bahasa.
• Scope: System untuk template bawaan Bird. Workspace mengidentifikasi template yang Anda buat melalui pratinjau API.
• Updated: kapan template terakhir diubah. Template bawaan tidak menampilkan tanggal.

Isi template

Mencantumkan template dari 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_..."

Pembuatan workspace dalam pratinjau API

1. Buat template dengan POST /v1/sms/templates dan {"slug":"order-shipped","category":"transactional"}. Respons 201 berisi id dan draft_version_id; template dimulai dengan draft bahasa Inggris kosong. Simpan kedua ID untuk panggilan berikutnya.
2. Simpan teks dengan PUT /v1/sms/templates/{id}/versions/{draft_version_id}/languages/en dan {"text":"Your order {{ order_number }} has shipped."}. Respons 200 menyertakan draft_revision.
3. Publikasikan dengan POST /v1/sms/templates/{id}/versions/{draft_version_id}/submit, menggunakan revisi tersebut sebagai {"expected_revision":1} (ganti 1 dengan nilai yang dikembalikan). Respons 200 dengan valid: true mengidentifikasi versi yang dipublikasikan. 422 melaporkan konten draft yang tidak valid; perbaiki masalah bahasa yang dikembalikan dan kirim lagi dengan kunci idempotensi baru.

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

Langkah selanjutnya

• Mengirim SMS: tambahkan field template ke payload pengiriman.
• Log SMS: temukan pesan yang telah dikirim dan ikuti siklus hidupnya.
• Events: terima event pengiriman setiap pesan.
• Mengirim SMS dengan template: video yang mengirim salah satu template yang telah disetujui dari terminal