SMS-templates

Templates bekijken in het dashboard

• Name: de weergavenaam van het template en zijn slug (bijvoorbeeld bird_order_confirmation). De slug is de handle die je meegeeft bij het versturen; deze staat vast vanaf het aanmaken.
• Status: ingebouwde templates zijn Active en klaar om te versturen. Werkruimte-templates zijn Draft totdat ze worden gepubliceerd en dan Active. Beschouw het gedeelde statusveld als een open set.
• Category: de inhoudsclassificatie (transactional, marketing of authentication) die wordt toegepast op berichten die vanuit het template worden verstuurd.
• Language: de talen waarin het template beschikbaar is, als BCP 47-tags. De eerste paar worden als chips getoond met een +N-overflow wanneer een template in veel talen is gelokaliseerd.
• Scope: System voor de ingebouwde templates van Bird. Workspace identificeert templates die je maakt via de API-preview.
• Updated: wanneer het template voor het laatst is gewijzigd. Ingebouwde templates tonen geen datum.

Wat zit er in een template

Templates opvragen via de 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_..."

Werkruimte-templates maken in API-preview

1. Maak het template aan met POST /v1/sms/templates en {"slug":"order-shipped","category":"transactional"}. Het 201-antwoord bevat id en draft_version_id; het template begint met een leeg Engels concept. Sla beide ID's op voor de volgende aanroepen.
2. Sla tekst op met PUT /v1/sms/templates/{id}/versions/{draft_version_id}/languages/en en {"text":"Your order {{ order_number }} has shipped."}. Het 200-antwoord bevat draft_revision.
3. Publiceer met POST /v1/sms/templates/{id}/versions/{draft_version_id}/submit en geef die revisie mee als {"expected_revision":1} (vervang 1 door de geretourneerde waarde). Een 200-antwoord met valid: true identificeert de gepubliceerde versie. Een 422 meldt ongeldige conceptinhoud; los de geretourneerde taalproblemen op en dien opnieuw in met een nieuwe idempotentiesleutel.

Verzenden met een 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" }
    }
  }'

Volgende stappen

• SMS versturen: voeg het template-veld toe aan een verzendpayload.
• SMS-log: zoek een verstuurd bericht en volg de levenscyclus.
• Events: ontvang de bezorggebeurtenissen van elk bericht.
• Een SMS verzenden met een template: een video die een van de vooraf goedgekeurde templates verstuurt vanuit een terminal