SMS templates

Browsing templates in the dashboard

• Name: the template's display name and its slug (for example bird_order_confirmation). The slug is the handle you pass when sending; it's fixed at creation.
• Status: built-in templates are Active and ready to send. Workspace templates are Draft until published, then Active. Treat the shared status field as an open set.
• Category: the content classification (transactional, marketing, or authentication) applied to messages sent from the template.
• Language: the languages the template is stocked in, as BCP 47 tags. The first few are shown as chips with a +N overflow when a template is localized into many languages.
• Scope: System for Bird's built-in templates. Workspace identifies templates you author through the API preview.
• Updated: when the template last changed. Built-in templates show no date.

What's in a template

Listing templates from the 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_..."

Workspace authoring in API preview

1. Create the template with POST /v1/sms/templates and {"slug":"order-shipped","category":"transactional"}. The 201 response contains id and draft_version_id; the template starts with a blank English draft. Save both IDs for the next calls.
2. Save text with PUT /v1/sms/templates/{id}/versions/{draft_version_id}/languages/en and {"text":"Your order {{ order_number }} has shipped."}. The 200 response includes draft_revision.
3. Publish with POST /v1/sms/templates/{id}/versions/{draft_version_id}/submit, passing that revision as {"expected_revision":1} (replace 1 with the returned value). A 200 response with valid: true identifies the published version. A 422 reports invalid draft content; fix the returned language problems and submit again with a new idempotency key.

Sending with a 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" }
    }
  }'

Next steps

• Sending SMS: add the template field to a send payload.
• SMS log: find a sent message and follow its lifecycle.
• Events: receive each message's delivery events.
• Sending an SMS with a template: a video that sends one of the pre-approved templates from a terminal