@ohos.telephony.sms (SMS) (System API)

The sms module provides basic SMS management functions. You can create and send SMS messages, and obtain and set the default SIM card for sending and receiving SMS messages. Besides, you can obtain and set the SMSC address, and check whether the current device can send and receive SMS messages.

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. This topic describes only system APIs provided by the module. For details about its public APIs, see @ohos.telephony.sms (SMS).

Modules to Import

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

sms.sendMms¹¹⁺

sendMms(context: Context, mmsParams: MmsParams, callback: AsyncCallback<void>): void

Sends an MMS message. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.SEND_MESSAGES

System capability: SystemCapability.Telephony.SmsMms

Parameters

Error codes

For details about the error codes, see Telephony Error Codes.

Example

FA model:

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';
import common from '@ohos.app.ability.common';

// Obtain the context.
import featureAbility from '@ohos.ability.featureAbility';
let context: common.BaseContext = featureAbility.getContext();

// Configure the path for storing PDUs of MMS messages. Such PDUs are sent from the encoding API.
const sandBoxPath: string = '/data/storage/el2/base/files/';
let filePath: string  = sandBoxPath + 'SendReq.mms';

// Options for sending MMS messages (The MMSC is for reference only.)
let mmsPars: sms.MmsParams = {
  slotId : 0,
  mmsc: 'http://mmsc.myuni.com.cn',
  data: filePath,
  mmsConfig: {
   userAgent:'ua',
   userAgentProfile: 'uaprof'
  }
};

// Call the sendMms API.
sms.sendMms(context, mmsPars, async(err: BusinessError) =>{
  if (err) {
      console.error(`sendMms fail, err : ${JSON.stringify(err)}`);
      return;
  }
  console.log(`sendMms Success`);
})

Stage model:

import UIAbility from '@ohos.app.ability.UIAbility';
import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';
import window from '@ohos.window';

// Configure the path for storing PDUs of MMS messages. Such PDUs are sent from the encoding API.
const sandBoxPath = '/data/storage/el2/base/files/';
let filePath  = sandBoxPath + 'SendReq.mms';

// Configure the MMS user agent and profile. The default values are ua and uaprof, respectively. The configuration is subject to the carrier's requirements. 
let mmsConf: sms.MmsConfig = {
  userAgent:'ua',
  userAgentProfile: 'uaprof'
};

// Options for sending MMS messages (The MMSC is for reference only.)
let mmsPars: sms.MmsParams = {
  slotId : 0,
  mmsc: 'http://mmsc.myuni.com.cn',
  data: filePath,
  mmsConfig: mmsConf
};

class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage: window.WindowStage) {
    sms.sendMms(this.context, mmsPars, async(err: BusinessError) =>{
        if (err) {
            console.error(`sendMms fail, err : ${JSON.stringify(err)}`);
            return;
        }
        console.log(`sendMms Success`);
        })
    }
}

sms.sendMms¹¹⁺

sendMms(context: Context, mmsParams: MmsParams): Promise<void>

Sends an MMS message. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.SEND_MESSAGES

System capability: SystemCapability.Telephony.SmsMms

Parameters

Return value

Error codes

For details about the error codes, see Telephony Error Codes.

Example

FA model:

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';
import common from '@ohos.app.ability.common';
// Obtain the context.
import featureAbility from '@ohos.ability.featureAbility';
let context: common.BaseContext = featureAbility.getContext();

// Configure the path for storing PDUs of MMS messages. Such PDUs are sent from the encoding API.
const sandBoxPath: string = '/data/storage/el2/base/files/';
let filePath: string = sandBoxPath + 'SendReq.mms';

// Options for sending MMS messages (The MMSC is for reference only.)
let mmsPars: sms.MmsParams = {
  slotId: 0,
  mmsc: 'http://mmsc.myuni.com.cn',
  data: filePath,
  mmsConfig: {
   userAgent:'ua',
   userAgentProfile: 'uaprof'
  }
};

