Quick SMS Bulk SMS Requests List Transactions

Rest API Dexatel

API and SDK Documentation
Version: 1.0

Quick SMS

POST
/send/sms/quick
Usage and SDK Samples
...
...
...
...

Parameters

Header Parameters
Name Description
token * string(32) Your secret token
Body Parameters
Name Description
phone* string Recipient number
sender_name* string(11) SMS Sender Name
message* text SMS text

Responses

Status: 200 - Success
{
    "statusName": "OK",
    "data": {
        "request_uuid": "j8iu7uy65rt54edfr45tghy678iu765",
        "custom_actions": {}
    }
}
                                        

Bulk SMS

POST
/send/sms/bulk
Usage and SDK Samples
...
...
...
...

Parameters

Header Parameters
Name Description
token * string(32) Your secret token
Body Parameters
Name Description
messages* array array[Messages]

Responses

Status: 200 - Success
{
    "statusName": "OK",
    "data": {
        "request_uuid": "j8iu7uy65rt54edfr45tghy678iu765",
        "custom_actions": {}
    }
}
                                    
Messages[{
    phone* string|array                    ex.: 12025550151 or [12025550151, 12025550152]
    sender_name*	string(11)        ex.: My Company
    message*	string(1377)             ex.: My first SMS
    date_send datetime                  ex.: 2020-27-10 08:00:00, default: now()
}]
                                    

Requests List

GET
/requests
Usage and SDK Samples

Parameters

Header Parameters
Name Description
token * string(32) Your secret token
Body Parameters
Name Description
type string Request type (QUICK, BULK, CAMPAIGN)
default: gets all types
date_start datetime Requests' start date
default: now() - 1 MONTH
date_end datetime Requests' end date
default: now()
page integer Page number
default: 1
limit integer Items count per page
default: 20

Responses

Status: 200 - Success
{
    "statusName": "OK",
    "data": {
        "requests": [
            {
                "request_uuid": "571e7632-ce2e-4306-a6a5-386aceffe464",
                "phone": ["12025550150"],
                "sender_name": "My Company",
                "message": "My first SMS",
                "type": "QUICK",
                "count": {"fail": 0, "total": 1, "success": 1, "canceled": 0, "scheduled": 0},
                "date_start": "2020-10-26T19:12:54.000Z",
                "date_finish": "2020-10-26T19:12:54.000Z"
            },
            ...
        ],
        "_meta": {"total": 204, "currentPage": 1, "pageCount": 9}
    }
}
                                        

Transactions

GET
/transactions
Usage and SDK Samples

Parameters

Header Parameters
Name Description
token * string(32) Your secret token
Body Parameters
Name Description
type string Transaction type (PAYPAL, CREDIT_CARD, BANK_TRANSFER, MANUAL)
default: gets all types
date_start datetime Requests' start date
default: now() - 1 MONTH
date_end datetime Requests' end date
default: now()
page integer Page number
default: 1
limit integer Items count per page
default: 20

Responses

Status: 200 - Success
{
    "statusName": "OK",
    "data": {
        "transactions": [
            {
                "transaction_uuid": "8uy655rtifre45t6y7u87ygfvfre13",
                "type": "PAYPAL",
                "sum": 15,
                "balance_before": 26.12,
                "balance_after": 41.12,
                "comment": "paypal",
                "date_send": "2020-09-21 22:20:00"
            }
            ...
        ],
        "_meta": {"total": 87,"currentPage": 1,"pageCount": 5}
    }
}
                                        
Dexatel aims to build a better future where technology creates good connections and communication for everyone and everywhere.