(Created new topic from branched topic Documentation:ServicePattern:simplified-desktop-net-api-specification:APIEvents:5.1) |
(Updated via BpDeleteTranslateTags script) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | = API Events= | |
== evtApiUp == | == evtApiUp == | ||
''evtApiUp'' is sent when the API is successfully connected (or reconnected) to the softphone. | ''evtApiUp'' is sent when the API is successfully connected (or reconnected) to the softphone. | ||
| Line 6: | Line 6: | ||
=== Syntax === | === Syntax === | ||
| − | void evtApiUp(System.EventArgs args); | + | void evtApiUp(System.EventArgs args); |
| Line 15: | Line 15: | ||
=== Syntax === | === Syntax === | ||
| − | void evtApiDown(System.EventArgs args); | + | void evtApiDown(System.EventArgs args); |
| Line 26: | Line 26: | ||
=== Syntax === | === Syntax === | ||
| − | void evtCallDialing(DesktopControlAPI.CallArgs args); | + | void evtCallDialing(DesktopControlAPI.CallArgs args); |
| Line 35: | Line 35: | ||
=== Syntax === | === Syntax === | ||
| − | void evtCallOffered(DesktopControlAPI.CallArgs args); | + | void evtCallOffered(DesktopControlAPI.CallArgs args); |
| Line 44: | Line 44: | ||
=== Syntax === | === Syntax === | ||
| − | void evtCallDisconnected(DesktopControlAPI.CallArgs args); | + | void evtCallDisconnected(DesktopControlAPI.CallArgs args); |
| Line 53: | Line 53: | ||
=== Syntax === | === Syntax === | ||
| − | void onError(DesktopControlAPI. ErrorEventArgs args); | + | void onError(DesktopControlAPI. ErrorEventArgs args); |
== onCallRecordingStarted == | == onCallRecordingStarted == | ||
| − | ''onCallRecordingStarted'' is sent when call recording is started. | + | ''onCallRecordingStarted'' is sent when call recording is started. Note that this event does not indicate that a call was established or if a call was not recorded. |
For parameters, see the description of auxiliary class [[simplified-desktop-net-api-specification/AuxiliaryClasses|DesktopControlAPI.CallArgs]]. | For parameters, see the description of auxiliary class [[simplified-desktop-net-api-specification/AuxiliaryClasses|DesktopControlAPI.CallArgs]]. | ||
=== Syntax === | === Syntax === | ||
| − | void onCallRecordingStarted(DesktopControlAPI.CallArgs args); | + | void onCallRecordingStarted(DesktopControlAPI.CallArgs args); |
| Line 71: | Line 71: | ||
=== Syntax === | === Syntax === | ||
| − | void onCallRecordingStopped(DesktopControlAPI.CallArgs args); | + | void onCallRecordingStopped(DesktopControlAPI.CallArgs args); |
| Line 80: | Line 80: | ||
=== Syntax === | === Syntax === | ||
| − | void onCallRecordingMuted(DesktopControlAPI.CallArgs args); | + | void onCallRecordingMuted(DesktopControlAPI.CallArgs args); |
| Line 89: | Line 89: | ||
=== Syntax === | === Syntax === | ||
| − | void onCallRecordingUnmuted(DesktopControlAPI.CallArgs args); | + | void onCallRecordingUnmuted(DesktopControlAPI.CallArgs args); |
| Line 98: | Line 98: | ||
=== Syntax === | === Syntax === | ||
| − | void onScreenRecordingStarted(DesktopControlAPI.ScreenRecordingArgs args); | + | void onScreenRecordingStarted(DesktopControlAPI.ScreenRecordingArgs args); |
| Line 107: | Line 107: | ||
=== Syntax === | === Syntax === | ||
| − | void onScreenRecordingCompleted(DesktopControlAPI.ScreenRecordingArgs args); | + | void onScreenRecordingCompleted(DesktopControlAPI.ScreenRecordingArgs args); |
| Line 116: | Line 116: | ||
=== Syntax === | === Syntax === | ||
| − | void onScreenRecordingsMuted(DesktopControlAPI. BaseEventArgs args); | + | void onScreenRecordingsMuted(DesktopControlAPI. BaseEventArgs args); |
| Line 125: | Line 125: | ||
=== Syntax === | === Syntax === | ||
| − | void onScreenRecordingsUnmuted (DesktopControlAPI.BaseEventArgs args); | + | void onScreenRecordingsUnmuted (DesktopControlAPI.BaseEventArgs args); |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 04:32, 29 May 2024
API Events
evtApiUp
evtApiUp is sent when the API is successfully connected (or reconnected) to the softphone.
Note that no information is provided about calls that already may be present on the Agent Desktop.
Syntax
void evtApiUp(System.EventArgs args);
evtApiDown
evtApiDown is sent when the ShutdownAPI method is called or when the API loses connection to the softphone.
In case of connection loss, the API will try to reconnect every 15 seconds; once reconnected, the evtApiUp event is sent.
Syntax
void evtApiDown(System.EventArgs args);
evtCallDialing
evtCallDialing is sent when the softphone starts dialing a call.
Note that this event reports calls both initiated by a prior CallDial method and dialed directly from the Agent Desktop.
For parameters, see the description of auxiliary class DesktopControlAPI.CallArgs.
Syntax
void evtCallDialing(DesktopControlAPI.CallArgs args);
evtCallOffered
evtCallOffered is sent when the softphone receives a new incoming call.
For parameters, see the description of auxiliary class DesktopControlAPI.CallArgs.
Syntax
void evtCallOffered(DesktopControlAPI.CallArgs args);
evtCallDisconnected
evtCallDisconnected is sent when an existing call is released.
For parameters, see the description of auxiliary class DesktopControlAPI.CallArgs.
Syntax
void evtCallDisconnected(DesktopControlAPI.CallArgs args);
onError
onError is sent when an error occurs while executing a method.
For parameters, see the description of auxiliary class DesktopControlAPI.ErrorEventArgs.
Syntax
void onError(DesktopControlAPI. ErrorEventArgs args);
onCallRecordingStarted
onCallRecordingStarted is sent when call recording is started. Note that this event does not indicate that a call was established or if a call was not recorded.
For parameters, see the description of auxiliary class DesktopControlAPI.CallArgs.
Syntax
void onCallRecordingStarted(DesktopControlAPI.CallArgs args);
onCallRecordingStopped
onCallRecordingStopped is sent when call recording is stopped.
For parameters, see the description of auxiliary class DesktopControlAPI.CallArgs.
Syntax
void onCallRecordingStopped(DesktopControlAPI.CallArgs args);
onCallRecordingMuted
onCallRecordingMuted is sent when call recording is muted.
For parameters, see the description of auxiliary class DesktopControlAPI.CallArgs.
Syntax
void onCallRecordingMuted(DesktopControlAPI.CallArgs args);
onCallRecordingUnmuted
onCallRecordingUnmuted is sent when call recording is unmuted.
For parameters, see the description of auxiliary class DesktopControlAPI.CallArgs.
Syntax
void onCallRecordingUnmuted(DesktopControlAPI.CallArgs args);
onScreenRecordingStarted
onScreenRecordingStarted is sent when screen recording is started.
For parameters, see the description of auxiliary class DesktopControlAPI.ScreenRecordingArgs.
Syntax
void onScreenRecordingStarted(DesktopControlAPI.ScreenRecordingArgs args);
onScreenRecordingCompleted
onScreenRecordingCompleted is sent when screen recording is stopped.
For parameters, see the description of auxiliary class DesktopControlAPI.ScreenRecordingArgs.
Syntax
void onScreenRecordingCompleted(DesktopControlAPI.ScreenRecordingArgs args);
onScreenRecordingsMuted
onScreenRecordingsMuted is sent when screen recording is muted.
For parameters, see the description of auxiliary class DesktopControlAPI.BaseEventArgs.
Syntax
void onScreenRecordingsMuted(DesktopControlAPI. BaseEventArgs args);
onScreenRecordingsUnmuted
onScreenRecordingsUnmuted is sent when screen recording is unmuted.
For parameters, see the description of auxiliary class DesktopControlAPI.BaseEventArgs.
Syntax
void onScreenRecordingsUnmuted (DesktopControlAPI.BaseEventArgs args);