短信服务

2024-01-23 16:39 更新

短信服务提供了管理短信的一些基础能力，包括创建、发送短信，获取、设置发送短信的默认SIM卡槽ID，获取、设置短信服务中心（SMSC）地址，以及检查当前设备是否具备短信发送和接收能力等。

说明

本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块


import sms from '@ohos.telephony.sms';

sms.createMessage

createMessage(pdu: Array<number>, specification: string, callback: AsyncCallback<ShortMessage>): void

根据协议数据单元（PDU）和指定的短信协议创建短信实例。使用callback异步回调。

系统能力：SystemCapability.Telephony.SmsMms

参数：

参数名	类型	必填	说明
pdu	Array<number>	是	协议数据单元，从收到的信息中获取。
specification	string	是	短信协议类型。 - 3gpp：表示GSM/UMTS/LTE SMS - 3gpp2：表示CDMA SMS
callback	AsyncCallback<ShortMessage>	是	回调函数。

参数名

类型

必填

说明

pdu

Array<number>

是

协议数据单元，从收到的信息中获取。

specification

string

是

短信协议类型。

- 3gpp：表示GSM/UMTS/LTE SMS

- 3gpp2：表示CDMA SMS

callback

AsyncCallback<ShortMessage>

是

回调函数。

示例：


const specification = '3gpp';
// 以数组的形式显示协议数据单元（PDU），类型为number，例如[0x08, 0x91, ...]
const pdu = [0x08, 0x91];
sms.createMessage(pdu, specification, (err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

sms.createMessage

createMessage(pdu: Array<number>, specification: string): Promise<ShortMessage>

根据协议数据单元（PDU）和指定的短信协议创建短信实例。使用Promise异步回调。

系统能力：SystemCapability.Telephony.SmsMms

参数：

参数名	类型	必填	说明
pdu	Array<number>	是	协议数据单元，从收到的信息中获取。
specification	string	是	短信协议类型。 - 3gpp：表示GSM/UMTS/LTE SMS - 3gpp2：表示CDMA SMS

参数名

类型

必填

说明

pdu

Array<number>

是

协议数据单元，从收到的信息中获取。

specification

string

是

短信协议类型。

- 3gpp：表示GSM/UMTS/LTE SMS

- 3gpp2：表示CDMA SMS

返回值：

类型	说明
Promise<ShortMessage>	以Promise形式返回创建的短信实例。

示例：


const specification = '3gpp';
// 以数组的形式显示协议数据单元（PDU），类型为number，例如[0x08, 0x91, ...]
const pdu = [0x08, 0x91];
let promise = sms.createMessage(pdu, specification);
promise.then(data => {
    console.log(`createMessage success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`createMessage failed, promise: err->${JSON.stringify(err)}`);
});

sms.sendMessage

sendMessage(options: SendMessageOptions): void

发送短信。

需要权限：ohos.permission.SEND_MESSAGES

系统能力：SystemCapability.Telephony.SmsMms

参数：

参数名	类型	必填	说明
options	SendMessageOptions	是	发送短信的参数和回调，参考SendMessageOptions。

错误码：

以下错误码的详细介绍请参见ohos.telephony(电话子系统)错误码错误码。

错误码ID	错误信息
201	Permission denied.
401	Parameter error.
8300001	Invalid parameter value.
8300002	Operation failed. Cannot connect to service.
8300003	System internal error.
8300999	Unknown error code.

示例：


let sendCallback = function (err, data) {    
    console.log(`sendCallback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); 
}
let deliveryCallback = function (err, data) {    
    console.log(`deliveryCallback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); 
}
let slotId = 0;
let content = '短信内容';
let destinationHost = '+861xxxxxxxxxx';
let serviceCenter = '+861xxxxxxxxxx';
let destinationPort = 1000;
let options = {slotId, content, destinationHost, serviceCenter, destinationPort, sendCallback, deliveryCallback};
sms.sendMessage(options);

sms.getDefaultSmsSlotId7+

getDefaultSmsSlotId(callback: AsyncCallback<number>): void

获取发送短信的默认SIM卡槽ID。使用callback异步回调。

系统能力：SystemCapability.Telephony.SmsMms

参数：

参数名	类型	必填	说明
callback	AsyncCallback<number>	是	回调函数。 - 0：卡槽1 - 1：卡槽2

参数名

类型

必填

说明

callback

AsyncCallback<number>

是

回调函数。

- 0：卡槽1

- 1：卡槽2

示例：


sms.getDefaultSmsSlotId((err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

sms.getDefaultSmsSlotId7+

getDefaultSmsSlotId(): Promise<number>

获取发送短信的默认SIM卡槽ID。使用Promise异步回调。

系统能力：SystemCapability.Telephony.SmsMms

返回值：

类型	说明
Promise<number>	以Promise形式返回发送短信的默认SIM卡： - 0：卡槽1 - 1：卡槽2

类型

说明

Promise<number>

以Promise形式返回发送短信的默认SIM卡：

- 0：卡槽1

- 1：卡槽2

示例：


let promise = sms.getDefaultSmsSlotId();
promise.then(data => {
    console.log(`getDefaultSmsSlotId success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`getDefaultSmsSlotId failed, promise: err->${JSON.stringify(err)}`);
});

sms.hasSmsCapability7+

hasSmsCapability(): boolean

检查当前设备是否具备短信发送和接收能力，该方法是同步方法。

系统能力：SystemCapability.Telephony.SmsMms

返回值：

类型	说明
boolean	- true：设备具备短信发送和接收能力。 - false：设备不具备短信发送和接收能力。

类型

说明

boolean

- true：设备具备短信发送和接收能力。

- false：设备不具备短信发送和接收能力。


let result = sms.hasSmsCapability(); 
console.log(`hasSmsCapability: ${JSON.stringify(result)}`);