SMS टेम्प्लेट

डैशबोर्ड में टेम्प्लेट ब्राउज़ करना

• Name: टेम्प्लेट का डिस्प्ले नाम और उसका slug (उदाहरण के लिए bird_order_confirmation)। slug वह हैंडल है जो आप भेजते समय पास करते हैं; यह बनाते समय तय हो जाता है।
• Status: बिल्ट-इन टेम्प्लेट Active होते हैं और भेजने के लिए तैयार होते हैं। वर्कस्पेस टेम्प्लेट प्रकाशित होने तक Draft रहते हैं, फिर Active हो जाते हैं। साझा स्टेटस फ़ील्ड को एक ओपन सेट मानें।
• Category: टेम्प्लेट से भेजे गए संदेशों पर लागू सामग्री वर्गीकरण (transactional, marketing, या authentication)।
• Language: टेम्प्लेट में उपलब्ध भाषाएँ, BCP 47 टैग के रूप में। जब कोई टेम्प्लेट कई भाषाओं में स्थानीयकृत होता है, तो पहली कुछ चिप्स के रूप में दिखती हैं और शेष +N ओवरफ़्लो में।
• Scope: Bird के बिल्ट-इन टेम्प्लेट के लिए System। Workspace उन टेम्प्लेट की पहचान करता है जिन्हें आप API प्रीव्यू के ज़रिए बनाते हैं।
• Updated: टेम्प्लेट में आखिरी बदलाव कब हुआ। बिल्ट-इन टेम्प्लेट कोई तारीख़ नहीं दिखाते।

टेम्प्लेट में क्या होता है

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_..."

API प्रीव्यू में वर्कस्पेस ऑथरिंग

1. POST /v1/sms/templates और {"slug":"order-shipped","category":"transactional"} के साथ टेम्प्लेट बनाएँ। 201 रिस्पॉन्स में id और draft_version_id होते हैं; टेम्प्लेट एक खाली अंग्रेज़ी ड्राफ़्ट से शुरू होता है। अगली कॉल के लिए दोनों ID सहेज लें।
2. PUT /v1/sms/templates/{id}/versions/{draft_version_id}/languages/en और {"text":"Your order {{ order_number }} has shipped."} के साथ टेक्स्ट सहेजें। 200 रिस्पॉन्स में draft_revision शामिल होता है।
3. POST /v1/sms/templates/{id}/versions/{draft_version_id}/submit से प्रकाशित करें, उस रिवीज़न को {"expected_revision":1} के रूप में पास करें (1 को लौटाए गए मान से बदलें)। valid: true के साथ 200 रिस्पॉन्स प्रकाशित वर्शन की पहचान करता है। 422 अमान्य ड्राफ़्ट सामग्री की सूचना देता है; लौटाई गई भाषा समस्याओं को ठीक करें और नई idempotency key के साथ दोबारा सबमिट करें।

टेम्प्लेट से भेजना

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

अगले कदम

• SMS भेजना: सेंड पेलोड में template फ़ील्ड जोड़ें।
• SMS लॉग: भेजा गया संदेश खोजें और उसके जीवनचक्र को फ़ॉलो करें।
• इवेंट्स: हर संदेश के डिलीवरी इवेंट प्राप्त करें।
• टेम्पलेट के साथ SMS भेजना: एक वीडियो जो टर्मिनल से पूर्व-स्वीकृत टेम्प्लेट में से एक भेजता है