Webhooks

New Call

This webhook is sent when a new call is created on the platform, it is configured at the appplication level

Payload

The payload of this webhook request is an object.
call_sidstringRequired

a unique identifier for the call.

application_sidstringRequired

a unique identifier for the jambonz application controlling this call

account_sidstringRequired

a unique identifier for the jambonz account associated with the application

directionenumRequired

the direction of the call:

  • inbound - The call was originated outside jambonz
  • outbound - The call was originated by jambonz
Allowed values:
fromstringRequired

the calling party number

tostringRequired

the called party number

caller_idstringRequired

the caller name, if known

sip_statusdoubleRequired

the most recent sip status code received or generated for the call

call_statusenumRequired

current status of the call:

  • trying - a new incoming call has arrived or an outbound call has just been sent
  • ringing - a 180 Ringing response has been sent or received
  • early-media - an early media connection has been established prior to answering the call (183 Session Progress)
  • in-progress - call has been answered
  • completed - an answered call has ended
  • failed - a call attempt failed
  • busy - a call attempt failed because the called party returned a busy status
  • no-answer - a call attempt failed because it was not answered in time

Response

200
any
Return a 200 status to indicate that the data was received successfully.