Knowledge Base

This article explains the steps to utilize an API service that enables you to provide API services through your application. With this service, your customers can integrate your API into their software and use your services.

Download Sample File

Requirements for API Usage

• API Access Information: User Token and API URL are required.
• Account Balance: Customers must have sufficient credit in their account to send SMS via the API.

What You Can Do with the API

• Send single or bulk SMS.
• View detailed SMS reports.
• Check current account balance.
• View SMS pricing details.

Obtaining API Access Information

API URL

1. Log in to the customer panel.
2. Click on the "International SMS Service" menu option.
3. Find your API URL in the "API Information" section.

User Token

1. Similarly, log in to the customer panel.
2. Click on the "International SMS Service" menu option.
3. Find your User Token in the "API Information" section.

API Usage Details

All requests to the API must be sent using the POST method, and the data format should be JSON.

1. Sending Single or Bulk SMS

URL: /submit

Example JSON Request

{
    "user_token": "",
    "origin": "+12025550160",
    "message": "Message content here...",
    "numbers": [
        "+447517663928",
        "+12126712234"
    ]
}

Successful Response Example

{
    "status": "successful",
    "report_id": 12345
}

2. Viewing Detailed SMS Reports

URL: /report

Example JSON Request

{
    "user_token": "",
    "report_id": 12345
}

Successful Response Example

{
    "waiting": {
        "data": [],
        "count": 0
    },
    "conducted": {
        "data": [
            "+447517663928",
            "+12126712234"
        ],
        "count": 2
    },
    "erroneous": {
        "data": [],
        "count": 0
    },
    "status": "successful"
}

3. Checking Current Account Balance

URL: /balance

Example JSON Request

{
    "user_token": ""
}

Successful Response Example

{
    "status": "successful",
    "formatted": "49,643.13",
    "formatted_symbolic": "$49,643.13",
    "unformatted": "49643.1318",
    "currency": "USD"
}

4. Viewing SMS Pricing Details

URL: /prices

Example JSON Request

{
    "user_token": ""
}

Successful Response Example

{
    "status": "successful",
    "prices": [
        {
            "countryCode": "AD",
            "prices": {
                "USD": 0.1915,
                "EUR": 0.1772,
                "GBP": 0.1581,
                "NGN": 73.97,
                "PKR": 30.44,
                "TRY": 1.3166
            }
        }
    ]
}