The Call Notify webhook sends a message from Voiso to the CRM to enable the CRM to open the contact information page.
This webhook is deprecated and no longer recommended for use in new integrations.
The Call Notify webhook sends a request to your CRM when a conversation starts, enabling a screen pop that displays the contact's information in the agent's browser.
You can configure the webhook to use either the GET
or POST
method.
Use Case
When an agent receives an inbound, outbound, or Dialer call—or performs a blind transfer—Voiso sends a webhook request to a specified CRM endpoint. This can be used to trigger a screen pop with contact details.
Activation
To use the Call Notify webhook:
- Navigate to Administration > System Settings.
- Enable the Call Notify feature.
- Configure the following fields:
Setting | Description |
---|---|
URL | The CRM endpoint URL that receives the webhook. |
Authorization token | (Optional) Token to include in the request header. |
Token prefix | (Optional) Prefix to prepend to the token in the header. |
HTTP request method | GET or POST (default is GET ). |
Trigger Conditions
The webhook is triggered when:
- An agent receives an inbound call.
- An agent or Dialer initiates an outbound call.
- An agent performs a blind transfer.
Payload
Example payload:
{
"callcenter": "client_name",
"type": "inbound",
"uuid": "07771c38-c159-4965-a878-be0162118b2b",
"agent_extension": "111",
"agent_name": "John Smith",
"agent_email": "[email protected]",
"agent_id": 1,
"queue_name": "Inbound queue name",
"script_name": "Inbound script name",
"call_start_time": 1630664544.661,
"agent_start_time": 1630664545.123,
"ani": "443336006114",
"dnis": "18885658889"
}
Example GET Query
https://crm.com/endpoint
?agent_email=john%40gmail.com
&agent_extension=111
&agent_id=1
&agent_name=John+Smith
&agent_start_time=1630664545.123
&ani=443336006114
&call_start_time=1630664544.661
&callcenter=client_name
&dnis=18885658889
&queue_name=Inbound+queue+name
&script_name=Inbound+script+name
&uuid=07771c38-c159-4965-a878-be0162118b2b
Parameters
Field | Type | Description |
---|---|---|
callcenter | string | Contact center name |
type | string | Call type: inbound, outbound, or dialer |
uuid | string | Unique call identifier |
agent_extension | string | Extension of the agent handling the call |
agent_name | string | Agent's full name |
agent_email | string | Agent’s email address |
agent_id | integer | Agent’s unique ID |
queue_name | string | Name of the queue handling the call |
script_name | string | Name of the call flow (referred to as "script") |
call_start_time | number | Timestamp when the call began (Unix format) |
agent_start_time | number | Timestamp when the agent joined the call |
ani | string | Originating number (caller ID) |
dnis | string | Destination number (number dialed) |
Transfers
If the call is transferred to another agent, a new request is sent with updated values for:
- agent_extension
- agent_email
- agent_id
- agent_start_time
All other parameters remain unchanged.