REST API v2

Bulk SMS API documentation

Send transactional and promotional SMS, manage groups, sender IDs and templates through a simple JSON API. All requests are authenticated with your ApiKey and ClientId.

Authentication

Every request must include your ApiKey and ClientId. In GET requests pass them as URL-encoded query parameters; in POST/PUT requests include them in the JSON body.

BASE https://smsq.rongoit.com.bd/api/v2

Your API base URL. Get your credentials from the client panel → API Credentials.

HeaderValue
Content-Typeapplication/json (or application/xml)
Acceptapplication/json
Keep your ApiKey and ClientId secret. If a key leaks, ask the reseller to rotate it.

Credit balance

GET/Balance?ApiKey={ApiKey}&ClientId={ClientId}

Returns the SMS credit balance for the account.

curl "https://smsq.rongoit.com.bd/api/v2/Balance?ApiKey=YOUR_KEY&ClientId=YOUR_ID"
{
  "ErrorCode": 0,
  "ErrorDescription": "Success",
  "Data": [
    { "PluginType": "SMS", "Credits": 699.10 }
  ]
}

Groups

GET/Group?ApiKey={ApiKey}&ClientId={ClientId}

List all contact groups.

{ "ErrorCode": 0, "ErrorDescription": "Success", "Data": [
  { "GroupId": 33, "GroupName": "Customers", "ContactCount": 21 }
] }
POST/Group

Create a new group. Send JSON with GroupName, ApiKey and ClientId.

curl -X POST "https://smsq.rongoit.com.bd/api/v2/Group" \
  -H "Content-Type: application/json" \
  -d '{"GroupName":"Customers","ApiKey":"YOUR_KEY","ClientId":"YOUR_ID"}'
PUT/Group?id={Id}

Rename an existing group (JSON body: GroupName, ApiKey, ClientId).

POST/Group/{Id}/SubGroup

Create a sub-group under a parent group (JSON body: GroupName, ApiKey, ClientId).

DELETE/Group?ApiKey={ApiKey}&ClientId={ClientId}&id={Id}

Delete a group.

Sender IDs

GET/SenderId?ApiKey={ApiKey}&ClientId={ClientId}

List sender IDs with approval status and active flag.

{ "ErrorCode": 0, "ErrorDescription": "Success", "Data": [
  { "Id": 94, "Sender-Id": "SMS123", "Purpose": "TEST",
    "IsActive": true, "ApproveStatus": "Approved" }
] }
POST/SenderId

Request a new sender ID (JSON: SenderId, Purpose, ApiKey, ClientId). New IDs are pending approval.

PUT/SenderId?id={Id}

Update a sender ID (JSON: SenderId, Purpose, ApiKey, ClientId).

DELETE/SenderId?ApiKey={ApiKey}&ClientId={ClientId}&id={Id}

Delete a sender ID.

Templates

GET/Template?ApiKey={ApiKey}&ClientId={ClientId}

List message templates and their approval state.

{ "ErrorCode": 0, "ErrorDescription": "Success", "Data": [
  { "TemplateId": 138, "TemplateName": "Welcome",
    "MessageTemplate": "Dear ##Field##, welcome!", "IsApproved": false, "IsActive": true }
] }
POST/Template

Create a template (JSON: TemplateName, MessageTemplate, TemplateId, ApiKey, ClientId).

PUT/Template?id={Id}

Update a template (same JSON body as create).

DELETE/Template?ApiKey={ApiKey}&ClientId={ClientId}&id={Id}

Delete a template.

Sent messages

GET/SMS?ApiKey={ApiKey}&ClientId={ClientId}&start={start}&length={length}&fromdate={yyyy-mm-dd}&enddate={yyyy-mm-dd}

Paginated sent-message report.

