WINSMS
  1. sms
WINSMS
  • credits
    • Get your current WinSMS credit balance
      GET
    • Transfer credits between main and sub accounts.
      POST
  • shortcode
    • Get a list of incoming short/long code messages
      GET
  • sms
    • Get a list of incoming SMS messages
      GET
    • Get a list of incoming opt-out SMS messages
      GET
    • Send SMS messages
      POST
    • Send multiple different SMS messages
      POST
    • Get SMS delivery statuses
      POST
    • Get a list of scheduled SMS messages
      GET
    • Delete scheduled SMS messages and refund credits
      POST
  • subaccounts
    • Get a list of all Sub Accounts.
      GET
  1. sms

Get a list of incoming SMS messages

GET
/sms/incoming
sms
Get a list of all incoming SMS messages received by the account.
Only the first 100 incoming messages will be returned if no offset and limit parameters are specified.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://www.winsms.co.za/api/rest/v1/sms/incoming'
Response Response Example
200 - Example 1
{
    "incomingMessages": [
        {
            "incomingApiMessageId": 58324,
            "messageText": "Thank you for the holiday wishes. Stay safe",
            "mobileNumber": "27444444444",
            "outgoingApiMessageId": 2316,
            "receiveTime": "201707252208"
        },
        {
            "incomingApiMessageId": 58336,
            "messageText": "That is much appreciated. Happy holidays to you too",
            "mobileNumber": "27555555555",
            "outgoingApiMessageId": 2316,
            "receiveTime": "201707270952"
        }
    ],
    "resultsLimit": 100,
    "resultsOffset": 3400,
    "resultsTotalAvailable": 3402,
    "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
incomingMessages
array[object (incomingMessage) {5}] 
optional
An array of incomingMessage objects containing properties of each incoming message.
>= 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 SMS invitation
mobileNumber
string 
optional
The mobile number that sent the SMS message, displayed using the international E164 (without the plus) format
Example:
27444444444
outgoingApiMessageId
number 
optional
The API message id of the most recent message sent to the mobile number that responded.
Example:
2316
receiveTime
string 
optional
The date and time the message was received by WinSMS, in the format YYYYMMDDHHmm.
Example:
201707270952
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.
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
Previous
Get a list of incoming short/long code messages
Next
Get a list of incoming opt-out SMS messages
Built with