Plantillas de SMS

Explorar plantillas en el dashboard

• Name: el nombre para mostrar de la plantilla y su slug (por ejemplo bird_order_confirmation). El slug es el identificador que pasas al enviar; se fija en la creación.
• Status: las plantillas integradas están en Active y listas para enviar. Las plantillas de espacio de trabajo están en Draft hasta que se publican, luego pasan a Active. Trata el campo de estado compartido como un conjunto abierto.
• Category: la clasificación de contenido (transactional, marketing o authentication) aplicada a los mensajes enviados desde la plantilla.
• Language: los idiomas en los que la plantilla está disponible, como etiquetas BCP 47. Los primeros se muestran como chips con un indicador de desbordamiento +N cuando una plantilla está localizada en muchos idiomas.
• Scope: System para las plantillas integradas de Bird. Workspace identifica las plantillas que creas a través del API preview.
• Updated: cuándo cambió la plantilla por última vez. Las plantillas integradas no muestran fecha.

Qué contiene una plantilla

Listar plantillas desde la 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_..."

Creación de plantillas de espacio de trabajo en API preview

1. Crea la plantilla con POST /v1/sms/templates y {"slug":"order-shipped","category":"transactional"}. La respuesta 201 contiene id y draft_version_id; la plantilla comienza con un borrador en inglés vacío. Guarda ambos ID para las siguientes llamadas.
2. Guarda el texto con PUT /v1/sms/templates/{id}/versions/{draft_version_id}/languages/en y {"text":"Your order {{ order_number }} has shipped."}. La respuesta 200 incluye draft_revision.
3. Publica con POST /v1/sms/templates/{id}/versions/{draft_version_id}/submit, pasando esa revisión como {"expected_revision":1} (reemplaza 1 con el valor devuelto). Una respuesta 200 con valid: true identifica la versión publicada. Un 422 indica contenido de borrador no válido; corrige los problemas de idioma devueltos y envía de nuevo con una nueva clave de idempotencia.

Envío con una plantilla

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

Próximos pasos

• Envío de SMS: añade el campo template a un payload de envío.
• Log de SMS: encuentra un mensaje enviado y sigue su ciclo de vida.
• Events: recibe los eventos de entrega de cada mensaje.
• Envía un SMS con una plantilla: un video que envía una de las plantillas preaprobadas desde una terminal