getFlows¶

Request Method: GET

Description: Retrieves a list of a Call/SMS/Email Flows

URL: https://api.iovox.com:444/Flow?v=3&method=getFlows

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 and suffix with ASC or DESC for ascending or descending respectively. For example, "c_DESC" will return results ordered by created with the most recent first	c_DESC	STRING	NO
req_fields	Comma separated list of abbreviated fields to return in response.tna=template_name, tno=template_notes, tt=template_type, c=created, a=advanced	tna,tno,tt,c,a	STRING	NO
template_name	Returns the Call Flow under the given Call Flow title		STRING	NO
template_type	Specifying DEFAULT returns only default Call Flows, CUSTOM returns only those created by the account holder or ALL returns all Call Flows	ALL	STRING	NO
advanced	Specify YES to return only advanced templates		STRING	NO
output	Specifying XML or JSON returns data in XML or JSON format	XML	STRING	NO
flow_type	The type of Flows you want to retrieve. Can be SMS, Call or Email. Default all types are returned.		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	Template Type Invalid	Correct template_type parameter
400	Advanced Invalid	Correct advanced parameter
400	Required Fields Invalid: fieldone,fieldtwo	Correct or remove fieldone and fieldtwo
400	Order Field Invalid	Check the allowed abbreviation fields in the documentation
400	Order Direction Invalid	Correct the direction in the order.
400	Output Type Invalid	Correct output parameter
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>6</total_results>
    <results>
        <result>
            <template_name>Call</template_name>
            <template_notes>Forward call to contact</template_notes>
            <template_type>DEFAULT</template_type>
            <flow_type>call</flow_type>
            <created>2012-01-19 15:12:11</created>
            <advanced>NO</advanced>
        </result>
        <result>
            <template_name>Call and Whisper to Caller</template_name>
            <template_notes>Forward and play whisper to caller</template_notes>
            <template_type>DEFAULT</template_type>
            <flow_type>call</flow_type>
            <created>2012-01-19 15:12:31</created>
            <advanced>NO</advanced>
        </result>
        <result>
            <template_name>Call and Whisper to Called</template_name>
            <template_notes>Forward and play whisper to called</template_notes>
            <template_type>DEFAULT</template_type>
            <flow_type>call</flow_type>
            <created>2012-01-19 15:12:48</created>
            <advanced>NO</advanced>
        </result>
        <result>
            <template_name>Call Whisper Both</template_name>
            <template_notes>Forward and play whisper to both</template_notes>
            <template_type>DEFAULT</template_type>
            <flow_type>call</flow_type>
            <created>2012-01-19 15:13:03</created>
            <advanced>NO</advanced>
        </result>
        <result>
            <template_name>SMS</template_name>
            <template_notes>Forward SMS to Contact</template_notes>
            <template_type>DEFAULT</template_type>
            <flow_type>sms</flow_type>
            <created>2014-12-17 16:10:20</created>
            <advanced>NO</advanced>
        </result>
        <result>
            <template_name>Email</template_name>
            <template_notes>Forward Email to Contact</template_notes>
            <template_type>DEFAULT</template_type>
            <flow_type>email</flow_type>
            <created>2017-08-21 18:06:16</created>
            <advanced>YES</advanced>
        </result>
    </results>
</response>