Version 1.0.0
Select an endpoint from the sidebar to view its documentation and try it out in the interactive playground.
All API requests require API key & Client Secret to be passed in the header:
apiKey: YOUR_API_KEY
clientSecret: YOUR_CLIENT_SECRET
https://smspipe.eduplusbd.com/api
Select an endpoint and click "Send Request"
Retrieve the current balance information.
No parameters needed.
{
"status": "string",
"balance": {
"telegram": 0
}
}
No parameters required for this endpoint.
Retrieve data for a specific campaign.
| Parameter | Type | Required | Description |
|---|---|---|---|
| campaign | string | Yes | Campaign identifier |
| page | integer | Yes | Page number |
| message_visibility | string | No | Message visibility (show/hide), default: hide |
{
"status": "string",
"total": 0,
"per_page": 0,
"current_page": 0,
"last_page": 0,
"campaign": [
{
"identity_key": "string",
"is_unicode": true,
"message_count": 0,
"message": "string",
"status": "string",
"schedule": "string",
"receiver": ["string"],
"channel": "string",
"time": "string"
}
]
}
Retrieve messages using their identity keys.
| Parameter | Type | Required | Description |
|---|---|---|---|
| identity_keys | array[string] | Yes | Array of identity keys (min 1) |
| campaign | string | No | Campaign identifier |
| page | integer | Yes | Page number |
| message_visibility | string | No | Message visibility (show/hide), default: hide |
{
"status": "string",
"total": 0,
"per_page": 0,
"current_page": 0,
"last_page": 0,
"messages": [
{
"identity_key": "string",
"is_unicode": true,
"campaign": "string",
"message_count": 0,
"message": "string",
"status": "string",
"schedule": "string",
"receiver": ["string"],
"channel": "string",
"time": "string"
}
]
}
Search and filter messages with various criteria.
| Parameter | Type | Required | Description |
|---|---|---|---|
| message | string | No | Search term for messages |
| channels | array[string] | No | Array of channel identifiers (min 1) |
| campaigns | array[string] | No | Array of campaign keys (min 1) |
| date_range | array[string] | No | Start and end date in 'YYYY-MM-DD' format (exactly 2 items) |
| status | array[string] | No | Array of message statuses (1-4 items) |
| is_unicode | string | No | Filter by Unicode status (yes/no) |
| schedule | string | No | Filter by scheduled date |
| message_count | array[integer] | No | Min and max message counts (1-2 items) |
| page | integer | Yes | Page number |
| message_visibility | string | No | Message visibility (show/hide), default: hide |
{
"status": "string",
"total": 0,
"per_page": 0,
"current_page": 0,
"last_page": 0,
"data": [
{
"identity_key": "string",
"is_unicode": true,
"campaign": "string",
"message_count": 0,
"message": "string",
"status": "string",
"schedule": "string",
"receiver": ["string"],
"channel": "string",
"time": "string"
}
]
}
Retrieve Telegram subscribers information.
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | Yes | Page number |
{
"status": "string",
"total": 0,
"per_page": 0,
"current_page": 0,
"last_page": 0,
"subscribers": [
{
"chat_id": "string",
"first_name": "string",
"last_name": "string",
"username": "string",
"is_bot": true,
"language_code": "string"
}
]
}
Send multiple messages in a single request.
{
"global_body": "string",
"messages": [
{
"identity_key": "string",
"body": "string",
"is_unicode": "yes|no",
"channels": {
"routemobile": {
"to": "string"
}
}
}
],
"skip_rejected": "yes|no"
}
{
"status": "string",
"environment": "string",
"campaign": "string",
"rejected_messages": [
{
"identity_key": "string",
"body": "string",
"is_unicode": "string",
"channel": "string",
"reason": {}
}
],
"balance_consumed": {},
"balance_left": {
"channel_name": 0
},
"total_queued": 0
}
Send a single message.
{
"message": {
"identity_key": "string",
"body": "string",
"is_unicode": "yes|no",
"channels": {
"routemobile": {
"to": "string"
}
}
},
"skip_rejected": "yes|no"
}
{
"status": "string",
"environment": "string",
"result": {},
"campaign": "string",
"rejected_messages": [
{
"identity_key": "string",
"body": "string",
"is_unicode": "string",
"channel": "string",
"reason": {}
}
],
"balance_consumed": {},
"balance_left": {}
}
Resend previously sent messages.
{
"identity_keys": ["string"],
"token": ["string"],
"campaign": ["string"],
"channels": ["string"],
"status": ["string"]
}
{
"status": "string",
"messages": [
{
"identity_key": "string",
"is_unicode": true,
"campaign": "string",
"message_count": 0,
"status": "string",
"schedule": "string",
"channel": "string",
"time": "string"
}
]
}