REST API

Learn how to integrate and use the EngageLab SMS REST API.

The EngageLab SMS service offers a set of RESTful APIs, allowing you to programmatically create templates and signatures, send SMS, and query your balance.

Please follow the steps below to start using the REST API.

Create an API Key

Before calling any EngageLab SMS API, you need to generate an API Key to authenticate your requests.

1. Log in to the EngageLab Console.
2. Enter the SMS sub-console and select your application.
3. Navigate to API Keys in the left navigation bar.
4. Click Create API Key to generate a new dev_key and dev_secret.

⚠️ Warning
Your dev_secret is highly sensitive. Please keep it safe and never leak it in client-side code or public code repositories.

Authentication

The EngageLab SMS API uses HTTP Basic authentication. You must include an Authorization header in all API requests.

The header is constructed by Base64 encoding your dev_key and dev_secret:

              
              Authorization: Basic ${base64_auth_string}

            

${base64_auth_string} is generated by joining your dev_key and dev_secret with a colon (:) and Base64 encoding the result: base64(dev_key:dev_secret).

For more details, please refer to the Authentication guide.

Call the API

Once you have your API Key and understand the authentication mechanism, you can start calling the APIs. All API endpoints use the base URL https://smsapi.engagelab.com.

Below are several major APIs you can integrate:

• Send SMS: Send SMS to single or multiple target mobile numbers, supporting automated sending of notifications and marketing SMS.
• Query Balance: Query your EngageLab SMS account's available balance in real-time via the API, including general and gift balance information.
• Template Management: Programmatically create, modify, delete, fetch all template lists, and view template details.
• Signature Management: Programmatically create, modify, delete, fetch all signature lists, and view signature details.
• Callback Event Reference: Configure callback URLs and use secure verification mechanisms to receive status reports and notifications.
• SMPP: Use the SMPP protocol via TCP connection for efficient, reliable message delivery and status reporting.