// Call the sendMms API.
let promise = sms.sendMms(context, mmsPars);
promise.then(() => {
    console.log(`sendMms success`);
}).catch((err: BusinessError) => {
    console.error(`sendMms failed, promise: err->${JSON.stringify(err)}`);
});

Stage model:

import UIAbility from '@ohos.app.ability.UIAbility';
import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';
import window from '@ohos.window';

// Configure the path for storing PDUs of MMS messages. Such PDUs are sent from the encoding API.
const sandBoxPath = '/data/storage/el2/base/files/';
let filePath  = sandBoxPath + 'SendReq.mms';

// Configure the MMS user agent and profile. The default values are ua and uaprof, respectively. The configuration is subject to the carrier's requirements. 
let mmsConf: sms.MmsConfig = {
  userAgent:'ua',
  userAgentProfile: 'uaprof'
};

// Options for sending MMS messages (The MMSC is for reference only.)
let mmsPars: sms.MmsParams = {
  slotId : 0,
  mmsc: 'http://mmsc.myuni.com.cn',
  data: filePath,
  mmsConfig: mmsConf
};

class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage: window.WindowStage) {
    let promise = sms.sendMms(this.context, mmsPars);
    promise.then(() => {
        console.log(`sendMms success`);
    }).catch((err: BusinessError) => {
        console.error(`sendMms failed, promise: err->${JSON.stringify(err)}`);
    });
    }
}

sms.downloadMms¹¹⁺

downloadMms(context: Context, mmsParams: MmsParams, callback: AsyncCallback<void>): void

Downloads an MMS message. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.RECEIVE_MMS

System capability: SystemCapability.Telephony.SmsMms

Parameters

Error codes

For details about the error codes, see Telephony Error Codes.

Example

FA model:

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';
import common from '@ohos.app.ability.common';
// Obtain the context.
import featureAbility from '@ohos.ability.featureAbility';
let context: common.BaseContext = featureAbility.getContext();

// Configure the path for storing the PDU of the MMS message.
const sandBoxPath: string = '/data/storage/el2/base/files/';
let filePath: string = sandBoxPath + 'RetrieveConf.mms';

// Parse the MMS URL from the WAP Push message.
let wapPushUrl: string = 'URL';

// Configure the parameters (including the callback) for downloading MMS messages.
let mmsPars: sms.MmsParams = {
  slotId: 0,
  mmsc: wapPushUrl,
  data: filePath,
  mmsConfig: {
   userAgent:'ua',
   userAgentProfile: 'uaprof'
  }
};

// Call the downloadMms API.
sms.downloadMms(context, mmsPars, async(err: BusinessError) =>{
  if (err) {
      console.error(`downloadMms fail, err : ${JSON.stringify(err)}`);
      return;
  }
  console.log(`downloadMms Success`);
})

Stage model:

import UIAbility from '@ohos.app.ability.UIAbility';
import mms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';
import window from '@ohos.window';

// Configure the path for storing the PDU of the MMS message.
const sandBoxPath = '/data/storage/el2/base/files/';
let filePath  = sandBoxPath + 'RetrieveConf.mms';

// Parse the MMS URL from the WAP Push message.
let wapPushUrl  = 'URL';

// Configure the MMS user agent and profile. The default values are ua and uaprof, respectively. The configuration is subject to the carrier's requirements. 
let mmsConf: mms.MmsConfig = {
  userAgent:'ua',
  userAgentProfile: 'uaprof'
};

// Configure the parameters (including the callback) for downloading MMS messages.
let mmsPars: mms.MmsParams = {
  slotId : 0,
  mmsc: wapPushUrl,
  data: filePath,
  mmsConfig: mmsConf
};

class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage: window.WindowStage) {
    mms.downloadMms(this.context, mmsPars, async(err: BusinessError) =>{
        if (err) {
            console.error(`downloadMms fail, err : ${JSON.stringify(err)}`);
            return;
        }
        console.log(`downloadMms Success`);
        });
    }
}

