How to Install RoyceTalk SMS on Your ERPNext Site

Installing RoyceTalk SMS takes about ten minutes if you already have bench access to your ERPNext site. This walks through the whole process, from getting a RoyceTalk API key to sending your first test message.

Before you start

You’ll need:

• Bench/server access to your ERPNext site (or someone on your team who has it), running Frappe/ERPNext v16
• System Manager access inside ERPNext itself
• A RoyceTalk account, with an API key from roycetalk.com/dashboard/api-keys — and a Sender ID already approved on that account, since messages won’t send with an unapproved one

RoyceTalk SMS requires ERPNext to already be installed — it isn’t a standalone Frappe app, since its campaign and broadcast tools read directly from ERPNext’s Customer, Lead, Employee, and Supplier records.

Step 1: Install the app

From your bench:

bench get-app https://github.com/royceltd/en_royce_talk --branch version-16
bench install-app royce_talk

Then restart your bench (bench restart, or however your hosting handles that) so the new app is picked up.

(We’re also in the process of listing RoyceTalk SMS on the Frappe Cloud Marketplace for one-click installs on RoyceERP Cloud — if you’re on Cloud and don’t see it there yet, the bench method above works today regardless.)

Step 2: Get your RoyceTalk API key

Log in at roycetalk.com/dashboard/api-keys and copy your API key — it looks like XXXX_XXXXXXXXXXXXXXXXXXXXXXXX_. Note your Sender ID from the same dashboard while you’re there.

Step 3: Configure RoyceTalk Settings

In ERPNext, search RoyceTalk Settings in the top search bar (or find it under the Royce Talk workspace on your Desk home page).

1. Paste in your API Key and Default Sender ID.
2. Leave the API Base URL as https://roycetalk.com unless RoyceTalk support tells you otherwise.
3. Save the form — a Callback URL appears automatically once you do. Copy that into your RoyceTalk dashboard so delivery status flows back into ERPNext.

Step 4: Send a test message

Still on RoyceTalk Settings, enter a Test Phone Number — your own is the easiest choice — and click Send Test SMS. You should get a text within a few seconds. Kenyan numbers work in local (07…), national (254…), or international (+254…) format interchangeably, so you don’t need to reformat anything.

If it doesn’t arrive, the error shown on screen is almost always the actual reason — an unapproved Sender ID and a mistyped API key are the two most common causes.

Step 5: Turn on what you need

With the basics working, two things are worth setting up before you rely on this day to day:

• A low balance alert threshold, so your System Managers get emailed before your RoyceTalk balance runs out, not after sends start failing.
• Notify Customer buttons, already live on Sales Invoice and Sales Order once the app is installed — nothing further to configure.

Everything else — running your first marketing campaign, setting up an operational broadcast to staff — is covered in the full user guide.

Read what RoyceTalk SMS actually does → · Need help with your install? →