Get a list of incoming short/long code messages

GET

/shortcode/incoming

shortcode

Only available to users with a WinSMS Short/Long Code.
Get a list of all incoming short/long code messages received by the account.

Only the first 100 incoming short/long code messages will be returned if no offset and limit parameters are specified.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://www.winsms.co.za/api/rest/v1/shortcode/incoming'

Response Example

200 - Example 1

{
    "resultsLimit": 100,
    "resultsOffset": 3400,
    "resultsTotalAvailable": 3402,
    "shortcodeMessages": [
        {
            "incomingApiMessageId": 58324,
            "messageText": "Win Big",
            "mobileNumber": "27444444444",
            "receiveTime": "201707252208"
        },
        {
            "incomingApiMessageId": 58336,
            "messageText": "Savings for me",
            "mobileNumber": "27555555555",
            "receiveTime": "201707270952"
        }
    ],
    "statusCode": 200,
    "timeStamp": "20170117054658978",
    "version": "1.0"
}

Request

Query Params

offset

integer

optional

Optional - The number of items to skip before starting to return results. Default 0. Minimum 0.

limit

integer

optional

Optional - The number of items to return. Default 100. Minimum 1. Maximum 1000.

Responses

🟢200OK

application/json

Body

resultsLimit

integer

optional

The number of items returned in the results. This is the value specified in the limit parameter sent to the endpoint. If the parameter was not specified, this defaults to 100.

resultsOffset

integer

optional

The number of items skipped before the results were returned. This is the value specified in the offset parameter sent to the endpoint. If the parameter was not specified, this defaults to 0.

resultsTotalAvailable

integer

optional

The total number of results available for retrieval. The offset and limit properties specify which of the total available results have been returned.

shortcodeMessages

array[object (shortcodeMessage) {4}]

optional

An array of shortcodeMessage objects containing properties of each incoming shortcode message received by WinSMS.

>= 1 items<= 1000 items

incomingApiMessageId

number

optional

The unique API message id assigned to this incoming message.

Example:

58324

messageText

string

optional

The text of the incoming SMS message.

Example:

Hello, I'm responding to your advert.

mobileNumber

string

optional

The mobile number that sent the SMS message, displayed using the international E164 (without the plus) format

Example:

27444444444

receiveTime

string

optional

The date and time the message was received by WinSMS, in the format YYYYMMDDHHmm.

Example:

201707270952

statusCode

integer

optional

The http status code returned - reflected in the body for convenience

timeStamp

string

optional

The date/time the request was processed, in the format YYYYMMDDhhmmssSSS

version

string

optional

The current version of the API of the endpoint that was called

🟠401Unauthorized

🟠404Not found

🟠405Method Not Allowed

🟠422Unprocessable Entity

🔴500Internal Server Error

Modified at 2023-08-15 09:05:19

Transfer credits between main and sub accounts.

Get a list of incoming SMS messages