timeout.md

{% method %}

CallTimeout Event

Bandwidth API sends this message to the application when the call is not answered until the specified timeout.

Properties

Property	Description
eventType	The event type, value is timeout.
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]).
time	Date/time of event. Timestamp follows the ISO8601 format (UTC).

{% common %}

Example JSON

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

Example timeout

POST http://[External server URL]

{
   "eventType":"timeout",
   "from":"+12096626728",
   "to":"+15756162105",
   "callId":"{callId}",
   "callUri":"https://api.catapult.inetwork.com/v1/users/{userId}/calls/{callId}",
   "time":"2013-11-06T14:25:58.857Z"
}

{% endmethod %}