- Request Method: GET
- Description: Retrieves details of a Call Flow
- URL: https://api.iovox.com:444/CallFlow?v=3&method=getCallFlow
The following parameters can be sent in the querystring
Parameter | Description | Default Value | Data Type | Mandatory |
v | API version to use | INTEGER | YES | |
call_flow | The Call Flow title you want to retrieve the details from | 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 | Call Flow Doesn't exist | Correct Call Flow parameter |
500 | Internal Server Error | Retry later |
Success Result¶
Please refer to the Callflow XML documentation for the
<?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>