Inbound_call

Sent when an inbound call is routed to an extension, that is when the agent's phone starts ringing. It does not mean the call was answered.

This is where a screen pop scenario is triggered: listen to this event if you want to bring up the customer card before the agent picks up the phone.

Sample body

scenario: Inbound_call

{
  "pbx_num": "8501234567",
  "unique_id": "sip1-1767225600.10001",
  "internal_num": "100",
  "incoming_number": "8501234567",
  "scenario": "Inbound_call",
  "customer_num": "05551112233",
  "timestamp": "1767225614000"
}

Send this body to your own address

The sample body above is sent to the address below as a POST request. The request goes from your browser, so the response cannot be read if the receiving endpoint sends no CORS header; the request itself still arrives. Use the cURL equivalent to try it from the server side.

cURL equivalent:

curl -X POST 'https://your-address.example/webhook' \
  -H 'Content-Type: application/json' \
  -d '{"pbx_num":"8501234567","unique_id":"sip1-1767225600.10001","internal_num":"100","incoming_number":"8501234567","scenario":"Inbound_call","customer_num":"05551112233","timestamp":"1767225614000"}'

Fields

Field	Type	Description
scenario	string	Always Inbound_call.
pbx_num	string	Your PBX number.
unique_id	string	Unique identifier of the call.
internal_num	string	The extension the call was routed to, the one that is ringing.
incoming_number	string	Your number that was dialed.
customer_num	string	Calling subscriber number.
timestamp	string	Event time (ms, Unix epoch).

Ringing is not answering

This event only reports that the call reached an extension. When the agent actually picks up, a separate Answer event is sent. Track the moment of answering from the Answer event.

If the call comes from a queue, you also receive the Queue event before this one. Calls that land directly on an extension produce no queue event.