getSmsHistory¶

Request Method: GET

Description: Retrieves all SMS history data

URL: https://api.iovox.com:444/SMS?v=3&method=getSmsHistory

The following parameters can be sent in the querystring

Parameter	Description	Default Value	Data Type	Mandatory
v	API version to use		INTEGER	YES
page	The page number to return. Use together with limit to achieve paginated results	1	INTEGER	NO
limit	Determines how many results to return. Use together with page to achieve paginated results. Maximum here is 20000	20000	INTEGER	NO
req_fields	Comma separated list of abbreviated fields to return in response. s=Sender, d=Destination, t=Sent time, m=Message	s,d,t,m	STRING	NO
order	Determines which field to order the output result by. Use a field name from the req_fields list and suffix with ASC or DESC for ascending or descending respectively. For example, "t_DESC" will return results ordered by Sent time with the most recent first	s_ASC	STRING	NO
sender	Returns results only for the specified sender account		STRING	NO
destination	Returns results only for the specified destination account		STRING	NO
output	Specifying XML or JSON returns data in XML or JSON format	XML	STRING	NO

Result¶

Error Result¶

HTTP Code	Error String	Resolution
400	API Version Empty	Add a value for the v parameter in the query string
400	API Version Invalid	Correct v parameter
400	Request Method must be GET. x attempted	Switch request method x to GET
400	Page Number not an integer	Remove non-numerics from page
400	Limit not an integer	Remove non-numerics from limit
400	Limit must be between 1 and 20000	Correct the limit parameter
400	Output Type Invalid	Correct output parameter
500	Internal Server Error	Retry later

Success Result¶

<?xml  version="1.0"  encoding="UTF-8"?>

<response httpStatus="200">
    <current_page>1</current_page>
    <total_pages>1</total_pages>
    <total_results>4</total_results>
    <results>
        <result>
            <sender>IOVOX</sender>
            <destination>447400000000</destination>
            <time_sent>2012-11-28 11:25:26</time_sent>
            <message>You have missed a call</message>
        </result>
        <result>
            <sender>IOVOX</sender>
            <destination>447400000000</destination>
            <time_sent>2012-11-28 11:26:11</time_sent>
            <message>You have missed a call</message>
        </result>
        <result>
            <sender>IOVOX</sender>
            <destination>447411111111</destination>
            <time_sent>2012-11-28 11:26:11</time_sent>
            <message>You have missed a call</message>
        </result>
        <result>
            <sender>IOVOX</sender>
            <destination>447422222222</destination>
            <time_sent>2012-11-28 11:26:11</time_sent>
            <message>You have missed a call</message>
        </result>
    </results>
</response>