短信 sms

接口声明

{ "name": "vivo.sms" }

导入模块

import sms from '@vivo.sms' 或 const sms = require('@vivo.sms')

接口定义

sms.send(OBJECT)

发送短信

参数：

参数名	类型	必填	说明
msgId	Integer	是	短信 id，从 0 开始，每次+1
address	String	是	短信目标号码
content	String	是	短信内容（字数限制不超过 70 字符）
simSlot	Integer	否	sim 卡槽 id
success	Function	否	成功回调
fail	Function	否	失败回调
complete	Function	否	执行结束后的回调

示例：

sms.send({
  msgId: 1,
  address: '130xxxx1234',
  content: '这是短信内容',
  simSlot: 0,
  success: function () {
    console.log(`handling success`)
  },
  fail: function (data, code) {
    console.log(`handling fail, code = ${code}`)
  },
})

sms.onreceive = function(data)

监听接收到新信息的事件

data 返回值：

参数名	类型	说明
msgId	Integer	短信 id
address	String	短信号码
content	String	短信内容

示例：

sms.onreceive = function (data) {
  console.log(`handling receive new sms, id = ${data.msgId}`)
}

sms.delete(OBJECT)

删除指定号码的短信

参数：

参数名	类型	必填	说明
address	String	是	要删除的号码
success	Function	否	成功回调
fail	Function	否	失败回调
complete	Function	否	执行结束后的回调

示例：

sms.delete({
  address: '131xxxx1234',
  success: function () {
    console.log(`handling success`)
  },
  fail: function (data, code) {
    console.log(`handling fail, code = ${code}`)
  },
})

sms.deleteAll(OBJECT)

删除全部短信

参数：

参数名	类型	必填	说明
success	Function	否	成功回调
fail	Function	否	失败回调
complete	Function	否	执行结束后的回调

示例：

sms.deleteAll({
  success: function () {
    console.log(`handling success`)
  },
  fail: function (data, code) {
    console.log(`handling fail, code = ${code}`)
  },
})

sms.deleteOne(OBJECT)

通过 id 删除一条短信

参数：

参数名	类型	必填	说明
msgId	Integer	是	短信 id
success	Function	否	成功回调
fail	Function	否	失败回调
complete	Function	否	执行结束后的回调

示例：

sms.deleteOne({
  msgId: 1,
  success: function () {
    console.log(`handling success`)
  },
  fail: function (data, code) {
    console.log(`handling fail, code = ${code}`)
  },
})

sms.setStatus(OBJECT)

设置短信状态

参数：

参数名	类型	必填	说明
address	String	是	短信号码
msgtype	Integer	是	短信类型，0 为发送中，1 为发送成功，2 为发送失败，3 为已读，4 为未读
success	Function	否	成功回调
fail	Function	否	失败回调
complete	Function	否	执行结束后的回调

示例：

sms.setStatus({
  address: '131xxxx1234',
  msgtype: 3,
  success: function () {
    console.log(`handling success`)
  },
  fail: function (data, code) {
    console.log(`handling fail, code = ${code}`)
  },
})

sms.getAddressList(OBJECT)

获取保存的短信号码列表

参数：

参数名	类型	必填	说明
success	Function	否	成功回调
fail	Function	否	失败回调
complete	Function	否	执行结束后的回调

success 返回值

参数名	类型	说明
addressList	String[]	短信号码列表

示例：

sms.getAddressList({
  success: function () {
    console.log(`handling success`)
  },
  fail: function (data, code) {
    console.log(`handling fail, code = ${code}`)
  },
})

sms.getDisplayInfo(OBJECT)

获取指定号码的短信展示信息

参数：

参数名	类型	必填	说明
address	String	是	短信号码
success	Function	否	成功回调
fail	Function	否	失败回调
complete	Function	否	执行结束后的回调

success 返回值

参数名	类型	说明
err	Integer	发送失败的短信数量
ure	Integer	未读的短信数量
cont	String	最近一条短信内容缩略
name	String	号码的备注名
list	Integer[]	该号码对应的短信 id 列表

示例：

sms.getDisplayInfo({
  success: function (data) {
    console.log(`handling success`)
  },
  fail: function (data, code) {
    console.log(`handling fail, code = ${code}`)
  },
})

sms.getDetailInfo(OBJECT)

获取指定 id 的短信详情

参数：

参数名	类型	必填	说明
msgId	Integer	是	短信 id
success	Function	否	成功回调
fail	Function	否	失败回调
complete	Function	否	执行结束后的回调

success 返回值

参数名	类型	说明
type	Integer	短信类型，0 为发送中，1 为发送成功，2 为发送失败，3 为已读，4 为未读
num	String	短信号码
cont	String	短信内容
time	Number	时间戳毫秒数

示例：

sms.getDetailInfo({
  success: function (data) {
    console.log(`handling success`)
  },
  fail: function (data, code) {
    console.log(`handling fail, code = ${code}`)
  },
})