sms.downloadMms¹¹⁺

downloadMms(context: Context, mmsParams: MmsParams): Promise<void>

Sends an MMS message. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.RECEIVE_MMS

System capability: SystemCapability.Telephony.SmsMms

Parameters

Return value

Error codes

For details about the error codes, see Telephony Error Codes.

Example

FA model:

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';
import common from '@ohos.app.ability.common';
// Obtain the context.
import featureAbility from '@ohos.ability.featureAbility';
let context: common.BaseContext = featureAbility.getContext();

// Configure the path for storing the PDU of the MMS message.
const sandBoxPath: string = '/data/storage/el2/base/files/';
let filePath: string = sandBoxPath + 'RetrieveConf.mms';

// Parse the MMS URL from the WAP Push message.
let wapPushUrl: string = 'URL';

// Configure the parameters (including the callback) for downloading MMS messages.
let mmsPars: sms.MmsParams = {
  slotId: 0,
  mmsc: wapPushUrl,
  data: filePath,
  mmsConfig: {
   userAgent:'ua',
   userAgentProfile: 'uaprof'
  }
};

// Call the sendMms API.
let promise = sms.downloadMms(context, mmsPars);
promise.then(() => {
    console.log(`downloadMms success`);
}).catch((err: BusinessError) => {
    console.error(`downloadMms failed, promise: err->${JSON.stringify(err)}`);
});

Stage model:

import UIAbility from '@ohos.app.ability.UIAbility';
import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';
import window from '@ohos.window';

// Configure the path for storing the PDU of the MMS message.
const sandBoxPath = '/data/storage/el2/base/files/';
let filePath  = sandBoxPath + 'RetrieveConf.mms';

// Parse the MMS URL from the WAP Push message.
let wapPushUrl  = 'URL';

// Configure the MMS user agent and profile. The default values are ua and uaprof, respectively. The configuration is subject to the carrier's requirements. 
let mmsConf: sms.MmsConfig = {
  userAgent:'ua',
  userAgentProfile: 'uaprof'
};

// Configure the parameters (including the callback) for downloading MMS messages.
let mmsPars: sms.MmsParams = {
  slotId : 0,
  mmsc: wapPushUrl,
  data: filePath,
  mmsConfig: mmsConf
};

class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage: window.WindowStage) {
    let promise = sms.downloadMms(this.context, mmsPars);
    promise.then(() => {
        console.log(`downloadMms success`);
    }).catch((err: BusinessError) => {
        console.error(`downloadMms failed, promise: err->${JSON.stringify(err)}`);
    });
    }
}

sms.setDefaultSmsSlotId⁷⁺

setDefaultSmsSlotId(slotId: number, callback: AsyncCallback<void>): void

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

System API: This is a system API.

Required permissions: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.SmsMms

Parameters

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

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

sms.setDefaultSmsSlotId⁷⁺

setDefaultSmsSlotId(slotId: number): Promise<void>

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

System API: This is a system API.

Required permissions: ohos.permission.SET_TELEPHONY_STATE

System capability: SystemCapability.Telephony.SmsMms

Parameters

Return value

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

