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",
    "Message": "string",
    "SendTo": ["string"]
}


Optional Properties

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

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



TransferType sendsms
Request Method POST
Location https://hub.web2net.no/api/sms
Authorization Bearer *************
Header Content-Type: application/json
Responses 200
    {
        "SMSJobId": "string"
    }

400 Missing ClientId
400 Missing recipients
400 Missing account coverage
400 Error sending SMS
400 The request cannot be fulfilled due to bad syntax
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://hub.web2net.no/api/sms
Authorization Bearer *************
Header Content-Type: application/json
Responses 200
    {
        "SMSJobAndPayloadObj":
        {
            "RegDate": "string",
            "Title": "string",
            "Description": "string",
            "Code": "string",
            "Message": "string",
            "SMSPayloadList":
            [{
                "RegDateTime": "string",
                "SentTo": "string",
                "SID": "string",
                "Status": "string"
            }]
        }
    }

400 Missing SMSJobId
400 Invalid SMSJobId
400 The request cannot be fulfilled due to bad syntax
401 Invalid authorization
403 Missing authorization
500 Internal server error

SMS Report


Request Body

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


FromDate and ToDate format

  MM/DD/YYYY



TransferType smsreport
Request Method POST
Location https://hub.web2net.no/api/sms
Authorization Bearer *************
Header Content-Type: application/json
Responses 200
    {
        "SMSJobAndPayloadList":
        [{
            "RegDate": "string",
            "Title": "string",
            "Description": "string",
            "Code": "string",
            "Message": "string",
            "SMSPayloadList":
            [{
                "RegDateTime": "string",
                "SentTo": "string",
                "SID": "string",
                "Status": "string"
            }]
        }]
    }

400 Missing ClientId or From/To- Date
400 No reports to display
400 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://hub.web2net.no/api/sms
Authorization Bearer *************
Header Content-Type: application/json
Responses 200
    {
        "SMSAccountObj":
        {
            "Code": "string",
            "SMSStock": integer,
            "SMSSent": integer
        }
    }

400 Missing ClientId
400 Invalid ClientId
400 The request cannot be fulfilled due to bad syntax
401 Invalid authorization
403 Missing authorization
500 Internal server error