Query Unread Inbound Messages
Method SMSMOMessage
Address
api/UreadMessages/SMSMOMessage?username=[]&password=[]
Basic Auth Method
api/UreadMessages/SMSMOMessageBasicAuth
Http Verb .
GET
Overview
The query returns MO SMS messages that have not yet been returned by the query. Ordered the Received Date Time;
Parameters
Name | Use | Notes |
|---|---|---|
username | username for authenication against AppSender APISMSUsername value | not required for basic auth method. This information is supplied in the http auth header |
password | username for authenication against AppSender APISMSPassword value | not required for basic auth method. This information is supplied in the http auth header |
Returns
List of MO messages in JSON format per example below
[
{ "recipient" : "6140001001001", "from":"61400000001","id":"12345","text":"Test MO Message","received":"2019-09-21 00:00:00","mtMesasgeId":"13345AGFDE"},
{ "recipient" : "6140001001001", "from":"61400000002","id":"12346","text":"Test MO Message","received":"2019-09-21 00:00:00","mtMesasgeId":"12345AGFDE"},
{ "recipient" : "6140001001001", "from":"61400000003","id":"12347","text":"Test MO Message","received":"2019-09-21 00:00:00","mtMesasgeId":"14345AGFDE"},
{ "recipient" : "6140001001001", "from":"61400000004","id":"12348","text":"Test MO Message","received":"2019-09-21 00:00:00","mtMesasgeId":"15345AGFDE"}
] |
Method: MOMessageList
path: api/UreadMessages/MOMessageList?username=[]&password=[]
Basic Auth Method
path: api/UreadMessages/SMSMOMessageBasicAuth
Http Verb .
GET
Overview
The query returns both SMS and MMS MO messages that have not yet been returned by the query. Ordered the Received Date Time;
Parameters
Name | Use | Notes |
|---|---|---|
username | username for authenication against AppSender APISMSUsername value | not required for basic auth method. This information is supplied in the http auth header |
password | username for authenication against AppSender APISMSPassword value | not required for basic auth method. This information is supplied in the http auth header |
Note if the numberOfItems = totalItemsUnread the there are no more messages to query. Given you can receive up to 100 messaging in one call for there to be more messages query te totalitemsUnread would have to be greater than 100.
Returns
"numberOfItems": 6,
"totalItemsUnread": 6,
"messages": [
{
"id": "0ceb66d4-a007-4ace-a21a-de4a57ccde6b",
"from": "61439791779",
"recipient": "61488826800",
"received": "11/11/2022 3:13:57 AM",
"text": "Robot",
"mtMessageId": null,
"location": null,
"subject": null
},
{
"id": "88e5ad3e-761c-4291-8436-2e9fef090222",
"from": "61419109003",
"recipient": "61488826800",
"received": "11/15/2022 4:51:26 AM",
"text": "NPS",
"mtMessageId": null,
"location": null,
"subject": null
},
{
"id": "ce1a736a-2cef-4df3-bc49-25a0853459ec",
"from": "61401328025",
"recipient": "61488826800",
"received": "11/16/2022 8:50:59 PM",
"text": "Robot",
"mtMessageId": null,
"location": null,
"subject": null
},
{
"id": "deb73e6d-b9e7-4572-878a-d8f1ed5d0403",
"from": "61401328025",
"recipient": "61488826800",
"received": "11/17/2022 7:49:30 AM",
"text": "Robot",
"mtMessageId": null,
"location": null,
"subject": null
},
{
"id": "91e541ce-8bf7-4faa-bbb1-299f521cf80b",
"from": "61401328025",
"recipient": "61488826800",
"received": "11/17/2022 7:49:35 AM",
"text": "Testing",
"mtMessageId": null,
"location": null,
"subject": null
},
{
"id": "a87c1843-bbed-4adb-ab98-a460071b56cd",
"from": "61401328025",
"recipient": "61488826800",
"received": "11/17/2022 7:49:49 AM",
"text": "Testing 3",
"mtMessageId": null,
"location": null,
"subject": null
}
]
}
Empty Set Returned
{
"status": "0",
"description": "success",
"numberOfItems": 0,
"totalItemsUnread": 0,
"messages": []
}
Query Unread Inbound MMS Messages
Overview
Due to the data size of an MMS message this query will only return one message at a time. There are return properties too indicate if there are more unread message to be picked and also to tell you how many there are to pick up. This query should be run single threaded till you are aware you have more than 5 messages to pick up. You may then increase your threads to a max of 5. Once you have no more message to collect reduce the number of threads to 1.
Set your initial time between polling based on you expected inbound mms volume.
Note - with multiple threads there is a small possibility that you will pick up the same message twice - you can detect this by our id property.
Method SMSMOMessage
Address
api/UreadMessages/MMSMOMessage?username=[]&password=[]
Http Verb .
GET
Overview
The query return MO messages that have not yet been returned by the query. Order the Received Date Time;
Parameters
Name | Use |
|---|---|
username | username for authenication against AppSender APISMSUsername value |
password | username for authenication against AppSender APISMSPassword value |
Returns
Single MMS message response
|
Method MMSMOMessageBasicAuth
Address
api/UreadMessages/MMSMOMessageBasicAuth
Authentication - Set your username and password in the Basic Auth value of your request
Http Verb .
GET
Return
This method returns the same as MMSMOMessageBasicAuth