Standard Plivo Hangup Causes
Plivo Hangup Causes can be used to identify why & how a call was disconnected. This document contains the list of standard Plivo hangup causes & sources.
Call Hangup Cause and Hangup Source information is part of Plivo Call Detail Record (CDR). CDRs can be retrieved via API or viewed on the Plivo console.
Hangup information is also included in callback requests sent on call hangup.
- For outbound API calls, the hangup information is included in the payload sent to the hangup_url specified in the Make Call API request.
- For incoming calls, this information is included in the payload sent to the hangup_url specified for the associated Plivo Application.
- For calls initiated using <Dial> XML, this information is included in the payload of DialHangup events sent to the Dial callbackUrl.
List of Hangup Sources
Below is a list of all Hangup Sources:
| Hangup Source | Description |
| Caller | The call was hung up by the caller. |
| Callee | The call was hung up by the individual who was dialed. |
| Plivo | Plivo initiated the hangup. There are several possible scenarios that can result in Plivo initiating the call hangup. Please go though the Hangup Causes list below for more details. |
| Carrier | The hangup signal was received from the remote carrier. |
| API Request | The call was terminated via the Hangup or Cancel Call API request. |
| Answer XML | The call was hung up using the <Hangup> XML element. |
| Error | An error condition led to the call being terminated. |
| Unknown | The source of the hangup could not be resolved. |
List of Hangup Causes
Below is a list of all Hangup Causes:
| Hangup Cause | Hangup Cause Code | Description | Possible Hangup Sources | Applicable to Call Types | Possible Call States At Hangup |
| Unknown | 0 | The exact reason for hangup could not be resolved. There is a known bug that Hangup Reason is set to Unknown for calls hung up using the DELETE All Calls API. | Unknown | Outbound and Inbound | Any |
| Cancelled | 1000 | The call was canceled using the Hangup Call API before it was answered. | API Request | Outbound and Inbound | Initiated Ringing |
| Cancelled (Out Of Credits) | 1010 | The call was auto-canceled because the account had run out of credits. | Plivo | Outbound and Inbound | Any |
| Invalid Destination Address | 2000 | The destination number or SIP endpoint was found to be invalid. Please confirm if the destination number is valid and has been specified in E.164 format (eg. +12292442099 or 12292442099). | Plivo Carrier | Outbound Calls | Initiated |
| Destination Out Of Service | 2010 | The destination number is currently unavailable or out of service. | Carrier | Outbound Calls | Initiated |
| Endpoint Not Registered | 2020 | The destination SIP endpoint could not be reached since it was found to be unregistered. | Plivo | Outbound Calls (SIP Calls) | Initiated |
| Destination Country Barred | 2030 | The call was barred as the destination country has been disabled for the Account/Sub-Account that initiated the call. Geo Permissions for your account can be managed from your Plivo console. | Plivo | Outbound | Pre-Initiation |
| Destination Number Barred | 2040 | The call was barred as calls to premium rate numbers have been disabled for the Account/Sub-Account that initiated the call. You can update your preferences with respect to premium number calling here. | Plivo | Outbound | Pre-Initiation |
| Loop Detected | 2060 | The outbound B-Leg call was barred because the call would have resulted in a call loop by re-dialing the A-Leg's To number. | Plivo | Outbound | Pre-Initiation |
| No Answer | 3000 | The call was not answered by the called party. | Plivo - If the destination is a Plivo SIP endpoint. Carrier - If the destination is a PSTN phone number or external SIP endpoint. | Outbound Calls | Ringing |
| Busy Line | 3010 | The call could not be established as a busy signal was received from the called party. | Plivo - If the destination is a Plivo SIP endpoint. Carrier - If the destination is a PSTN phone number or external SIP endpoint. | Outbound and Inbound | Initiated |
| Rejected | 3020 | The call was rejected by the callee. | Callee Answer XML - If an inbound call is reject using the <Hangup> XML element. | Outbound and Inbound | Initiated Ringing |
| Normal Hangup | 4000 | The call was terminated normally. | Caller Callee API Request - If the call was hung up using the Hangup API Answer XML - If the call was hung up using the <Hangup> XML element. | Outbound and Inbound | Ringing Answered |
| End Of XML Instructions | 4010 | The call was terminated as there were no more XML instructions to execute. This is a normal hangup reason for calls that are being controlled by their own XML. This includes A-Legs (outbound and inbound), and B-Legs that have been transferred to their own XML using the Transfer API. | Plivo | Outbound and Inbound | Answered |
| Network Error | 5000 | A network error resulted in the call being hung up. This is a generic error that covers fatal network conditions and signalling issues. Please contact Plivo Support if you encounter this error for your call flows. | Error | Outbound and Inbound | Any |
| Internal Error | 5010 | An error condition within the Plivo system resulted in the call being hung up. Please contact Plivo Support if you encounter this error for your call flows. | Error | Outbound and Inbound | Any |
| Routing Error | 5020 | The call could not be routed to the destination address. Please contact Plivo Support if you encounter this error for your call flows. | Error | Outbound and Inbound | Any |
| Scheduled Hangup | 6000 | The call was automaticaly terminated based on the max duration configured for the call. For API initiated calls, max call duration can be configured using the 'time_limit' request parameter. For calls initiated using the <Dial> XML element, max call duration can be configured using the 'timeLimit' attribute. This property defaults to 4 hours when not specified. | Plivo | Outbound Calls | Answered |
| Ring Timeout Reached | 6010 | The call was automatically terminated as it was not answered within the ring timeout value configured for the call. For API initiated calls, max ring time can be configured using the 'ring_timeout' request parameter. This property defaults to 120 seconds when not specified. For calls initiated using the <Dial> XML element, max ring time can be configured using the 'timeout' attribute. This property defaults to 120 seconds when not specified. | Plivo | Outbound Calls | Initiated Ringing |
| Media Timeout | 6020 | Plivo terminated the call because it did not receive any media packets from the remote carrier or endpoint for a period of 60 seconds. Nonreceipt of media packets for that long a period indicates that the call connection with the remote party has been lost. | Plivo | Outbound and Inbound | Answered |
| Error Reaching Answer URL | 7011 | A non 2XX HTTP response was encountered while fetching XML instructions from the specified Answer URL. | Error | Outbound and Inbound | Initiated Ringing |
| Error Reaching Action URL | 7012 | A non 2XX HTTP response was encountered while fetching XML instructions from the specified Action URL. Note that a non 2XX response results in call termination only if the 'redirect' attribute has been set to 'True'. | Error | Outbound and Inbound | Answered |
| Error Reaching Transfer URL | 7013 | A non 2XX HTTP response was encountered while fetching XML instructions from the specified Transfer URL. | Error | Outbound and Inbound | Ringing Answered |
| Error Reaching Redirect URL | 7014 | A non 2XX HTTP response was encountered while fetching XML instructions from the specified Redirect URL. | Error | Outbound and Inbound | Ringing Answered |
| Invalid Action URL | 7022 | The Action URL specified for the XML element is not a valid URL. Please ensure the URL begins with HTTP or HTTPS. Note that an invalid Action URL results in call termination only if the 'redirect' attribute has been set to 'True'. | Error | Outbound and Inbound | Answered |
| Invalid Transfer URL | 7023 | The URL specified in the Transfer API request is not a valid URL. Please ensure the URL begins with HTTP or HTTPS. | Error | Outbound and Inbound | Ringing Answered |
| Invalid Redirect URL | 7024 | The URL specified in the <Redirect> XML element is not a valid URL. Please ensure the URL begins with HTTP or HTTPS. | Error | Outbound and Inbound | Ringing Answered |
| Invalid Method For Action URL | 7032 | An unsupported HTTP method was specified for the Action URL. Only GET and POST methods are supported. | Error | Outbound and Inbound | Answered |
| Invalid Method For Transfer URL | 7033 | An unsupported HTTP method was specified for the Transfer URL. Only GET and POST methods are supported. | Error | Outbound and Inbound | Ringing Answered |
| Invalid Method For Redirect URL | 7034 | An unsupported HTTP method was specified for the Redirect URL. Only GET and POST methods are supported. | Error | Outbound and Inbound | Ringing Answered |
| Invalid Answer XML | 8011 | The XML returned by the Answer URL is not a valid Plivo XML. View debug logs for the call on your Plivo console for more information. | Error | Outbound and Inbound | Ringing Answered |
| Invalid Action XML | 8012 | The XML returned by the Action URL is not a valid Plivo XML. View debug logs for the call on your Plivo console for more information. Note that an invalid XML results in call termination only if the 'redirect' attribute has been set to 'True'. | Error | Outbound and Inbound | Answered |
| Invalid Transfer XML | 8013 | The XML returned by the Transfer URL is not a valid Plivo XML. View debug logs for the call on your Plivo console for more information. | Error | Outbound and Inbound | Ringing Answered |
| Invalid Redirect XML | 8014 | The XML returned by the Redirect URL is not a valid Plivo XML. View debug logs for the call on your Plivo console for more information. | Error | Outbound and Inbound | Ringing Answered |
| Lost Race | 9000 | The call was hung up by Plivo because another B-Leg that was dialed in parallel accepted the call first. This is a common hang up reason in simultaneous dial scenarios where multiple destinations are tried in parallel, the first person to accept the call is connected with the A-Leg, and other calls are immediately terminated. | Plivo | Outbound (Dial XML) | Any |
| Machine Detected | 9100 | It was detected that the call was answered by an answering machine. This hangup reason is possible only for API initiated calls having the machine_detection request parameter set to 'hangup'. | API Request | Outbound (API Calls) | Answered |
Did you find this page helpful?
Help us improve :)
× ![]()