hangup.md

{% method %}

Hangup Event

Bandwidth API sends this message to the application when the call ends.

Properties

Property	Description
eventType	The event type, value is hangup.
callId	The call id associated with the event.
callUri	The complete URL of the call resource for this event.
from	The phone number or SIP address that made the call. Phone numbers are in E.164 format (e.g. +15555555555) -or- SIP addresses (e.g. [email protected]).
to	The phone number or SIP address that received the call. Phone numbers are in E.164 format (e.g. +15555555555) -or- SIP addresses (e.g. [email protected]).
cause	The cause of the hangup event, the values are one of causes below
time	Date/time of event. Timestamp follows the ISO8601 format (UTC).

Hangup Causes

Cause	Description
ORIGINATOR_CANCEL	Calling party disconnected before the call was answered
NORMAL_CLEARING	Normal hangup
USER_BUSY	Call could not be completed because user was busy
CALL_REJECTED	Call rejected
UNALLOCATED_NUMBER	Number could not be reached because it was unallocated
NO_ANSWER	Call not answered
NORMAL_TEMPORARY_FAILURE	Call is an international call and is not assigned an International Product
<OTHER>	Anything else indicates an internal error

{% common %}

Example JSON

{
  "eventType" : "string",
  "callId"    : "string",
  "callUri"   : "string",
  "from"      : "string",
  "to"        : "string",
  "cause"     : "string",
  "time"      : "date"
}

Example: Hangup Event

POST http://[External server URL]

{
   "eventType" : "hangup",
   "callId"    : "{callId}",
   "callUri"   : "https://api.catapult.inetwork.com/v1/users/{userId}/calls/{callId}",
   "from"      : "+13233326955",
   "to"        : "+13233326955",
   "cause"     : "NORMAL_CLEARING",
   "time"      : "2012-11-14T15:56:12.636Z"
}

{% endmethod %}