SMS

NOTE

The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

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

sms.createMessage

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

Creates an SMS message instance based on the protocol data unit (PDU) and the specified SMS protocol. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.SmsMms

Parameters

Example

const specification = '3gpp';
// Display PDUs using numbers in an array, for example, [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>

Creates an SMS message instance based on the PDU and the specified SMS protocol. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.SmsMms

Parameters

Return Value

Example

const specification = '3gpp';
// Display PDUs using numbers in an array, for example, [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 fail, promise: err->${JSON.stringify(err)}`);
});

sms.sendMessage

sendMessage(options: SendMessageOptions): void

Sends an SMS message.

Required permission: ohos.permission.SEND_MESSAGES

System capability: SystemCapability.Telephony.SmsMms

Parameters

Example

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 ='SMS message content';
let destinationHost = '+861xxxxxxxxxx';
let serviceCenter = '+861xxxxxxxxxx';
let destinationPort = 1000;
let options = {slotId, content, destinationHost, serviceCenter, destinationPort, sendCallback, deliveryCallback};
sms.sendMessage(options);

sms.getDefaultSmsSlotId⁷⁺

getDefaultSmsSlotId(callback: AsyncCallback<number>): void

Obtains the default slot of the SIM card used to send SMS messages. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Telephony.SmsMms

Parameters

Example

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

sms.getDefaultSmsSlotId⁷⁺

getDefaultSmsSlotId(): Promise<number>

Obtains the default slot of the SIM card used to send SMS messages. This API uses a promise to return the result.

System capability: SystemCapability.Telephony.SmsMms

Return Value

Example

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

sms.setSmscAddr⁷⁺

setSmscAddr(slotId: number, smscAddr: string, callback: AsyncCallback<void>): void

Sets the short message service center (SMSC) address. This API uses an asynchronous callback to return the result.

Required permission: ohos.permission.SET_TELEPHONY_STATE (a system permission)

System capability: SystemCapability.Telephony.SmsMms

This is a system API and cannot be called by third-party applications.

Parameters

Example

let slotId = 0;
let smscAddr = '+861xxxxxxxxxx';
sms.setSmscAddr(slotId, smscAddr, (err,data) => {
      console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

sms.setSmscAddr⁷⁺

setSmscAddr(slotId: number, smscAddr: string): Promise<void>

Sets the SMSC address. This API uses a promise to return the result.

Required permission: ohos.permission.SET_TELEPHONY_STATE (a system permission)

System capability: SystemCapability.Telephony.SmsMms

This is a system API and cannot be called by third-party applications.

Parameters

Return Value

Example

let slotId = 0;
let smscAddr = '+861xxxxxxxxxx';
let promise = sms.setSmscAddr(slotId, smscAddr);
promise.then(data => {
    console.log(`setSmscAddr success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
    console.error(`setSmscAddr fail, promise: err->${JSON.stringify(err)}`);
});

sms.getSmscAddr⁷⁺

getSmscAddr(slotId: number, callback: AsyncCallback<string>): void

Obtains the SMSC address. This API uses an asynchronous callback to return the result.

Required permission: ohos.permission.GET_TELEPHONY_STATE (a system permission)

System capability: SystemCapability.Telephony.SmsMms

This is a system API and cannot be called by third-party applications.

Parameters

Example

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

sms.getSmscAddr⁷⁺

getSmscAddr(slotId: number): Promise<string>

Obtains the SMSC address. This API uses a promise to return the result.

Required permission: ohos.permission.GET_TELEPHONY_STATE (a system permission)

System capability: SystemCapability.Telephony.SmsMms

This is a system API and cannot be called by third-party applications.

Parameters

Return Value

Example

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

sms.hasSmsCapability⁷⁺

hasSmsCapability(): boolean

Checks whether the current device can send and receive SMS messages. This API works in synchronous mode.

System capability: SystemCapability.Telephony.SmsMms

Return Value

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

ShortMessage

Defines an SMS message instance.

System capability: SystemCapability.Telephony.SmsMms

ShortMessageClass

SMS message type.

System capability: SystemCapability.Telephony.SmsMms

SendMessageOptions

Provides the options (including callbacks) for sending an SMS message. For example, you can specify the SMS message type by the optional parameter content.

System capability: SystemCapability.Telephony.SmsMms

ISendShortMessageCallback

Provides the callback for the SMS message sending result. It consists of three parts: SMS message sending result, URI for storing the sent SMS message, and whether the SMS message is the last part of a long SMS message.

System capability: SystemCapability.Telephony.SmsMms

IDeliveryShortMessageCallback

Provides the callback for the SMS message sending result. Return the SMS delivery report.

System capability: SystemCapability.Telephony.SmsMms

SendSmsResult

SMS message sending result.

System capability: SystemCapability.Telephony.SmsMms