Sign inGet Started
Comenzar
Guías
Referencia de API
SDKs
CLI
Base de conocimientos
Registro de cambios

Send install credentials to the traveler

POST
/v1/esim/sims/{esim_id}/credentials/deliver
bird esim credentials deliver <esim-id> \
  --channel sms \
  --locale nl \
  --to +31612345678
Respuesta202
{
  "id": "edv_01krdgeqcxet5s7t44vh8rt9mg",
  "channel": "email",
  "to": "traveler@example.com",
  "status": "pending",
  "failure_code": "invalid_recipient",
  "install_link": {
    "id": "eil_01krdgeqcxet5s7t44vh8rt9mg"
  }
}

Sends a hosted installation link by email or SMS. The eSIM must be installable. Email includes the link expiry time; SMS includes the link. The recipient opens the page to view the QR code and manual installation details. Links expire after seven days; resending leaves earlier links valid until expiry or explicit revocation.

A 202 response confirms acceptance for sending. Check List credential deliveries for the delivery outcome and any failure code. Reuse the same Idempotency-Key to recover an accepted send while its response is retained.

Returns 409 with E26012 when the selected channel is unavailable; choose another configured channel. New deliveries return 501 while hosted links are unavailable. A retained successful response can still be replayed during that time.

Parámetros

esim_idstring

eSIM ID.

Cuerpo de la solicitud

to
string
obligatorio

Recipient address. An email address for the email channel, an E.164 phone number for the sms channel.

channel
string
obligatorio

Channel the install credentials are delivered over.

Possible values: email, sms

locale
string

Language for the message. Falls back to the closest available language, then English.

Carga de respuesta

id
string
obligatorio
channel
string
obligatorio
to
string
obligatorio

Recipient address the message goes to.

status
string
obligatorio
failure_code
nullable string
obligatorio

Why the delivery failed. Null unless status is failed. Open enum: treat unrecognized values as future failure kinds.

Possible values (may grow over time): invalid_recipient, suppressed, blocked, bounced, channel_unavailable, send_failed

created_at
string
obligatorio

When the delivery was accepted.

settled_at
nullable string
obligatorio

When the outcome became known. Null while pending.

install_link
nullable object
obligatorio

Link metadata for explicit revocation. Null for deliveries created before hosted links were enabled.

Mostrar atributos secundarios

Recursos relacionados

Continúa con la documentación, guías y ejemplos de este tema.

Obtener un resumen de implementación