TypeScript / Node.js
Envía un correo electrónico desde un script Node.js simple con @messagebird/sdk. Necesitas una clave Bird API: crea una en Developers > API keys (Envía tu primer correo electrónico te guía en el proceso) y luego expórtala como BIRD_API_KEY.
1. Instalar
Ejemplo de código
npm init -y
npm install @messagebird/sdk tsxEl SDK requiere Node.js 20.3+ y es exclusivamente ESM.
2. Enviar
Crea send.ts:
Ejemplo de código
import { BirdClient } from "@messagebird/sdk";
const bird = new BirdClient({ apiKey: process.env.BIRD_API_KEY! });
const msg = await bird.email.send({
from: { email: "onboarding@messagebird.dev", name: "Bird" },
to: ["delivered@messagebird.dev"],
subject: "Hello from Bird",
html: "<p>My first Bird email.</p>",
});
console.log(msg.id, msg.status);onboarding@messagebird.dev es el remitente compartido de incorporación de Bird y delivered@messagebird.dev es un destinatario de sandbox que siempre entrega: no necesitas verificación de dominio. El SDK infiere la región a partir del prefijo bk_us1_ / bk_eu1_ de tu clave (no hay URL base que configurar) y genera automáticamente un Idempotency-Key por llamada, así que los envíos reintentados son seguros.
3. Ejecútalo
Ejemplo de código
npx tsx send.tsEl script imprime el ID del mensaje y el estado:
Ejemplo de código
em_01ky7ma8y2es1s2akzk53tmjn0 acceptedaccepted es el 202 del API: Bird tiene el mensaje y lo entrega de forma asíncrona. Consúltalo por su ID em_ con bird.email.get(msg.id) y observa cómo el estado cambia a delivered.
Próximos pasos
- TypeScript email SDK: la superficie completa de email (send, get, list) y el modelo de errores.
- Envía tu primer email: cómo crear una clave API y el conjunto completo de direcciones de sandbox.
- Dominios de envío: verifica tu propio dominio para envío en producción.
- Referencia de email API: el esquema completo de solicitud y respuesta.
Recursos relacionados
Continúa con la documentación, guías y ejemplos sobre este tema. Los recursos están en inglés.
Ver la guíaGetting started with emailComprender el conceptoShould I use a Bird SDK or call the API directly?Explorar la funcionalidadEmailSeguir la ruta de aprendizajeBuild your first integration
Prueba el ejercicio y obtén un resumen de implementación