getEmailHistory¶

Request Method: GET

Description: Collects all call data

URL: https://api.iovox.com:444/Emails?v=3&method=getEmailHistory

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
order	Determines which field to order the output result by. Use a field name from the req_fields list (exclusive of cat_v, cat_lbl and cat_id) and suffix with ASC or DESC for ascending or descending respectively. For example, "cs_DESC" will return results ordered by call_start with the most recent first.	cs_DESC	STRING	NO
sdt	Returns all emails received since a given date. Start date format is YYYY-MM-DD HH:MM:SS with hours, minutes and seconds being optional. Hours, minutes and seconds defaults to 00:00:00	1st day of current month at 00:00:00	DATETIME	NO
edt	Returns all calls received before a given date. End date format is YYYY-MM-DD HH:MM:SS with hours, minutes and seconds being optional. Hours, minutes and seconds defaults to 23:59:59	Current day at 23:59:59	DATETIME	NO
id	Returns the email with the specified Email ID		STRING	NO
node_id	Returns all emails for the specified Node ID		STRING	NO
node_name	Returns all emails for the specified Node Name		STRING	NO
node_type	Returns all emails for the specified Node Type		STRING	NO
link_id	Returns all emails for the specified Link ID		STRING	NO
link_name	Returns all emails for the specified Link Name		STRING	NO
link_type	Returns all emails for the specified Link Type		STRING	NO
from	Returns all emails for the specified From		STRING	NO
to	Returns all emails for the specified To		STRING	NO
req_fields	Comma separated list of abbreviated fields to return in response. id=id, date=date,nid=Node Id,nn=Node Name, nt=Node Type, lid=Link id, ln=Link Name, lt=Link Type, from=From, to=To, disp=disposition, rdisp=read_disposition	id,nid,nn, lid,ln,disp, rdisp,from,to	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	Order Field Invalid	Check the allowed abbreviation fields in the documentation
400	Order Direction Invalid	Correct the direction in the order
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	Start Date Invalid	Correct sdt parameter
400	End Date Invalid	Correct edt parameter
400	Required Fields Invalid: fieldone, fieldtwo	Correct or remove fieldone and fieldtwo
500	Internal Server Error	Retry later

Success Result¶

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <current_page>1</current_page>
    <total_pages>1</total_pages>
    <total_results>75</total_results>
    <results>
        <result>
            <id>7cabcd-aaa</id>
            <node_name>NODE NAME A</node_name>
            <link_name>LINK NAME A</link_name>
            <disposition>sent</disposition>
            <read_disposition>unread</read_disposition>
            <date>2020-02-13 13:45:35</date>
            <from>noreply@iovox.com</from>
            <to>destination-a@domain-a.com</to>
            <node_id>NODE ID A</node_id>
            <link_id>LINK ID A</link_id>
        </result>
        <result>
            <id>7cabcd-bbb</id>
            <node_name>NODE NAME B</node_name>
            <link_name>LINK NAME B</link_name>
            <disposition>sent</disposition>
            <read_disposition>read</read_disposition>
            <date>2020-02-13 13:56:10</date>
            <from>noreply@iovox.com</from>
            <to>destination-a@domain-a.com</to>
            <node_id>NODE ID B</node_id>
            <link_id>LINK ID B</link_id>
        </result>
        <result>
        ....
        </result>
    </results>
</response>