For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt, and this page is available as Markdown at /apps-plugin/docs/js-api/device/sms/sendSms.md.

sendSms

拉起系统短信发送面板。

扫码预览

扫码预览 sendSms

使用限制

WARNING

Android、iOS:Android 通过 Intent 打开短信应用即成功,iOS 通过 MFMessageComposeViewController 呈现并在用户完成/取消后回调,成功时机不同;相同调用在双端"成功"代表的实际状态不同。

支持版本

前端库版本不低于 0.0.25。

支持平台

平台支持情况
Android支持
iOS支持
PC不支持
HarmonyOS不支持

支持场景

场景支持情况
页面支持
卡片支持

使用说明

  • 该接口仅拉起系统短信面板,是否实际发送由用户在系统界面确认

调用方式

异步 API

sendSms(params?: SendSmsParams): Promise<object>

入参

名称类型必填默认值约束说明
messagestring否--预填到发送短信面板的内容。
phoneNumberstring否--预填到发送短信面板的手机号。

调用示例

import { sendSms } from '@doubao-dev/framework/api';

await sendSms({
  phoneNumber: '10086',
  message: '查询话费'
});

成功返回

无返回字段。

返回示例

{}

错误处理

错误对象和通用错误码见 通用错误处理。

失败示例

{
  "errNo": 114,
  "errMsg": "operation cancelled"
}

错误码

errNoerrMsg平台触发条件处理建议
103feature not supportiOS当前设备不支持发送短信在支持短信的设备上调用,或提前提示用户设备不支持短信。
114operation cancellediOS用户在系统短信面板中取消了发送用户需要时可再次调用 `sendSms` 重新拉起短信面板。

通用错误码

errNoerrMsg说明平台
102internal error内部错误Android、iOS

平台差异

  • iOS:拉起短信面板后用户取消返回 114、发送失败返回 102、设备不支持短信返回 103;Android 无法拉起短信应用时返回 102。