Group SMS

API Documentation

Complete reference for integrating Group SMS API into your application.

Base URL

https://api-2ue64mzmvq-du.a.run.app

🔐 Authentication

All API requests require authentication using an API key. Include your API key in the X-API-Key header.

Authentication Header

X-API-Key: gsms_live_your_api_key_here

Get Your API Key: Download the Group SMS app, create an account, and generate your API key from Settings > Developer API.

API Key Formats

  • ●gsms_live_xxxxxProduction (real SMS)
  • ●gsms_test_xxxxxTesting (sandbox mode)

📡 Endpoints

Available API endpoints for SMS operations.

POST/api/v1/developer/send

Send SMS messages to one or more recipients

GET/api/v1/developer/status/:batchId

Check the delivery status of a batch

📤 Send SMS

Send SMS messages to one or more recipients. Messages are queued and sent by your Android phone.

POST/api/v1/developer/send

Request Body

recipients
requiredarray

Array of recipients with phone numbers and messages

phone
requiredstring

Recipient phone number (E.164 format recommended: +821012345678)

message
requiredstring

Message text (max 2000 characters per message)

Response

{
  "success": true,
  "batchId": "batch_1736416234_a1b2c3",
  "totalCount": 2,
  "estimatedDeliveryTime": "2-5 minutes"
}

Code Examples

curl -X POST https://api-2ue64mzmvq-du.a.run.app/api/v1/developer/send \
  -H "X-API-Key: gsms_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"recipients":[{"phone":"+821012345678","message":"Your verification code is 123456"},{"phone":"+821087654321","message":"Hello! This is a test message."}]}'

📊 Get Status

Retrieve the delivery status of a message batch using the batchId returned from the send endpoint.

GET/api/v1/developer/status/:batchId

Response

{
  "success": true,
  "batchId": "batch_1736416234_a1b2c3",
  "status": "completed",
  "totalCount": 10,
  "sentCount": 8,
  "failedCount": 2,
  "createdAt": "2026-01-09T03:30:34.000Z",
  "completedAt": "2026-01-09T03:35:12.000Z"
}

Status Values

  • pending - Batch created, waiting to be processed
  • processing - Currently sending messages
  • completed - All messages sent successfully
  • partial - Some messages sent, some failed
  • failed - All messages failed to send

Code Examples

curl -X GET https://api-2ue64mzmvq-du.a.run.app/api/v1/developer/status/batch_1234567890 \
  -H "X-API-Key: gsms_live_your_api_key_here"

⚠️ Error Codes

The API uses standard HTTP status codes to indicate success or failure.

401

Unauthorized

Invalid or missing API key. Check your X-API-Key header.

400

Bad Request

Invalid request format. Check your JSON payload and required fields.

429

Too Many Requests

Rate limit exceeded. Wait before making more requests.

500

Internal Server Error

An error occurred on our end. Please try again later.

⏱️ Rate Limits

To ensure fair usage, the API enforces rate limits on all endpoints.

100
messages per day (free tier)
10
requests per minute

Need Higher Limits?: Contact us for enterprise plans with higher limits and dedicated support.

Need Help?

Check out our quick start guide or browse the FAQ for common questions.

Quick Start Guide