SMS-Templates

Templates im Dashboard durchsuchen

• Name: der Anzeigename des Templates und sein slug (zum Beispiel bird_order_confirmation). Der Slug ist die Kennung, die Sie beim Senden übergeben; er wird bei der Erstellung festgelegt.
• Status: Integrierte Templates sind Active und versandbereit. Workspace-Templates sind Draft, bis sie veröffentlicht werden, dann Active. Behandeln Sie das gemeinsame Statusfeld als offene Menge.
• Category: Die Inhaltsklassifikation (transactional, marketing oder authentication), die auf über das Template versendete Nachrichten angewendet wird.
• Language: die Sprachen, in denen das Template vorliegt, als BCP-47-Tags. Die ersten werden als Chips angezeigt, mit einem +N-Überlauf, wenn ein Template in viele Sprachen lokalisiert ist.
• Scope: System für die integrierten Templates von Bird. Workspace kennzeichnet Templates, die Sie über die API-Vorschau erstellen.
• Updated: wann das Template zuletzt geändert wurde. Integrierte Templates zeigen kein Datum.

Was ein Template enthält

Templates über die API auflisten

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-Erstellung in der API-Vorschau

1. Erstellen Sie das Template mit POST /v1/sms/templates und {"slug":"order-shipped","category":"transactional"}. Die 201-Antwort enthält id und draft_version_id; das Template beginnt mit einem leeren englischen Draft. Speichern Sie beide IDs für die nächsten Aufrufe.
2. Speichern Sie Text mit PUT /v1/sms/templates/{id}/versions/{draft_version_id}/languages/en und {"text":"Your order {{ order_number }} has shipped."}. Die 200-Antwort enthält draft_revision.
3. Veröffentlichen Sie mit POST /v1/sms/templates/{id}/versions/{draft_version_id}/submit und übergeben Sie die Revision als {"expected_revision":1} (ersetzen Sie 1 durch den zurückgegebenen Wert). Eine 200-Antwort mit valid: true identifiziert die veröffentlichte Version. Ein 422 meldet ungültigen Draft-Inhalt; beheben Sie die zurückgegebenen Sprachprobleme und senden Sie die Anfrage erneut mit einem neuen Idempotenzschlüssel.

Versand mit einem 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" }
    }
  }'

Nächste Schritte

• SMS senden: Fügen Sie das Feld template zu einem Versand-Payload hinzu.
• SMS-Log: Finden Sie eine gesendete Nachricht und verfolgen Sie ihren Lebenszyklus.
• Events: Empfangen Sie die Zustellereignisse jeder Nachricht.
• Eine SMS mit einem Template senden: Ein Video, das eines der vorab genehmigten Templates von einem Terminal aus versendet