The following checklist is mandatory to use Kaleyra SMS API:
Mobile Phone Number Format
All mobile phone numbers should be valid with the country code for global messaging. The country code for domestic messaging (India) may or may not be applied.
Example: +91999999999, 918888888888, +441234567890, +254123456789
All text messages carry a sender ID. When you send a text message through API, you could use any of the approved sender IDs for your account.
In case you have not created a sender ID, you can always create one through our SMS application. Once the Sender ID is approved, you can start sending messages.
Creating a Sender ID
One can create the sender ID using company name, or any relevant name. This sender ID will be shown as SMS sender name to the recipients rather than just a phone number in the sender field.
The alphabetic originator, or sender ID, can contain characters from a-z, A-Z. Other characters may cause message delivery to be failed. Every country has their own restricted variations for defining sender IDs.
To create a new Sender ID, follow these steps below:
Click on the Manage Items left menu and then select the Manage Sender ID. Click on New icon at the top right end to create a new sender ID.
Fill up the unique Sender ID of your choice and give a suitable Description and Save the selection.
Once the Sender ID is approved from our end, we’ll send a notification email to your registered email ID.
Creating a Template
The next process to send an SMS is to create a template. A template is a pre-defined version of an SMS that contains replaceable variables and a default format.
Your subscription to our services expires on DD-MM-YYYY. To continue using our services, please renew your subscription on or before DD-MM-YYYY.
In the above SMS, the customer name, subscription expiry date and renewal date are replaceable parameters and can be customized according to the expiry dates of the respective user accounts.
Follow the steps below to create your own template:
Click on the Manage Items left menu > Manage Sender ID
From the right-hand side column, click on the eye icon. This will now open a new page called Templates
Click on the New button present on the right-hand side to create a new template.
Type the content in the box space provided in the ‘Add template’ pop up window and click on save. Your template is now saved and can be reused again.
Generating API Key
Once you have an active account with us, you can generate and API Key from our SMS application. The following are the steps to follow to generate an API Key:
- Login to Alerts/ Promo/ Global Application
- Click on the 'Developer' section from the left menu
- Click on API Keys and click on Resend Button
- The API key will be sent to your registered email ID.
You can request for an API key any number of times from your SMS account and the same will be delivered to the registered email ID.