{ "ErrorCode": 0, "ErrorDescription": "Success", "Data": {
  "messages": [
    { "MobileNumber": "8801XXXXXXXXX", "SenderId": "MYSHOP", "Message": "Hello",
      "SubmitDate": "16-Mar-2018 05:12:28 PM", "MessageId": "Smsc1603635", "Status": "DELIVRD" }
  ],
  "total": "100"
} }
GET/MessageStatus?ApiKey={ApiKey}&ClientId={ClientId}&MessageId={MessageId}

Delivery status for one message id.

Send SMS

GET/SendSMS?ApiKey={ApiKey}&ClientId={ClientId}&SenderId={SenderId}&Message={Message}&MobileNumbers={numbers}

Send one message to one or many comma-separated numbers.

ParameterDescription
MobileNumbersComma-separated numbers, e.g. 8801712345678,8801812345678
Is_UnicodeOptional — true/false
Is_FlashOptional — true/false
DataCodingOptional — 0 GSM, 3 Latin1, 8 UCS2
ScheduleTimeOptional — yyyy-MM-dd HH:MM
GroupIdOptional — send to a saved group
curl "https://smsq.rongoit.com.bd/api/v2/SendSMS?ApiKey=YOUR_KEY&ClientId=YOUR_ID&SenderId=MYSHOP&Message=Hello&MobileNumbers=8801712345678"
{ "ErrorCode": 0, "ErrorDescription": "Success", "Data": [
  { "MobileNumber": "8801712345678", "MessageId": "3bb944ad-d943-419f-83dc-f979002a8c0b" }
] }
POST/SendSMS

Same parameters in a JSON body, which avoids URL-encoding long messages.

curl -X POST "https://smsq.rongoit.com.bd/api/v2/SendSMS" \
  -H "Content-Type: application/json" \
  -d '{"SenderId":"MYSHOP","Message":"Hello","MobileNumbers":"8801712345678","ApiKey":"YOUR_KEY","ClientId":"YOUR_ID"}'

Send bulk / personalized SMS

POST/SendBulkSMS

Send a different message to each number using MessageParameters.

curl -X POST "https://smsq.rongoit.com.bd/api/v2/SendBulkSMS" \
  -H "Content-Type: application/json" \
  -d '{"SenderId":"MYSHOP","ApiKey":"YOUR_KEY","ClientId":"YOUR_ID",
       "MessageParameters":[
         {"Number":"8801712345678","Text":"Hello Ayesha"},
         {"Number":"8801812345678","Text":"Hello Rahim"}
       ]}'
GET/SendBulkSMS?ApiKey={ApiKey}&ClientId={ClientId}&SenderId={SenderId}&MobileNumber_Message=number^text~number^text

Bulk send via GET (URL-encode the MobileNumber_Message value).

Error codes

Check ErrorCode in every response. 0 means success.

CodeMeaning
0Success — message submitted; inspect the per-number MessageId result.
001Account details cannot be blank
003SenderId cannot be blank
004Message cannot be blank
005Message properties cannot be blank
006Internal server error occurred
007Invalid ApiCredentials
009User account locked — contact your administrator
010Unauthorized API access
011Unauthorized IP address
012Message length violation
013Invalid mobile numbers
015Invalid SenderId
017Invalid group id
018Group not allowed in BulkSMS
019Invalid schedule date
020Message or mobile number cannot be blank
023Parameter missing
024Invalid template or template mismatch
026Invalid date range
028Group not found
029Record already exists
033Queue connection closed
034Unable to create campaign at this time — try again later
036Error while publishing DLR
041Report not found
042Maximum mobile number limit exceeded
1025Insufficient credits
1026Invalid template while message processing
1029Invalid SenderId while message processing
1044Spam message detected
1047User account inactive
1081Country not found in master data
1082Network not found
1083Price not found
1084Expired
1085Route not found
1086Failover route not found
1087Failover expired
1088Failover price not found
1089Failover failed
1090Account validity expired
1091Encoding error
1092OA/DA error
1093Queue message expired
1094Invalid HTTP gateway config
1095HTTP request exception