Template SMS

Sfogliare i template nella dashboard

• Name: il nome visualizzato del template e il suo slug (ad esempio bird_order_confirmation). Lo slug è l'identificativo che passi nell'invio; è fisso dalla creazione.
• Status: i template integrati sono Active e pronti per l'invio. I template dello spazio di lavoro sono Draft fino alla pubblicazione, poi diventano Active. Considera il campo di stato condiviso come un insieme aperto.
• Category: la classificazione del contenuto (transactional, marketing o authentication) applicata ai messaggi inviati dal template.
• Language: le lingue in cui il template è disponibile, come tag BCP 47. Le prime vengono mostrate come chip con un overflow +N quando un template è localizzato in molte lingue.
• Scope: System per i template integrati di Bird. Workspace identifica i template che crei tramite l'anteprima API.
• Updated: data dell'ultima modifica del template. I template integrati non mostrano alcuna data.

Contenuto di un template

Elencare i template dalla 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_..."

Creazione di template nello spazio di lavoro in anteprima API

1. Crea il template con POST /v1/sms/templates e {"slug":"order-shipped","category":"transactional"}. La risposta 201 contiene id e draft_version_id; il template inizia con una bozza vuota in inglese. Salva entrambi gli ID per le chiamate successive.
2. Salva il testo con PUT /v1/sms/templates/{id}/versions/{draft_version_id}/languages/en e {"text":"Your order {{ order_number }} has shipped."}. La risposta 200 include draft_revision.
3. Pubblica con POST /v1/sms/templates/{id}/versions/{draft_version_id}/submit, passando quella revisione come {"expected_revision":1} (sostituisci 1 con il valore restituito). Una risposta 200 con valid: true identifica la versione pubblicata. Una risposta 422 segnala contenuto in bozza non valido; correggi i problemi di lingua restituiti e invia di nuovo con una nuova chiave di idempotenza.

Invio con un 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" }
    }
  }'

Passaggi successivi

• Invio di SMS: aggiungi il campo template al payload di invio.
• Log SMS: trova un messaggio inviato e segui il suo ciclo di vita.
• Eventi: ricevi gli eventi di consegna di ogni messaggio.
• Inviare un SMS con un template: un video che invia uno dei template pre-approvati da un terminale