API Reference

Complete API documentation for QuickComm's messaging platform. Send SMS, voice calls, and OTPs programmatically.

Authentication

All API endpoints require authentication using your app_key and app_secret. You can authenticate using either query parameters or the Authorization header.

Method 1: Query Parameters

?app_key=YOUR_KEY&app_secret=YOUR_SECRET

Method 2: Header

Authorization: YOUR_KEY-YOUR_SECRET

Base URL

https://ok-go.in/api/v1

Check Account Status

Verify if your account is active and operational.

GET

GET /api/v1/account-status

Parameters

Parameter	Type	Required	Description
app_key	string	Required	Your API application key
app_secret	string	Required	Your API application secret

Request Example

bash

GET https://ok-go.in/api/v1/account-status?app_key={{APP_KEY}}&app_secret={{APP_SECRET}}

Response Example

json

{
  "status": true,
  "intime": "2025-02-28T11:31:50.814219Z",
  "outtime": "2025-02-28T11:31:50.879329Z",
  "message": "Account is in active status.",
  "data": {
    "is_account_activated": true
  },
  "errors": {},
  "error_code": null
}

Check Balance

Get your current account balance and credit information across all channels.

GET

GET /api/v1/check-balance

Parameters

Parameter	Type	Required	Description
app_key	string	Required	Your API application key
app_secret	string	Required	Your API application secret

Request Example

bash

GET https://ok-go.in/api/v1/check-balance?app_key={{APP_KEY}}&app_secret={{APP_SECRET}}

Response Example

json

{
  "status": true,
  "message": "Information successfully retrieved.",
  "data": {
    "user_number": 16,
    "name": "John Doe",
    "email": "john@example.com",
    "mobile": "9876543210",
    "status": "1",
    "transaction_balance": 114830,
    "promotional_balance": 0,
    "two_waysms_balance": 0,
    "voice_sms_balance": 0,
    "whatsapp_credit": "0.0000",
    "country": 99,
    "is_enabled_api_ip_security": 0,
    "ut": 2
  },
  "errors": {},
  "error_code": null
}

Get Approved Sender IDs

Retrieve list of all approved sender IDs for your account.

GET

GET /api/v1/approved-senderids

Parameters

Parameter	Type	Required	Description
app_key	string	Required	Your API application key
app_secret	string	Required	Your API application secret

Request Example

bash

GET https://ok-go.in/api/v1/approved-senderids?app_key={{APP_KEY}}&app_secret={{APP_SECRET}}

Response Example

json

{
  "status": true,
  "message": "Information successfully retrieved.",
  "data": [
    { "sender_id": "QCOMM" },
    { "sender_id": "ALERTS" }
  ],
  "errors": {},
  "error_code": null
}

Get Templates

Fetch all approved DLT message templates for your account.

GET

GET /api/v1/templates

Parameters

Parameter	Type	Required	Description
app_key	string	Required	Your API application key
app_secret	string	Required	Your API application secret

Request Example

bash

GET https://ok-go.in/api/v1/templates?app_key={{APP_KEY}}&app_secret={{APP_SECRET}}

Response Example

json

{
  "status": true,
  "message": "Information successfully retrieved.",
  "data": [
    {
      "template_name": "OTP",
      "entity_id": "1234567890123456789",
      "dlt_header_id": "1234567890123456789",
      "is_for_unicode": 0,
      "dlt_message_template": "Your OTP is {#var#}. Valid for {#var#} minutes.",
      "dlt_template_id": "1507162019748109480",
      "status": 1
    }
  ],
  "errors": {},
  "error_code": null
}

Send SMS

Send single or bulk SMS messages with DLT compliance and template variable support.

GET

GET /api/v1/send-message

Parameters

Parameter	Type	Required	Description
app_key	string	Required	Your API application key
app_secret	string	Required	Your API application secret
dlt_template_id	string	Required	DLT registered template ID
mobile_numbers	string	Required	Comma-separated mobile numbers (e.g., 9876543210,8765432109)
route_type	integer	Required	Route type: 0 (OTP), 1 (Transactional), 2 (Promotional)
schedule_date	string	Optional	Schedule message (format: YYYY-MM-DD HH:MM:SS)
is_flash	boolean	Optional	Send as flash SMS
v1, v2, v3...	string	Optional	Template variables to replace {#var#} placeholders
country_code	string	Optional	Country code (default: 91 for India)

Request Example

bash

GET https://ok-go.in/api/v1/send-message?app_key={{APP_KEY}}&app_secret={{APP_SECRET}}&dlt_template_id=1507162019748109480&mobile_numbers=9876543210,8765432109&route_type=1&v1=QC12345&v2=2499&country_code=91

Response Example

json

{
  "status": true,
  "message": "Campaign successfully processed",
  "data": {
    "campaign": "API",
    "sender_id": "QCOMM",
    "route_type": 1,
    "sms_type": 1,
    "message": "Your order QC12345 confirmed. Amount: ₹2499",
    "is_flash": 0,
    "campaign_send_date_time": "2025-02-28 17:40:51",
    "message_count": 55,
    "message_credit_size": 1,
    "total_contacts": 2,
    "total_credit_deduct": 2,
    "status": "Ready-to-complete",
    "uuid": "0d8cbde0-f5cd-11ef-993e-2bd877xxxxxx",
    "total_invalid_number": 0
  },
  "errors": {},
  "error_code": null
}

Campaign List

Retrieve paginated list of all SMS campaigns with delivery statistics.

GET

GET /api/v1/campaign-list

Parameters

Parameter	Type	Required	Description
app_key	string	Required	Your API application key
app_secret	string	Required	Your API application secret
per_page_record	integer	Optional	Records per page (default: 20)
page_number	integer	Optional	Page number (default: 1)

Request Example

bash

GET https://ok-go.in/api/v1/campaign-list?app_key={{APP_KEY}}&app_secret={{APP_SECRET}}&per_page_record=5&page_number=1

Response Example

json

{
  "status": true,
  "message": "Information successfully retrieved.",
  "data": {
    "data": [
      {
        "id": 1234568,
        "campaign_name": "Campaign",
        "sender_id": "QCOMM",
        "sms_type": "1",
        "message": "Your campaign message here",
        "message_type": "1",
        "total_contacts": 1000,
        "currently_delivered": 985,
        "currently_failed": 15,
        "campaign_current_stage": "Completed"
      }
    ],
    "total": 3,
    "current_page": "1",
    "per_page_record": "5",
    "last_page": 1
  },
  "errors": {},
  "error_code": null
}

Standard Response Format

All API responses follow this standard JSON structure:

json

{
  "status": true,              // Boolean: true for success, false for error
  "intime": "2025-02-28T...",  // Request received timestamp
  "outtime": "2025-02-28T...", // Response sent timestamp
  "message": "Success message",// Human-readable message
  "data": { ... },             // Response data object
  "errors": {},                // Error details (if status is false)
  "error_code": null           // Error code (if status is false)
}

Rate Limits

All API endpoints have the following rate limits:

•X-RateLimit-Limit: 100,000 requests per day
•Rate limit headers are included in every response
•Contact support for increased limits for enterprise accounts

API Reference

Authentication

Base URL

Account Management

Check Account Status

Parameters

Request Example

Response Example

Check Balance

Parameters

Request Example

Response Example

Get Approved Sender IDs

Parameters

Request Example

Response Example

Get Templates

Parameters

Request Example

Response Example

SMS API

Send SMS

Parameters

Request Example

Response Example

Campaign List

Parameters

Request Example

Response Example

OTP API

Voice API

Standard Response Format

Rate Limits