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 SourceDescription
    CallerThe call was hung up by the caller.
    CalleeThe call was hung up by the individual who was dialed.
    PlivoPlivo initiated the hangup. There are several possible scenarios that can result in Plivo initiating the call hangup. Please go through the Hangup Causes list below for more details.
    CarrierThe hangup signal was received from the remote carrier.
    API RequestThe call was terminated via the Hangup or Cancel Call API request.
    Answer XMLThe call was hung up using the <Hangup> XML element.
    ErrorAn error condition led to the call being terminated.
    UnknownThe source of the hangup could not be resolved.

    List of Hangup Causes

    Below is a list of all Hangup Causes:

    Hangup Code & Hangup CauseDescriptionPossible Hangup SourcesApplicable to Call TypesPossible Call States At Hangup
    0
    Unknown

    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.

    UnknownOutbound and InboundAny
    1000
    Cancelled
    The call was canceled using the Hangup Call API before it was answered.API RequestOutbound and Inbound

    Initiated

    Ringing

    1010
    Cancelled (Out Of Credits)
    The call was auto-canceled because the account had run out of credits.PlivoOutbound and InboundAny
    2000
    Invalid Destination Address

    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 CallsInitiated
    2010
    Destination Out Of Service
    The destination number is currently unavailable or out of service.CarrierOutbound CallsInitiated
    2020
    Endpoint Not Registered
    The destination SIP endpoint could not be reached since it was found to be unregistered or could not be reached. Confirm if the Endpoint was logged in and connected to internet. If the call was to an Endpoint connected through Plivo iOS or Android SDK, ensure that your application is correctly configured to receive VoIP push notifications form Plivo. Read more about debugging calls to Endpoints on iOS and Android SDKs here.PlivoOutbound Calls (SIP Calls)Initiated
    2030
    Destination Country Barred
    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.PlivoOutboundPre-Initiation
    2040
    Destination Number Barred
    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.PlivoOutboundPre-Initiation
    2060
    Loop Detected
    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.PlivoOutboundPre-Initiation
    3000
    No Answer
    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 CallsRinging
    3010
    Busy Line
    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 InboundInitiated
    3020
    Rejected
    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

    4000
    Normal Hangup
    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

    4010
    End Of XML Instructions

    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.

    PlivoOutbound and InboundAnswered
    5000
    Network Error
    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.ErrorOutbound and InboundAny
    5010
    Internal Error
    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.ErrorOutbound and InboundAny
    5020
    Routing Error
    The call could not be routed to the destination address. Please contact Plivo Support if you encounter this error for your call flows.ErrorOutbound and InboundAny
    6000
    Scheduled Hangup

    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.

    PlivoOutbound CallsAnswered
    6010
    Ring Timeout Reached

    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.

    PlivoOutbound Calls

    Initiated

    Ringing

    6020
    Media Timeout
    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.PlivoOutbound and InboundAnswered
    7011
    Error Reaching Answer URL
    A non 2XX HTTP response was encountered while fetching XML instructions from the specified Answer URL.ErrorOutbound and Inbound

    Initiated

    Ringing

    7012
    Error Reaching Action URL

    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'.

    ErrorOutbound and InboundAnswered
    7013
    Error Reaching Transfer URL
    A non 2XX HTTP response was encountered while fetching XML instructions from the specified Transfer URL.ErrorOutbound and Inbound

    Ringing

    Answered

    7014
    Error Reaching Redirect URL
    A non 2XX HTTP response was encountered while fetching XML instructions from the specified Redirect URL.ErrorOutbound and Inbound

    Ringing

    Answered

    7022
    Invalid Action URL
    </p>The Action URL specified for the XML element is not a valid URL. Please ensure the URL begins with HTTP or HTTPS.</p>

    Note that an invalid Action URL results in call termination only if the 'redirect' attribute has been set to 'True'.

    ErrorOutbound and InboundAnswered
    7023
    Invalid Transfer URL
    The URL specified in the Transfer API request is not a valid URL. Please ensure the URL begins with HTTP or HTTPS.ErrorOutbound and Inbound

    Ringing

    Answered

    7024
    Invalid Redirect URL
    The URL specified in the <Redirect> XML element is not a valid URL. Please ensure the URL begins with HTTP or HTTPS.ErrorOutbound and Inbound

    Ringing

    Answered

    7032
    Invalid Method For Action URL
    An unsupported HTTP method was specified for the Action URL. Only GET and POST methods are supported.ErrorOutbound and InboundAnswered
    7033
    Invalid Method For Transfer URL
    An unsupported HTTP method was specified for the Transfer URL. Only GET and POST methods are supported.ErrorOutbound and Inbound

    Ringing

    Answered

    7034
    Invalid Method For Redirect URL
    An unsupported HTTP method was specified for the Redirect URL. Only GET and POST methods are supported.ErrorOutbound and Inbound

    Ringing

    Answered

    8011
    Invalid Answer XML
    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.ErrorOutbound and Inbound

    Ringing

    Answered

    8012
    Invalid Action XML

    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'.

    ErrorOutbound and InboundAnswered
    8013
    Invalid Transfer XML
    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.ErrorOutbound and Inbound

    Ringing

    Answered

    8014
    Invalid Redirect XML
    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.ErrorOutbound and Inbound

    Ringing

    Answered

    9000
    Lost Race

    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.

    PlivoOutbound (Dial XML)Any
    9100
    Machine Detected

    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 RequestOutbound (API Calls)Answered