Overview

Business-Initiated Messaging

With the business-initiated messaging APIs, businesses can send pre-approved message templates that are created and reviewed within Arattai Business Platform.

These templates enable businesses to create, manage, and reuse message formats for promotional, transactional, and authentication use cases. By using templates, outbound messages remain consistent, intuitive, engaging, and ready for automated delivery at scale. Templates also help maintain brand tone and content accuracy while simplifying localisation through multi-language support. In addition, they reduce operational effort by providing reusable, approved formats for recurring notifications and customer communications.

By using the business-initiated messaging APIs after creating message templates in Arattai Business Platform, you can send promotions, transaction updates, and authentication messages to customers and clients without waiting for them to initiate the conversation. Whether it's a limited-time offer, an order update, or a secure OTP, this messaging configuration focuses on outbound notifications and alerts. It helps your business maintain high engagement and trust while reducing reliance on SMS or email systems.

Supported Languages

Message templates can be sent in the following languages. The created template must have a corresponding language version set up in Arattai Business Platform.

Code Language
en English (default)
es Spanish
fr French
de German
it Italian
pt Portuguese
ru Russian
zh Chinese Simplified
ja Japanese
ko Korean
ar Arabic
hi Hindi
ta Tamil
te Telugu
ml Malayalam
bn Bengali
gu Gujarati
mr Marathi
pa Punjabi
th Thai
tr Turkish
nl Dutch
pl Polish
sv Swedish
no Norwegian
da Danish
fi Finnish
cs Czech
el Greek
ro Romanian
hu Hungarian
vi Vietnamese
id Indonesian
ms Malay
he Hebrew
ur Urdu
fa Persian
sw Swahili
uk Ukrainian
bg Bulgarian
sr Serbian
sk Slovak
sl Slovenian
ca Catalan
eu Basque
gl Galician
et Estonian
lv Latvian
lt Lithuanian
is Icelandic
zh_tw Chinese Traditional
kn Kannada
or Odia

Pre-requisites

Retrieving the template ID for message templates

To roll out business-initiated messages via the API, you will need the ID of the message template. Go to Arattai Business Platform → Tools → Templates. The template ID is displayed directly under each template name in the list:

ID: 78423256427323392

Copy and store this ID to execute APIs related to business-initiated messages.

⚠
Important Every message template must be submitted for review and approval before it can be used. This review process ensures that your content complies with Arattai's legal, data privacy, and anti-spam guidelines, protecting both your business and your customers.

Retrieving and managing the USER_ID of customers

The USER_ID is a unique identifier assigned to each customer or user, essential for sending messages. Businesses can obtain a customer's USER_ID when the user initiates a chat or replies, depending on their privacy settings.

Below are the methods to retrieve the USER_ID in different scenarios:

1. When the customer initiates the conversation

  • If a user starts a chat with a business, the USER_ID will be included in the webhook payload sent to that business.
  • Businesses can then access, store, and reuse this USER_ID to respond via conversational messaging APIs or to send future business-initiated message templates through APIs.

2. When the business initiates the conversation

  • If a business initiates a chat, it can send a message template through the API using either the customer's phone number or the USER_ID, provided that the USER_ID has been previously acquired.
  • When a message template is sent using the customer's phone number, the API response will always include the corresponding USER_ID.
  • Businesses should store this USER_ID, as it can be utilised for future message templates or for conversational messaging through the API.