Sign inGet Started
立即开始
指南
API 参考
SDK
CLI
知识库
更新日志

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
响应202
{
  "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.

参数

esim_idstring

eSIM ID.

请求载荷

to
string
必填

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

channel
string
必填

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.

响应载荷

id
string
必填
channel
string
必填
to
string
必填

Recipient address the message goes to.

status
string
必填
failure_code
nullable string
必填

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
必填

When the delivery was accepted.

settled_at
nullable string
必填

When the outcome became known. Null while pending.

install_link
nullable object
必填

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

显示子属性
install_link.id
string
必填
install_link.expires_at
string
必填

When the installation link expires.

install_link.revoked_at
nullable string
必填

When the link was revoked, or null while not revoked.

相关资源

继续查看此主题的文档、指南和示例。

获取实施简报