Plugin for sending short messages using the device's SMS app.

For Capacitor v3

npm i @byteowls/capacitor-sms
npx cap sync

For Capacitor v2 use 2.0.0

npm i @byteowls/[email protected]
npx cap sync

I would like to especially thank some people and companies for supporting my work on this plugin and therefore improving it for everybody.

Starting with version 3.0.0, the plugin is registered automatically on all platforms.

This plugin always uses the default sms app.

import {Component, OnInit} from '@angular/core';
import {SmsManager} from "@byteowls/capacitor-sms";
import {Device, DeviceInfo} from "@capacitor/device";


@Component({
    template: "<button mat-raised-button color='primary' (click)='sendSms()'>Send SMS now!</button>"
})
export class SmsExampleComponent implements OnInit {

    iosOrAndroid: boolean;

    async ngOnInit() {
        const info: DeviceInfo = await Device.getInfo();
        this.iosOrAndroid = (info.platform === "android" || info.platform === "ios");
    }

    sendSms() {
        const numbers: string[] = ["+43 123 123123123", "+43 4564 56456456"];
        SmsManager.send({
            numbers: numbers,
            text: "This is a example SMS",
        }).then(() => {
            // success
        }).catch(error => {
            console.error(error);
        });
    }
}

• SEND_CANCELLED ... User cancelled or closed the SMS app. (ios only)
• ERR_SEND_FAILED ... The SMS app returned that sending the message to the recipients failed. (ios only)
• ERR_SEND_UNKNOWN_STATE ... The SMS app returned a unknown state. There is nothing I can do to clarify the error. (ios only)
• ERR_PLATFORM_NOT_SUPPORTED ... Sending SMS on the web is not supported.
• ERR_NO_NUMBERS ... No recipient numbers were retrieved from options. Make sure to deliver only valid numbers, because the whole sending will fail.
• ERR_NO_TEXT ... No message text was retrieved from options.
• ERR_SERVICE_NOTFOUND ... The used device can not send SMS.

Prerequisite: Capacitor Android Docs

On Android the plugin is registered automatically by Capacitor.

On iOS the plugin is registered automatically by Capacitor.

• Not supported.

• Not supported.

See Contribution Guidelines.

See CHANGELOG.

MIT. Please see LICENSE.

This plugin is powered by BYTEOWLS Software & Consulting.

If you need extended support for this project like critical changes or releases ahead of schedule. Feel free to contact us for a consulting offer.

We have no business relation to Ionic.