Get received SMS

Home » DOCOON APIs » REST API » Basic functionnalities » Get received SMS

SMS responses are processed only if your account is configured. If this is not the case, please contact us.

This feature will allow you to view all SMS responses associated with your account.

Sending request Informations

Name: /InboundSMS
Type: GET

Headers:

Name	Value
Authorization	Value : Authorization token check : Connect to REST API
Content-Type	Value : application/json

Parameters list:

Parameter	Type	Description
customerNumber	int	(Optional) Customer number of the jobs.
pageIndex	int	(Optional) Page of the result you want to get (default = 1).
pageSize	int	(Optional) Number of jobs per page (default = 10).
filterJob	int	(Optional) Filter returning the SMS linked to a specific job. Depend of type of reception.
filterFrom	String	(Optional) Filter returning a list of SMS received depending of from address (Phone number of the sender). Default setting : All
filterTo	String	(Optional) Filter returning a list of SMS received to the specific reference. Default setting : All
filterStartDate	DateTime	(Optional) Filter returning a list of inbound fax received after the specified date. Format : “2017-07-08T12:54:40.460Z”
filterEndDate	DateTime	(Optional) Filter returning a list of inbound fax received before the specified date. Format : “2017-07-08T12:54:40.460Z”
sortField	int	(Optional) Sort the data by the field returned. Values : 0 = Job, 1 = Job item, 2 = received date, 3 = From address, 4 = To address
sortDirection	int	(Optional) Type of sorting. Values : 1 = Ascending, 2 = Descending (default)

Get received SMS

GET /api/V1/InboundSMS HTTP/1.1
Host: api.odyssey-services.fr
Content-Type: application/json
Authorization: Basic NjAzMDAuYXxxxxxx

Filter by PageSize,index and Job

GET /api/V1/InboundSms?pageIndex=1&amp;pageSize=5&amp;filterJob=48374xxx HTTP/1.1
Host: api.odyssey-services.fr
Content-Type: application/json
Authorization: Basic NTUxMDIuZxxxxxx

Filter by From and To

GET /api/V1/InboundSms?filterTo=INBOUNDSMS_55xxx&amp;filterFrom=336xxxxxx HTTP/1.1
Host: api.odyssey-services.fr
Content-Type: application/json
Authorization: Basic NTUxMDIuxxxxxxxxxx

Filter by Date and sort

GET /api/V1/InboundSms?FilterStartDate=2017-07-08T12:54:40.460Z&amp;FilterEndDate=2017-07-24T12:54:40.460Z&amp;sortField=0&amp;sortDirection=2 HTTP/1.1
Host: api.odyssey-services.fr
Content-Type: application/json
Authorization: Basic NTUxMDIuxxxxxxx

Successful Response

Parameter	Type	Description
*PageIndex*	Int	Page number currently returned.
PageSize	Int	Number of received SMS per page.
TotalCount	Int	Total Number of SMS that can be returned.
TotalPageCount	Int	Total of page that can be returned.
Ressources	InboundSMS Object	List of InboundSMS Object, returning the received SMS details, See below for structure the details.
HasPreviousPage	boolean	True: This is the first page you can display. False: you can display the previous page.
HasNextPage	Boolean	True: you can display the next page. False: This is the last page you can display.

The Ressources are a list of InboundSMS object.

InboundSMS Structure reference

Parameter	Type	Description
JobItemNumber	Int	Item position in the associated job, depend of type of reception.
JobNumber	Int	Job number associated, depend of type of reception.
ReceivedDate	DateTime	Date and time of reception. Example : 2017-07-14T18:25:23.88
ToAddress	String	Reference of the reception number used.
FromAddress	String	Phone number of the recipient.
Message	String	Message received.
CustomerNumber	Int	The customer number attached to the sms answer.

Successful Response

{
    "PageIndex": 1,
    "PageSize": 2,
    "TotalCount": 16,
    "TotalPageCount": 8,
    "Resources": [
        {
            "JobItemNumber": 1,
            "JobNumber": 48374XXX,
            "ReceivedDate": "2017-07-14T18:25:23.88",
            "ToAddress": "INBOUNDSMS_55XXX",
            "FromAddress": "336xx00xx00",
            "Message": "My message 1",
            "CustomerNumber": 55XXX
        },
        {
            "JobItemNumber": 1,
            "JobNumber": 48374XXX,
            "ReceivedDate": "2017-07-15T16:26:04.17",
            "ToAddress": "INBOUNDSMS_55XXX",
            "FromAddress": "336xx00xx11",
            "Message": "My message 2",
            "CustomerNumber": 55XXX
        }
    ],
    "HasPreviousPage": false,
    "HasNextPage": true
}