harmony 鸿蒙SMS Service Development

  • 2023-06-24
  • 浏览 (672)

SMS Service Development

When to Use

The Short Messaging Service (SMS) module provides basic SMS management functions. You can create and send SMS messages, and obtain the ID of the default SIM card used to send and receive SMS messages. Besides, you can obtain and set the SMSC address, and check whether the current device can send and receive SMS messages.

Typical development scenarios are as follows:

  • On web pages:
    • The Send Message button is displayed when users open a web page. After the user taps the button, the SMS application is started, and the user can then enter the recipient number and SMS message content to send an SMS message.
  • On applications:
    • When a user taps the Send Message button on a mobile application, the application calls the system function to start the SMS application, and the user can then enter the recipient number and SMS message content to send an SMS message.

Basic Concepts

  • SMS

A service capable of SMS message storage and forwarding. It enables mobile phones to send and receive SMS messages. The content of the SMS message can be text, digits, or binary non-text data. The information about the sender is stored in the Short Message Service Center (SMSC) and forwarded to the recipient. - SMSC

An entity that relays, stores, or forwards SMS messages between base stations and mobile devices. It uses the GSM 03.40 protocol for sending SMS messages to or receiving SMS messages from mobile phones. - PDU

Protocol data unit, which uses the following encoding schemes to send and receive SMS messages: 7-bit, 8-bit, and UCS-2. 7-bit encoding is used to send common ASCII characters, 8-bit encoding to send data messages, and UCS-2 encoding to send Unicode characters.

Constraints

  1. The SMS service is available only on standard-system devices.
  2. An available SIM card must be present on the device, and the permission to send SMS messages must be granted.

Available APIs

NOTE To maximize the application running efficiency, most APIs are called asynchronously in callback or promise mode. The following code examples use the callback mode. For details about the APIs, see the API Reference.

Name Description
sendShortMessage(options: SendMessageOptions, callback: AsyncCallback<void>): void Sends text or data SMS messages. You need to request for the ohos.permission.SEND_MESSAGES permission, which is available only for system applications.
createMessage(pdu: Array<number>, specification: string, callback: AsyncCallback<ShortMessage>): void Creates an SMS message instance based on the PDU and the specified SMS protocol.
getDefaultSmsSlotId(callback: AsyncCallback<number>): void Obtains the ID of the default SIM card used to send SMS messages.
setSmscAddr(slotId: number, smscAddr: string, callback: AsyncCallback<void>): void Sets the SMSC address based on the specified slot ID.
getSmscAddr(slotId: number, callback: AsyncCallback<string>): void Obtains the SMSC address based on the specified slot ID.

Sending SMS Messages (for System Applications Only)

  1. Declare the required permission:

    • To send SMS messages, call the sendShortMessage API and declare the ohos.permission.SEND_MESSAGES permission. The permission is of the system_basic level.
    • To set the SMSC address, call the** setSmscAddr** API and declare the ohos.permission.SET_TELEPHONY_STATE permission. The permission is of the system_basic level.
    • To obtain the SMSC address, call the** getSmscAddr** API and declare the ohos.permission.GET_TELEPHONY_STATE permission. The permission is of the system_basic level. Before requesting the permission, ensure that the basic principles for using permissions are met. Then, declare the required permission by referring to Requesting Application Permissions.
  2. Import the required modules.

  3. Send an SMS message.

// Sample code
import { sms } from '@kit.TelephonyKit';
import { AsyncCallback, BusinessError } from '@kit.BasicServicesKit';

let sendCallback: AsyncCallback<sms.ISendShortMessageCallback> = (err: BusinessError, data: sms.ISendShortMessageCallback) => {
    console.log(`sendCallback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); 
}
let deliveryCallback: AsyncCallback<sms.IDeliveryShortMessageCallback> = (err: BusinessError, data: sms.IDeliveryShortMessageCallback) => {
    console.log(`deliveryCallback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); 
}
let slotId: number = 0;
let content: string = 'Message content';
let destinationHost: string = '+861xxxxxxxxxx';
let serviceCenter: string = '+861xxxxxxxxxx';
let destinationPort: number = 1000;
let options: sms.SendMessageOptions = {slotId, content, destinationHost, serviceCenter, destinationPort, sendCallback, deliveryCallback};
sms.sendShortMessage(options, (err: BusinessError) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
});

