Flow Status
Sr. No | Status Name | Type of Record | Description |
1 | PHONE_NOT_WHITELISTED | Invalid Record | This status will appear when the flow is in testing state and the number which is used for testing is not whitelisted. |
2 | INTERNATIONAL_CALLS_DISABLED | Invalid Record | This status will appear when the phone number through which the call is offered is international and the international call facility is disabled for the account |
3 | INVALID_CONTACT_NUMBER | Invalid Record | This status will appear when the phone number received in the request does not fulfil the regex criteria of phone number |
4 | UNPROCESSED | Invalid Record | This status will appear when the number is loaded but is not processed |
5 | IN_PROGRESS | Valid Record | This status will appear when the number is processed and the execution is in progress state |
6 | REJECTED | Invalid Record | This status will appear in case any unknown error takes place while API processing |
7 | INVALID_CALL_START_TIME | Invalid Record | This status will appear when the provided starttime mentioned in the outbound request is in the past |
8 | COMPLETED | Valid Record | This status will appear when the execution of the call is completed end to end |
9 | PARTIAL_COMPLETE | Valid Record | This status will come if flow is stopped in between by the user (for outbound ). If agent disconnected then partial completed (for dialer) |
10 | REATTEMPT_SCHEDULED | Valid Record | This status will appear if the call is not picked up by customer and reattempt is scheduled |
11 | SCHEDULED | Valid Record | This status will appear when the the number is loaded and the start date is in future |
12 | NCPR_CHECK_FAILED | NCPR Scrubbed | This status will appear when the phone number uploaded is in DND number list and the outbound flow is marketing (also the number is not whitelisted) |
13 | FAILURE | Invalid Record | This status will appear when there is any kind of failure in the flow execution |
14 | MASK_ALLOCATED | Invalid Record | This status will appear in the Masking number API, if a Masking number is successfully allocated |
15 | MASK_NOT_AVAILABLE | Invalid Record | This status will appear in the Masking number API, if a Masking number is not allocated |
16 | INVALID_VALIDITY | Invalid Record | This status will appear in the Masking number API, provided validity is invalid |
17 | REQUIRE_MASKED_NUMBER | Invalid Record | This status will appear in the Masking number API, the number to be mask is not provided |
18 | SHORT_HANGUP | Invalid Record | This status will appear when in the flow execution, short hang up takes place that is the call is answered, followed by immediate hangup |
19 | PHONE_BLACKLISTED | Invalid Record | This status will appear when the phone number is in the blacklist |
20 | INVALID_CALL_START_TIME_FORMAT | Invalid Record | This status will appear when the provided starttime mentioned in the outbound request is in the invalid format |
21 | PAUSE | Invalid Record | This status will appear when the loaded flow execution is paused |
22 | RESUME | ||
23 | MAX_CAPACITY_REACHED | Invalid Record | |
24 | INSUFFICIENT_BALANCE | Invalid Record | This status will appear when the there is no sufficient balance in the account to initiate a call |
25 | ACCOUNT_VALIDITY_EXPIRED | Invalid Record | This status will appear when the validity of the account is expired |
27 | AGENT_FAILURE | Invalid Record | This status is for Dialer flows, when all the agent reattempts are exhausted and still the agent has not picked up the call |
28 | AGENT_REATTEMPT_SCHEDULED | Invalid Record | This status is for Dialer flows, when the agent has not picked up the call and the call is rescheduled |
29 | CUSTOMER_FAILURE | Invalid Record | This status is for Dialer flows, when all the customer reattempts are exhausted and still the customer has not picked up the call |
30 | CUSTOMER_REATTEMPT_SCHEDULED | Invalid Record | This status is for Dialer flows, when the customer has not picked up the call and the call is rescheduled |
31 | INVALID_FLOW_VARIABLE_VALIDATION_TYPE | ||
32 | FLOW_VARIABLE_CRITERIA_UNDEFINED | ||
33 | FLOW_VARIABLE_CONTAINS_CRITERIA_FAILED | Invalid Record | This status will appear when the use has configured some flow variable validations in the flow and the value received in the outbound request does not satisfy ‘contains’ criteria |
34 | FLOW_VARIABLE_DOES_NOT_CONTAINS_CRITERIA_FAILED | Invalid Record | This status will appear when the use has configured some flow variable validations in the flow and the value received in the outbound request does not satisfy ‘does not contains’ criteria |
35 | FLOW_VARIABLE_LIST_CRITERIA_FAILED | Invalid Record | This status will appear when the use has configured some flow variable validations in the flow and the value received in the outbound request does not satisfy ‘list’ criteria |
36 | FLOW_VARIABLE_REGEX_CRITERIA_FAILED | Invalid Record | This status will appear when the use has configured some flow variable validations in the flow and the value received in the outbound request does not satisfy ‘regex’ criteria |
37 | FLOW_VARIABLE_LENGTH_CRITERIA_FAILED | Invalid Record | This status will appear when the use has configured some flow variable validations in the flow and the value received in the outbound request does not satisfy ‘length’ criteria |
38 | FLOW_VARIABLE_EMAIL_VALIDATION_FAILED | Invalid Record | This status will appear when the use has configured some flow variable validations in the flow and the value received in the outbound request does not satisfy ‘email validation’ criteria |
39 | FLOW_VARIABLE_URL_CRITERIA_FAILED | Invalid Record | This status will appear when the use has configured some flow variable validations in the flow and the value received in the outbound request does not satisfy ‘URL’ criteria |
40 | FLOW_VARIABLE_VALIDATION_FAILED | Invalid Record | This status will appear when the use has configured some flow variable validations in the flow and the value received in the outbound request does not satisfy validation criteria |
Call Connection Status
There are two (or more) possible ‘legs’ in a call. Suppose you have an inbound call on which customer calls, which in turn will make an outbound call to the agent. In this case, the first call-leg is the one with the customer, while the second call leg is one with the agent.
First Leg Connection Codes
Sr. No | Call Connection Status | Description |
---|---|---|
1 | Connected | This status is obtained from when the call was connected with the agent/customer |
2 | Busy | This status is obtained from the operator’s end, when the customer to which the call is initiated is busy with other |
3 | Congestion | .No circuit/channel available |
4 | Hung Up | This status is obtained from the operator’s end, when the customer has hanged up the call |
5 | Ring Timeout | This status is obtained from the operator’s end, when the customer has not picked up the call and there is ring timeout has happened |
6 | Failed | This status is obtained in following two scenarios -
|
7 | Channel Busy | This status is obtained when all the channels are busy from our end and the calls are not getting initiated |
8 | User Busy | This status is obtained when the user is busy with another call |
9 | User Not Answered | This status is obtained when the user has not answered the call |
10 | Operator Congestion | This status is obtained from the operator’s end, when there is congestion of channels from their end |
11 | No User Responding | Couldn't find the user in time. The server could not produce a response within a suitable amount of time, for example, if it could not determine the location of the user in time. The client MAY repeat the request without modifications at any later time. |
12 | Unallocated Number | The server has definitive information that the user does not exist at the domain specified in the Request-URI |
13 | User Rejected | This status is obtained from the operator’s end, when the user has cancelled/rejected the call |
14 | Invalid Number | This status is obtained when the phone number is not in the correct regex expression of phone number |
15 | Temporary Failure | Temporary failure |
16 | Channel Unavailable | This status is obtained when all the channels are occupied and no channel is available to make a call or This status is obtained when there is an issue at our end and the channel wasn't available to connect |
17 | Cancel | This status is received when the first party (the caller) has disconnected the call before the second party have answered the call. Scenario example with 1st Party → 2nd Party:
|
SMS Status
Sr. No | SMS Status | Description |
---|---|---|
1 | DELIVERED | This status is obtained, when the SMS is delivered to the customer successfully. |
2 | EXPIRED | This status can be obtained in any of the two scenarios -
|
3 | FAILED | This status can be obtained in any of the two scenarios -
|
4 | INVALID_NUMBER | When any Phone number is not satisfying regex criteria of mobile number. |
5 | REJECTED | This status is received from the operator's end. |
6 | SENT_TO_QUEUE | This status can be obtained in any of the two scenarios -
|
7 | UNDELIVERED | This status is received from the operator's end. |
8 | OTHER | Different operators have their different status so whenever any miscellaneous (other status from the mentioned |
Email Status
Sr. No | Email Status | Description |
---|---|---|
1 | Success | This status is obtained when the Email is successfully sent |
2 | Delivered | This status is obtained when the Email is successfully delivered |
3 | Failure | This status is obtained when the Email is failed to sent due to any reason |
4 | Empty Email List | This status is obtained when there are no recipients in the Email |
5 | Invalid Data | This status is obtained when there is any invalid data in any parameter of the Email |
6 | Invalid From Email | This status is obtained when the ‘from recipient’ is invalid (does not follow the standard Email Format) |
7 | Invalid To Email | This status is obtained when the ‘to recipient’ is invalid (does not follow the standard Email Format) |
8 | Sent | This status is obtained when the Email is sent from the system |
9 | Bounced | This status is obtained when the Email message cannot be delivered to an email address |
10 | Rejected | |
11 | Complaint | |
12 | Opened | This status is obtained when the Email is opened by the recipient |
13 | Clicked | This status is obtained when the user has clicked on the link present in the Email |
Add Comment