createFlow¶
Request Method: POST
Description: Creates a Call/SMS/Email Flow according to the set of Call/SMS/Email Flow Rules.
URL: https://api.iovox.com:444/Flow?v=3&method=createFlow
The following parameters can be sent in the querystring
| Parameter | Description | Default Value | Data Type | Mandatory |
|---|---|---|---|---|
| v | API version to use | INTEGER | YES |
Request Example¶
Payload Call Flow¶
<?xml version="1.0" encoding="utf-8"?>
<request>
<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" />
</callFlow>
</request>
Please refer to the Callflow XML documentation for the
Payload SMS Flow¶
<?xml version="1.0" encoding="utf-8"?>
<request>
<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>
</request>
Please refer to the SMS Flow XML documentation for the
Description¶
| Node Name | Description | Default Value | Data Type | Mandatory |
| [call/sms/email]Flow | The Flow you want to create. | STRING | YES | |
| [call/sms/email]Flow > name | The title you want to use for your Flow. This must be unique throughout your whole account. | STRING | YES | |
| [call/sms/email]Flow > notes | Notes for your Flow. | 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 POST. x attempted | Switch request method x to POST | |||
| 400 | XML Empty | Add xml to the request body | |||
| 400 | XML parse error. x at line y, column z | Correct XML at point x on line y, column z | |||
| 400 | Request Empty | Add one Call Flow to the request | |||
| 400 | There are no Rules in this Template | Add at least one Call Flow Rule to the Call Flow | |||
| 400 | CallFlow Name already exists | Change the name of the Call Flow | |||
| 400 | CallFlow Name Empty | Add name field for CallFlow | |||
| 400 | CallFlow Name too long | Shorten the name of the Call Flow | |||
| 400 | Rule Label Empty | Add name for Rule label | |||
| 400 | Rule ID Empty | Add id for Rule | |||
| 400 | Message empty | Add message for Rule | |||
| 400 | destinationPhoneNumber Empty | Add phone number for destinationPhoneNumber | |||
| 400 | destinationContactId Empty | Add id for destinationContactId | |||
| 400 | destinationContactName Empty | Add name for destinationContactName | |||
| 400 | Contact cannot have Variable and Fix details at the same time | Set all details to either fixed or variable | |||
| 400 | Destination Contact does not exist | Fix destinationContactId | |||
| 400 | You need to select a Contact | Add destinationContactId | |||
| 400 | destinationContactName and destinationContactId are not allowed together in Call | Remove either destinationContactName or destinationContactId | |||
| 500 | Internal Server Error | Retry later | |||