Events and Methods
API generates events for situations like incoming call or hangup. You can listen to these events and trigger custom functions for your business needs.
Action | Event | Function | Button ID | Message |
|---|---|---|---|---|
Incoming Call | _IncomingCall | N/A |
| Calling number |
Show Ringing | _ShowRinging | N/A |
| Calling number |
Answer Incoming Call | _Answer | answer_click | agent-softphone-answer | true / false |
Auto Answer Incoming Call | _AutoAnswer | answer_click |
| true / false |
Reject | _Reject | reject_click |
| true / false |
Place Call | _Dial | dial_click | agent-softphone-dial | Called number |
Hangup | _Hangup | hangup_click | agent-softphone-hangup | hangup |
Hold | _Hold | hold-click | agent-softphone-hold | hold |
Talking | _Hold | CallSetActive(line-id) |
| talking |
Mute / Unmute | _MuteMicToggle | MuteMicToggle | agent-softphone-mute | true / false |
Call connected | _Accept | N/A |
| accept |
Agent status change | _AgentStatus | N/A |
| New status / Status could not be changed |
Connecting | _Connecting | N/A |
| true |
Connected | _Connected | N/A |
| true |
Disconnected | _Disconnected | N/A |
| true |
Registered | _Registered | N/A |
| true |
Unregistered | _Unregistered | N/A |
| true |
RegistrationFailed | _RegistrationFailed | N/A |
| true |