SMS API Documentation

Our API is organized around REST, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs. JSON is returned by all API responses.

We only use the HTTP verb POST and manage your requests using the TransferType property. This allows you to use the same URL regardless of your requests.

Our API requires you to use Bearer Token-based authentication to access the API.

Send SMS


Request Body

{
    "TransferType": "string",
    "ClientId": "string",
    "SMSPayload":
    {
        "Message": "string",
        "To": ["string"]
    }
}


Optional Properties

- Title, of the actual SMS job. (Campaign, Offers, Sales, etc.)

- Description, of the actual SMS job. (What was the content, etc.)

- From, to override the default sender.


{
    "TransferType": "string",
    "ClientId": "string",
    "Title": "string",        (Max 50 char)
    "Description": "string,"  (Max 255 char)
    "SMSPayload":
    {
        "From": "string",     (Max 11 char)
        "Message": "string",
        "To": ["string"]
    }
}

TransferType SendSMS
Request Method POST
Location https://web2netadmin.azurewebsites.net/api/sms/v1
Authorization Bearer *************
Header Content-Type: application/json
Responses 200
    {
        "SMSJobId": "string"
    }

400 Missing clientId - Invalid clientId - Missing recipients - Missing account coverage
    If you use the optional properties, Title / Description 400 The request cannot be fulfilled due to error in Title - The request cannot be fulfilled due to error in Description
401 Invalid authorization
403 Missing authorization
500 Internal server error

SMS Job


Request Body

{
    "TransferType": "string",
    "SMSJobId": "string"
}

TransferType SMSJob
Request Method POST
Location https://web2netadmin.azurewebsites.net/api/sms/v1
Authorization Bearer *************
Header Content-Type: application/json
Responses 200
    {
        "SMSJob":
        {
            "Date": "string",
            "Title": "string",
            "Description": "string",
            "Message": "string",
            "From": "string",
            "SMSSent": integer,
            "SendtTo":
            [{
                "Sendt": boolean,
                "To": "string",
                "SID": "string"
            }]
        }
    }

400 Missing jobId - Invalid jobId
401 Invalid authorization
403 Missing authorization
500 Internal server error

SMS Report


Request Body

{
    "TransferType": "string",
    "ClientId": "string",
    "FromDate": "string",
    "ToDate": "string"
}

TransferType SMSReport
Request Method POST
Location https://web2netadmin.azurewebsites.net/api/sms/v1
Authorization Bearer *************
Header Content-Type: application/json
Responses 200
    {
        "SMSJobs":
        [{
            "Date": "string",
            "Title": "string",
            "Description": "string",
            "Message": "string",
            "From": "string",
            "SMSSent": integer,
            "SendtTo":
            [{
                "Sendt": boolean,
                "To": "string",
                "SID": "string"
            }]
        }]
    }

400 No reports to display - The request cannot be fulfilled due to bad syntax
401 Invalid authorization
403 Missing authorization
500 Internal server error

SMS Account


Request Body

{
    "TransferType": "string",
    "ClientId": "string"
}

TransferType SMSAccount
Request Method POST
Location https://web2netadmin.azurewebsites.net/api/sms/v1
Authorization Bearer *************
Header Content-Type: application/json
Responses 200
    {
        "SMSAccount":
        {
            "Date": "string",
            "Code": "string",
            "SMSStock": integer,
            "SMSSent": integer
        }
    }

400 Missing clientId - Invalid clientId
401 Invalid authorization
403 Missing authorization
500 Internal server error