Redirecting to the SMS Message Editing Page of the Application

The API for sending SMS messages can be called only after the required system permission is granted. For a third-party application, it also needs to implement the function of redirecting to the SMS editing page and obtaining the edited content and recipient number by calling the startAbility API.

// Sample code
import { common, Want } from '@kit.AbilityKit';

const MMS_BUNDLE_NAME = "com.ohos.mms";
const MMS_ABILITY_NAME = "com.ohos.mms.MainAbility";
const MMS_ENTITIES = "entity.system.home";

export class Contact {
    contactsName: string;
    telephone: number;

    constructor(contactsName: string, telephone: number) {
        this.contactsName = contactsName;
        this.telephone = telephone;
    }
}

@Entry
@Component
struct JumpMessage {
    private context = this.getUIContext().getHostContext() as common.UIAbilityContext;

    startMMSAbilityExplicit() {
        // Complete the contact and number. You can query the contact name based on the phone number. Therefore, the phone number is mainly used in this mode.
        let params: Array<Object> = [new Contact("Tom", 133XXXXXXXX)];

        let want: Want = {
            bundleName: "com.ohos.mms",
            abilityName: "com.ohos.mms.MainAbility",
            parameters: {
                contactObjects: JSON.stringify(params),
                pageFlag: "conversation",
                // Enter the SMS message content.
                content: "SMS message content"
            }
        };

        this.context.startAbilityForResult(want).then((data) => {
            console.log("Success" + JSON.stringify(data));
        }).catch(() => {
            console.log("error");
        });
    }

    build() {
        Row() {
            Column() {
                Button ('Send SMS')
                  .onClick(() => {
                      this.startMMSAbilityExplicit();
                  })
            }
            .width('100%')
        }
        .height('100%')
    }
}

Redirecting to the SMS Message Editing Page in SMS Mode

Scenario

Through the SMS protocol, you can create a hyperlink pointing to the SMS recipient so that users can directly navigate to the SMS application through the hyperlink on a web page or an application. In addition, you can define the SMS message recipient and content in the sms: field to save the SMS message editing time.

SMS Protocol Format

The standard SMS protocol format is as follows:

sms:106XXXXXXXXXX?body=SMS message content
  • sms:: SMS scheme, which is mandatory.
  • 106XXXXXXXXXX: recipient number, which is optional. If there are multiple addresses, separate them with commas (,).
  • ?: start declaration character of the SMS message content. This parameter is mandatory if the SMS message content is present.
  • body-value: SMS message content, which is optional.

Developing a Caller Application

On Web Pages

Hyperlinks on web pages must comply with the SMS protocol. The sample code is as follows:

<a href="sms:106XXXXXXXXXX?body=%E5%8F%91%E9%80%81%E7%9F%AD%E4%BF%A1%E5%86%85%E5%AE%B9">Send Message</a>;

In actual development, replace the recipient number with the actual number. The SMS message content can be configured as required.

On Applications

Pass the sms string to the uri parameter. In the application, the context can be obtained through this.getUIContext().getHostContext() for a page and through this.context for an ability.

@Entry
@Component
struct Index {

  build() {
    Column() {
      Button ('Send SMS')
        .onClick(() => {
          let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
          let exampleUrl = "sms:106XXXXXXXXXX?body=%E5%8F%91%E9%80%81%E7%9F%AD%E4%BF%A1%E5%86%85%E5%AE%B9";
        
          let want: Want = {
              bundleName: 'com.ohos.mms',
              action: 'ohos.want.action.viewData',
              uri:exampleUrl,
            }
        
          context.startAbility(want).then((data) => {
              console.log("Success" + JSON.stringify(data));
          }).catch(() => {
              console.log("error");
          });

        })
    }
  }
}

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Telephony Kit

harmony 鸿蒙Call Service Development

harmony 鸿蒙Introduction to Telephony Kit

0  赞