AuroraSendCloud API Quickstart

Get started with AuroraSendCloud's powerful APIs to send emails, manage contacts, track performance, and integrate seamlessly with your applications. Follow this step-by-step guide to make your first API call in minutes, with clear distinctions between multi-region email APIs and the single-region SMS API.

Prerequisites

Before you begin, ensure you have:

• An active AuroraSendCloud account (sign up at aurorasendcloud.com)
• Your API Key and API User (found in your account's API Key Management page)
• A supported HTTP client (e.g., cURL, Postman, Python's requests library)
• Confirmation of your account's region (Singapore, US, or Hong Kong) for email API access (not required for SMS API)

1. API Base URLs & SMTP Servers (By Service Type)

Email & Core APIs (Multi-Region)

Choose the base URL that matches your account's region for email, contact management, templates, and other core services. All requests must use HTTPS, and responses are returned in JSON format.

ℹ️

Note: Your account is tied to a specific region during sign-up. Using a non-matching base URL for email/core APIs will cause authentication failures or data inconsistencies. Confirm your region in your account settings.

SMTP Servers (Multi-Region)

For applications that require SMTP integration, use the regional SMTP server that corresponds to your account's region. All SMTP connections require authentication and support both SSL/TLS encryption.

SMTP Authentication

• Username: Your AuroraSendCloud API username (same as api_user)
• Password: Your AuroraSendCloud API key (same as api_key)
• Encryption: SSL/TLS (recommended) or STARTTLS

SMTP Configuration Example

import smtplib
from email.mime.text import MIMEText
from email.mime.multipart import MIMEMultipart

# Regional SMTP settings
smtp_server = "smtp.aurorasendcloud.com"  # or smtp-us/smtp-hk
smtp_port = 465  # SSL/TLS
username = "YOUR_API_USER"
password = "YOUR_API_KEY"

# Create message
msg = MIMEMultipart()
msg['From'] = "[email protected]"
msg['To'] = "[email protected]"
msg['Subject'] = "Test Email via SMTP"

body = "Hello from AuroraSendCloud SMTP!"
msg.attach(MIMEText(body, 'plain'))

# Send email
with smtplib.SMTP_SSL(smtp_server, smtp_port) as server:
    server.login(username, password)
    server.send_message(msg)

SMS API (Single Region)

The SMS API uses a unified global base URL (no regional endpoints required):

• Base URL: https://api.aurorasendcloud.com/
• All SMS requests must use this URL regardless of your account's region
• Authentication and response format are consistent with email/core APIs

2. Authentication

Authenticate all API requests (email, SMS, and core services) by including your credentials as request parameters:

• api_user: Your AuroraSendCloud API username
• api_key: Your AuroraSendCloud API key

⚠️

Critical Security Note: Never expose your API credentials in client-side code (e.g., browsers, mobile apps). Restrict access to your API key, rotate it regularly via the API Key Management page, and avoid hardcoding credentials in your source code.

3. Making Your First API Call

Example: Send an Email via REST API

curl -X POST "https://api.aurorasendcloud.com/mail/send" \
  -d "api_user=YOUR_API_USER" \
  -d "api_key=YOUR_API_KEY" \
  -d "[email protected]" \
  -d "fromName=Your Name" \
  -d "[email protected]" \
  -d "subject=Test Email" \
  -d "html=<h1>Hello from AuroraSendCloud!</h1>"

Example: Send an SMS

curl -X POST "https://api.aurorasendcloud.com/smsapi/send" \
  -d "smsUser=YOUR_SMS_USER" \
  -d "smsKey=YOUR_SMS_KEY" \
  -d "templateId=123456" \
  -d "phone=+1234567890" \
  -d "vars={\"code\":\"123456\"}"

4. API Response Format

All API responses (email and SMS) follow a consistent JSON structure:

Success Response (Request Successful)

{
  "result": true,
  "statusCode": 200,
  "message": "request was successful",
  "info": {}
}

Success Response (Data Acquisition)

{
  "statusCode": 200,
  "info": {
    "data": {
      "gmtCreated": "2015-10-19 15:39:27",
      "gmtUpdated": "2015-10-19 15:39:27",
      "labelId": 123,
      "labelName": "test"
    }
  },
  "message": "request was successful",
  "result": true
}

Error Response (Authentication Failed)

{
  "result": false,
  "statusCode": 40005,
  "message": "authentication failed",
  "info": {}
}

Response Field Definitions:

• result: Boolean indicating whether the request succeeded (true) or failed (false)
• statusCode: Numeric code representing the request status (see complete list below)
• message: Description of the status code (for debugging and user feedback)
• info: Contains response data (e.g., SMS/email IDs, retrieved records) on success; empty on failure

5. API Return Codes Reference

Common Status Codes

General & Validation Errors (40001-40017)

Label Management (40100-40113)

Template Management (40201-40229)

Email Sending Parameters (40801-40880)

Email Sending Results (40901-40913)

Address List Management (40501-40522)

Domain & API User Management (41001-41119)

System & Server Errors (49901-50001)

6. Best Practices

Ready to start building? Use the REST API examples for advanced integrations or configure SMTP settings for simple email sending. Both methods support the same regional optimization and authentication credentials.