tt.sendSms
基础库 2.74.0 开始支持本方法,低版本需做兼容处理,这是一个异步方法。
调用该 API 可以调起系统短信发送页面
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 无 |
| 注意事项 | 无 |
| 支持沙盒 | 否 |
| 相关教程 | 无 |
语法
tt.sendSms(options)
参数说明
options 为 object 类型,属性如下:
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| phoneNumber | string | 否 | 预填到发送短信面板的号码 | 2.74.0 | |
| content | string | 否 | 预填到短信发送面板的消息 | 2.74.0 | |
| success | function | 否 | 接口调用成功的回调函数 | 2.74.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 2.74.0 | |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 2.74.0 |
回调成功
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "sendSms:ok" | 2.74.0 |
回调失败
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "sendSms:fail" + 详细错误信息 | 2.74.0 |
错误码
| errorCode | errMsg | errorType | 说明 | 最低支持版本 |
|---|---|---|---|---|
| 147495 | sendSms:fail cancel | U | 用户取消 用户取消,不需要特殊处理 | 2.74.0 |
| 147499 | sendSms:fail params.phoneNumber should xxx | D | 电话号格式不对 电话号格式不对 | 2.74.0 |
扫码体验
请使用字节宿主APP扫码
代码示例
tt.sendSms({ phoneNumber: "123xxxxxxxx", content: "sms content", success: (res) => { console.log("success", res); }, fail: (err) => { console.log("fail", err); }, });
