getFlow¶

Request Method: GET

Description: Retrieves details of a Call/SMS/Email Flow

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

The following parameters can be sent in the querystring

Parameter	Description	Default Value	Data Type	Mandatory
v	API version to use		INTEGER	YES
flow_name	The Flow title you want to retrieve the details from		STRING	YES
flow_type	The type of the Flow you want to retrieve the details from. Can be Call, SMS or Email		STRING	YES

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	Flow Doesn't exist	Correct the flow_name and flow_type parameters
500	Internal Server Error	Retry later

Success Call Flow Result¶

<?xml version="1.0" encoding="utf-8"?>
<response>
    <callFlow name="Call Agent" notes="Will Call the agent, can be used for every agent in my account.">
        <call id="call_1" label="Call" destinationPhoneNumber="?" destinationContactId="?" record="true" sendCallAlert="NONE"></call>
    </callFlow>
</response>

Please refer to the Callflow XML documentation for the element details.

Success SMS Flow Result¶

<?xml version="1.0" encoding="utf-8"?>
<response>
    <smsFlow name="SMS Agent" notes="Will forward the SMS to the agent.">
        <sendSms id="1" label="Send SMS" from="$_smsOrigin" smsTemplateName="Default SMS Forward" destinationContactId="?" destinationPhoneNumber="?" />
    </smsFlow>
</response>

Please refer to the SMS Flow XML documentation for the details.