sms.setDefaultSmsSlotId(0).then(() => {
    console.log(`setDefaultSmsSlotId success.`);
}).catch((err: BusinessError) => {
    console.error(`setDefaultSmsSlotId failed, 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.

System API: This is a system API.

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

System capability: SystemCapability.Telephony.SmsMms

Parameters

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

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

sms.setSmscAddr⁷⁺

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

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

System API: This is a system API.

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

System capability: SystemCapability.Telephony.SmsMms

Parameters

Return value

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

let slotId: number = 0;
let smscAddr: string = '+861xxxxxxxxxx';
sms.setSmscAddr(slotId, smscAddr).then(() => {
    console.log(`setSmscAddr success.`);
}).catch((err: BusinessError) => {
    console.error(`setSmscAddr failed, 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.

System API: This is a system API.

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

System capability: SystemCapability.Telephony.SmsMms

Parameters

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

let slotId: number = 0;
sms.getSmscAddr(slotId, (err: BusinessError, data: string) => {
      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.

System API: This is a system API.

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

System capability: SystemCapability.Telephony.SmsMms

Parameters

Return value

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

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

sms.splitMessage⁸⁺

splitMessage(content: string, callback: AsyncCallback<Array<string>>): void

Splits an SMS message into multiple segments. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.SEND_MESSAGES

System capability: SystemCapability.Telephony.SmsMms

Parameters

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

let content: string = "long message";
sms.splitMessage(content, (err: BusinessError, data: string[]) => {
      console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

sms.splitMessage⁸⁺

splitMessage(content: string): Promise<Array<string>>

Splits an SMS message into multiple segments. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.SEND_MESSAGES

System capability: SystemCapability.Telephony.SmsMms

Parameters

Return value

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

let content: string = "long message";
let promise = sms.splitMessage(content);
promise.then((data: string[]) => {
    console.log(`splitMessage success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`splitMessage failed, promise: err->${JSON.stringify(err)}`);
});

sms.addSimMessage⁷⁺

addSimMessage(options: SimMessageOptions, callback: AsyncCallback<void>): void

Adds a message to the SIM card. If the SIM card is full, an error is reported. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.RECEIVE_SMS and ohos.permission.SEND_MESSAGES

System capability: SystemCapability.Telephony.SmsMms

Parameters

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

let simMessageOptions: sms.SimMessageOptions = {
    slotId: 0,
    smsc: "test",
    pdu: "xxxxxx",
    status: sms.SimMessageStatus.SIM_MESSAGE_STATUS_READ
};
sms.addSimMessage(simMessageOptions, (err: BusinessError) => {
      console.log(`callback: err->${JSON.stringify(err)}`);
});

sms.addSimMessage⁷⁺

addSimMessage(options: SimMessageOptions): Promise<void>

Adds a message to the SIM card. If the SIM card is full, an error is reported. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.RECEIVE_SMS and ohos.permission.SEND_MESSAGES

System capability: SystemCapability.Telephony.SmsMms

Parameters

Return value

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

let simMessageOptions: sms.SimMessageOptions = {
    slotId: 0,
    smsc: "test",
    pdu: "xxxxxx",
    status: sms.SimMessageStatus.SIM_MESSAGE_STATUS_READ
};
sms.addSimMessage(simMessageOptions).then(() => {
    console.log(`addSimMessage success.`);
}).catch((err: BusinessError) => {
    console.error(`addSimMessage failed, promise: err->${JSON.stringify(err)}`);
});

sms.delSimMessage⁷⁺

delSimMessage(slotId: number, msgIndex: number, callback: AsyncCallback<void>): void

Deletes a message from the SIM card. If the specified msgIndex is invalid, an error is reported. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.RECEIVE_SMS and ohos.permission.SEND_MESSAGES

System capability: SystemCapability.Telephony.SmsMms

Parameters

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

let slotId: number = 0;
let msgIndex: number = 1;
sms.delSimMessage(slotId, msgIndex, (err: BusinessError) => {
      console.log(`callback: err->${JSON.stringify(err)}`);
});

sms.delSimMessage⁷⁺

delSimMessage(slotId: number, msgIndex: number): Promise<void>

Deletes a message from the SIM card. If the specified msgIndex is invalid, an error is reported. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.RECEIVE_SMS and ohos.permission.SEND_MESSAGES

System capability: SystemCapability.Telephony.SmsMms

Parameters

Return value

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

let slotId: number = 0;
let msgIndex: number = 1;
let promise = sms.delSimMessage(slotId, msgIndex);
promise.then(() => {
    console.log(`delSimMessage success.`);
}).catch((err: BusinessError) => {
    console.error(`delSimMessage failed, promise: err->${JSON.stringify(err)}`);
});

sms.updateSimMessage⁷⁺

updateSimMessage(options: UpdateSimMessageOptions, callback: AsyncCallback<void>): void

Updates a SIM message. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.RECEIVE_SMS and ohos.permission.SEND_MESSAGES

System capability: SystemCapability.Telephony.SmsMms

Parameters

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

let updateSimMessageOptions: sms.UpdateSimMessageOptions = {
    slotId: 0,
    msgIndex: 1,
    newStatus: sms.SimMessageStatus.SIM_MESSAGE_STATUS_FREE,
    pdu: "xxxxxxx",
    smsc: "test"
};
sms.updateSimMessage(updateSimMessageOptions, (err: BusinessError) => {
      console.log(`callback: err->${JSON.stringify(err)}`);
});

sms.updateSimMessage⁷⁺

updateSimMessage(options: UpdateSimMessageOptions): Promise<void>

Updates a SIM message. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.RECEIVE_SMS and ohos.permission.SEND_MESSAGES

System capability: SystemCapability.Telephony.SmsMms

Parameters

Return value

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

let updateSimMessageOptions: sms.UpdateSimMessageOptions = {
    slotId: 0,
    msgIndex: 1,
    newStatus: sms.SimMessageStatus.SIM_MESSAGE_STATUS_FREE,
    pdu: "xxxxxxx",
    smsc: "test"
};
let promise = sms.updateSimMessage(updateSimMessageOptions);
promise.then(() => {
    console.log(`updateSimMessage success.`);
}).catch((err: BusinessError) => {
    console.error(`updateSimMessage failed, promise: err->${JSON.stringify(err)}`);
});

sms.getAllSimMessages⁷⁺

getAllSimMessages(slotId: number, callback: AsyncCallback<Array<SimShortMessage>>): void

Obtains all SIM card messages. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.RECEIVE_SMS

System capability: SystemCapability.Telephony.SmsMms

Parameters

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

let slotId: number = 0;
sms.getAllSimMessages(slotId, (err: BusinessError, data: sms.SimShortMessage[]) => {
      console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

sms.getAllSimMessages⁷⁺

getAllSimMessages(slotId: number): Promise<Array<SimShortMessage>>

Obtains all SIM card messages. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.RECEIVE_SMS

System capability: SystemCapability.Telephony.SmsMms

Parameters

Return value

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

let slotId: number = 0;
let promise = sms.getAllSimMessages(slotId);
promise.then((data: sms.SimShortMessage[]) => {
    console.log(`getAllSimMessages success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`getAllSimMessages failed, promise: err->${JSON.stringify(err)}`);
});

sms.setCBConfig⁷⁺

setCBConfig(options: CBConfigOptions, callback: AsyncCallback<void>): void

Sets the cell broadcast configuration. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.RECEIVE_SMS

System capability: SystemCapability.Telephony.SmsMms

Parameters

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

let cbConfigOptions: sms.CBConfigOptions = {
    slotId: 0,
    enable: true,
    startMessageId: 100,
    endMessageId: 200,
    ranType: sms.RanType.TYPE_GSM
};
sms.setCBConfig(cbConfigOptions, (err: BusinessError) => {
      console.log(`callback: err->${JSON.stringify(err)}`);
});

sms.setCBConfig⁷⁺

setCBConfig(options: CBConfigOptions): Promise<void>

Sets the cell broadcast configuration. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.RECEIVE_SMS

System capability: SystemCapability.Telephony.SmsMms

Parameters

Return value

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

let cbConfigOptions: sms.CBConfigOptions = {
    slotId: 0,
    enable: true,
    startMessageId: 100,
    endMessageId: 200,
    ranType: sms.RanType.TYPE_GSM
};
let promise = sms.setCBConfig(cbConfigOptions);
promise.then(() => {
    console.log(`setCBConfig success.`);
}).catch((err: BusinessError) => {
    console.error(`setCBConfig failed, promise: err->${JSON.stringify(err)}`);
});

sms.getSmsSegmentsInfo⁸⁺

getSmsSegmentsInfo(slotId: number, message: string, force7bit: boolean, callback: AsyncCallback<SmsSegmentsInfo>): void

Obtains SMS message segment information. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

Parameters

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

let slotId: number = 0;
sms.getSmsSegmentsInfo(slotId, "message", false, (err: BusinessError, data: sms.SmsSegmentsInfo) => {
      console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

sms.getSmsSegmentsInfo⁸⁺

getSmsSegmentsInfo(slotId: number, message: string, force7bit: boolean): Promise<SmsSegmentsInfo>

Obtains SMS message segment information. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

Parameters

Return value

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

let slotId: number = 0;
let promise = sms.getSmsSegmentsInfo(slotId, "message", false);
promise.then((data: sms.SmsSegmentsInfo) => {
    console.log(`getSmsSegmentsInfo success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`getSmsSegmentsInfo failed, promise: err->${JSON.stringify(err)}`);
});

sms.isImsSmsSupported⁸⁺

isImsSmsSupported(slotId: number, callback: AsyncCallback<boolean>): void

Checks whether SMS is supported on IMS. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

Parameters

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

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

sms.isImsSmsSupported⁸⁺

isImsSmsSupported(slotId: number): Promise<boolean>

Checks whether SMS is supported on IMS. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

Parameters

Return value

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

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

sms.getImsShortMessageFormat⁸⁺

getImsShortMessageFormat(callback: AsyncCallback<string>): void

Obtains the SMS format supported by the IMS, for example, 3gpp, 3gpp2, or unknown. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

Parameters

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

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

sms.getImsShortMessageFormat⁸⁺

getImsShortMessageFormat(): Promise<string>

Obtains the SMS format supported by the IMS, for example, 3gpp, 3gpp2, or unknown. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

Return value

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

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

sms.decodeMms⁸⁺

decodeMms(mmsFilePathName: string | Array<number>, callback: AsyncCallback<MmsInformation>): void

Decodes MMS messages. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

Parameters

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

let mmsFilePathName: string = "filename";
sms.decodeMms(mmsFilePathName, (err: BusinessError, data: sms.MmsInformation) => {
      console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

const mmsPdu: Array<number> = [0x8c, 0x80, 0x98, 0x31, 0x00, 0x8d, 0x92, 0x89, 0x09, 0x80, 0x07, 0xea, 0x31, 0x30, 0x30, 0x38, 0x36, 0x00, 0x97, 0x07, 0xea, 0x31, 0x30, 0x30,0x31, 0x30, 0x00, 0x84, 0x74, 0x79, 0x70, 0x65, 0x00, 0x00];
sms.decodeMms(mmsPdu, (err: BusinessError, data: sms.MmsInformation) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

sms.decodeMms⁸⁺

decodeMms(mmsFilePathName: string | Array<number>): Promise<MmsInformation>

Decodes MMS messages. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

Parameters

Return value

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

let mmsFilePathName: string = "filename";
let promise = sms.decodeMms(mmsFilePathName);
promise.then((data: sms.MmsInformation) => {
    console.log(`decodeMms success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`decodeMms failed, promise: err->${JSON.stringify(err)}`);
});

const mmsPdu: Array<number> = [0x8c, 0x80, 0x98, 0x31, 0x00, 0x8d, 0x92, 0x89, 0x09, 0x80, 0x07, 0xea, 0x31, 0x30, 0x30, 0x38, 0x36, 0x00, 0x97, 0x07, 0xea, 0x31, 0x30, 0x30,0x31, 0x30, 0x00, 0x84, 0x74, 0x79, 0x70, 0x65, 0x00, 0x00];
let promiseArr = sms.decodeMms(mmsPdu);
promiseArr.then((data: sms.MmsInformation) => {
    console.log(`decodeMms success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`decodeMms failed, promise: err->${JSON.stringify(err)}`);
});

sms.encodeMms⁸⁺

encodeMms(mms: MmsInformation, callback: AsyncCallback<Array<number>>): void

MMS message code. This API uses an asynchronous callback to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

Parameters

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

let mmsAcknowledgeInd: sms.MmsAcknowledgeInd = {
    transactionId: "100",
    version: sms.MmsVersionType.MMS_VERSION_1_0,
    reportAllowed: sms.ReportType.MMS_YES
};
let mmsInformation: sms.MmsInformation = {
    messageType: sms.MessageType.TYPE_MMS_ACKNOWLEDGE_IND,
    mmsType: mmsAcknowledgeInd
};
sms.encodeMms(mmsInformation, (err: BusinessError, data: number[]) => {
      console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});

sms.encodeMms⁸⁺

encodeMms(mms: MmsInformation): Promise<Array<number>>

MMS message code. This API uses a promise to return the result.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

Parameters

Return value

Error codes

For details about the error codes, see Telephony Error Codes.

Example

import sms from '@ohos.telephony.sms';
import { BusinessError } from '@ohos.base';

let mmsAcknowledgeInd: sms.MmsAcknowledgeInd = {
    transactionId: "100",
    version: sms.MmsVersionType.MMS_VERSION_1_0,
    reportAllowed: sms.ReportType.MMS_YES
};
let mmsInformation: sms.MmsInformation = {
    messageType: sms.MessageType.TYPE_MMS_ACKNOWLEDGE_IND,
    mmsType: mmsAcknowledgeInd
};
sms.encodeMms(mmsInformation).then((data: number[]) => {
    console.log(`encodeMms success, promise: data->${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
    console.error(`encodeMms failed, promise: err->${JSON.stringify(err)}`);
});

MmsParams¹¹⁺

Defines the parameters for sending SMS messages.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

MmsConfig¹¹⁺

MMS configuration file.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

MmsInformation⁸⁺

Defines the MMS message information.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

MmsSendReq⁸⁺

Defines an MMS message sending request.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

MmsSendConf⁸⁺

Defines the MMS message sending configuration.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

MmsNotificationInd⁸⁺

Defines an MMS notification index.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

MmsAcknowledgeInd⁸⁺

Defines an MMS confirmation index.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

MmsRetrieveConf⁸⁺

Defines the MMS message retrieval configuration.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

MmsReadOrigInd⁸⁺

Defines the original MMS message reading index.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

MmsReadRecInd⁸⁺

Defines the MMS message reading index.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

MmsAttachment⁸⁺

Defines the attachment of an MMS message.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

MmsAddress⁸⁺

Defines an MMSC address.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

MessageType⁸⁺

Message type.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

MmsPriorityType⁸⁺

Enumerates MMS message priorities.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

MmsVersionType⁸⁺

Enumerates MMS versions.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

MmsCharSets⁸⁺

Enumerates MMS character sets.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

DispositionType⁸⁺

Enumerates disposition types.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

ReportType⁸⁺

Enumerates report types.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

CBConfigOptions⁷⁺

Defines the cell broadcast configuration options.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

SimMessageStatus⁷⁺

Defines the SIM message status.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

RanType⁷⁺

RAN type.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

SmsEncodingScheme⁸⁺

Enumerates SMS encoding schemes.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

SimMessageOptions⁷⁺

Defines the SIM message options.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

UpdateSimMessageOptions⁷⁺

Defines the updating SIM message options.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

SimShortMessage⁷⁺

Defines a SIM message.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

MmsDeliveryInd⁸⁺

Defines an MMS message delivery index.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

MmsRespInd⁸⁺

Defines an MMS response index.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms

SmsSegmentsInfo⁸⁺

Defines the SMS message segment information.

System API: This is a system API.

System capability: SystemCapability.Telephony.SmsMms