Webhooks
The call of the webhook on the queue occurs when a certain event (event) happens after which a selected, created earlier scheme (flow) is called.
Event | Description | A queue type where is used | Fields that are transferred | ||
---|---|---|---|---|---|
Field | Type | Description | |||
Joined | a subscriber has entered the queue | all queues:
|
| string | channel (chat/call/task) |
| integer | dialer attempt identifier | |||
| string | call destination number | |||
| boolen | post-processing is enabled | |||
| string | agent session identifier (a call ID for the agent required to use API) | |||
| string | subscriber session identifier (a call ID for the subscriber required to use API) | |||
+ all variables which are transferred with a subscriber and in a queue |
|
| |||
Answered | an agent has answered the call |
|
| string | channel (chat/call/task) |
| integer | dialer attempt identifier | |||
| string | call destination number | |||
| boolen | post-processing is enabled | |||
| string | agent session identifier (a call ID for the agent required to use API) | |||
| string | subscriber session identifier (a call ID for the subscriber required to use API) | |||
| string | agent name | |||
| integer | agent identifier | |||
| integer | user identifier | |||
| string | agent extension number | |||
| string | subscriber name | |||
| integer | subscriber identifier | |||
| integer | attempt number | |||
| number | duration of the subscriber conversation - from the moment of answering till the current moment, or the end of the call | |||
| number | general call time - call duration from the beginning of dialing till the current moment, or the end of the call (post-processing is not taken into account) | |||
| string | automatic detection (AMD) result - HUMAN/MASHINE | |||
| number | the duration of the subscriber’s conversation with the agent - from the beginning of the subscriber’s connection with the agent till the end of the call | |||
+ all variables which are transferred with a subscriber and in a queue |
|
| |||
Offering | the call was distributed to an agent | all queues:
|
| string | channel (chat/call/task) |
| integer | dialer attempt identifier | |||
| string | call destination number | |||
| boolen | post-processing is enabled | |||
| string | agent session identifier (a call ID for the agent required to use API) | |||
| string | subscriber session identifier (a call ID for the subscriber required to use API) | |||
| string | agent name | |||
| integer | agent identifier | |||
| integer | user identifier | |||
| string | agent extension number | |||
| string | subscriber name | |||
| integer | subscriber identifier | |||
| integer | attempt number | |||
| number | duration of the subscriber conversation - from the moment of answering till the current moment, or the end of the call | |||
| number | general call time - call duration from the beginning of dialing till the current moment, or the end of the call (post-processing is not taken into account) | |||
| string | automatic detection (AMD) result - HUMAN/MASHINE | |||
| number | the duration of the subscriber’s conversation with the agent - from the beginning of the subscriber’s connection with the agent till the end of the call | |||
+ all variables which are transferred with a subscriber and in a queue |
|
| |||
Bridged | the connection between an agent and subscriber has occurred | all queues:
|
| string | channel (chat/call/task) |
| integer | dialer attempt identifier | |||
| string | call destination number | |||
| boolen | post-processing is enabled | |||
| string | agent session identifier (a call ID for the agent required to use API) | |||
| string | subscriber session identifier (a call ID for the subscriber required to use API) | |||
| string | agent name | |||
| integer | agent identifier | |||
| integer | user identifier | |||
| string | agent extension number | |||
| string | subscriber name | |||
| integer | subscriber identifier | |||
| integer | attempt number | |||
| number | duration of the subscriber conversation - from the moment of answering till the current moment, or the end of the call | |||
| number | general call time - call duration from the beginning of dialing till the current moment, or the end of the call (post-processing is not taken into account) | |||
| string | automatic detection (AMD) result - HUMAN/MASHINE | |||
| number | the duration of the subscriber’s conversation with the agent - from the beginning of the subscriber’s connection with the agent till the end of the call | |||
+ all variables which are transferred with a subscriber and in a queue |
|
| |||
Missed | an agent has not answered the call | queues with agent participation:
|
| string | channel (chat/call/task) |
| integer | dialer attempt identifier | |||
| string | call destination number | |||
| boolen | post-processing is enabled | |||
| string | agent session identifier (a call ID for the agent required to use API) | |||
| string | subscriber session identifier (a call ID for the subscriber required to use API) | |||
| string | agent name | |||
| integer | agent identifier | |||
| integer | user identifier | |||
| string | agent extension number | |||
| string | subscriber name | |||
| integer | subscriber identifier | |||
| integer | attempt number | |||
| number | duration of the subscriber conversation - from the moment of answering till the current moment, or the end of the call | |||
| number | general call time - call duration from the beginning of dialing till the current moment, or the end of the call (post-processing is not taken into account) | |||
| string | automatic detection (AMD) result - HUMAN/MASHINE | |||
+ all variables which are transferred with a subscriber and in a queue |
|
| |||
Leaving | a subcriber has left the queue | all queues:
|
| string | channel (chat/call/task) |
| integer | dialer attempt identifier | |||
| string | call destination number | |||
| boolen | post-processing is enabled | |||
| string | agent session identifier (a call ID for the agent required to use API) | |||
| string | subscriber session identifier (a call ID for the subscriber required to use API) | |||
| string | agent name | |||
| integer | agent identifier | |||
| integer | user identifier | |||
| string | agent extension number | |||
| string | subscriber name | |||
| integer | subscriber identifier | |||
| integer | attempt number | |||
| string | call result (success/cancel/abandoned) | |||
| number | duration of the subscriber conversation - from the moment of answering till the current moment, or the end of the call | |||
| number | general call time - call duration from the beginning of dialing till the current moment, or the end of the call (post-processing is not taken into account) | |||
| string | call ending reason (here you can view the variants of possible causes) | |||
| number | call termination code (here you can view possible variants, in the SIP answer column) | |||
| string | automatic detection (AMD) result - HUMAN/MASHINE | |||
| number | the duration of the subscriber’s conversation with the agent - from the beginning of the subscriber’s connection with the agent till the end of the call | |||
+ all variables which are transferred with a subscriber and in a queue |
|
| |||
Processing | an agent has entered the post-processing status | queues with agent participation:
|
| string | channel (chat/call/task) |
| integer | dialer attempt identifier | |||
| string | call destination number | |||
| boolen | post-processing is enabled | |||
| string | agent session identifier (a call ID for the agent required to use API) | |||
| string | subscriber session identifier (a call ID for the subscriber required to use API) | |||
| string | agent name | |||
| integer | agent identifier | |||
| integer | user identifier | |||
| string | agent extension number | |||
| string | subscriber name | |||
| integer | subscriber identifier | |||
| integer | attempt number | |||
| number | duration of the subscriber conversation - from the moment of answering till the current moment, or the end of the call | |||
| number | general call time - call duration from the beginning of dialing till the current moment, or the end of the call (post-processing is not taken into account) | |||
| string | call ending reason (here you can view the variants of possible causes) | |||
| number | call termination code (here you can view possible variants, in the SIP answer column) | |||
| string | automatic detection (AMD) result - HUMAN/MASHINE | |||
| number | the duration of the subscriber’s conversation with the agent - from the beginning of the subscriber’s connection with the agent till the end of the call | |||
+ all variables which are transferred with a subscriber and in a queue |
|
| |||
Active | similar to Answered |
Queue webhooks are configured in the admin panel on the Hooks tab in the Queues section.
To add a hook, you need to click the button