Remote SDK API Event Flow

When events happen on the phone, like active calls changing state, the Remote SDK will send a JSON object containing the event information to the controlling WebSockets server via the already established WebSockets connection.

Figure: Remote SDK API Event Flow

NOTE: All events are always sent, no subscription API call is required. The set of events which may be sent per interface is available on Cisco DevNet for the Remote SDK under the API Reference section or retrievable by calling the /api/GetMetadata method. The response is a Swagger/OpenAPI 3.0 definition of APIs and events supports by the phone's current software load. To find events, look for the Subscribe method under each versions interface. For the 11.3.1 MPP release, the Subscribe method is mearly a placeholder to express events per interface, and is neither callable nor implemented.

The event JSON object contains the following name/value pairs:

type The associated value is of type string, and indicates what sort of message this JSON payload object represents, For JSON payloads representing phone events, the associated value will be "event".
params This value has an associated dictionary object which contains the specific data fields associated with the event. Some events may have no aassociated data fields, in which case the dictionary object will be empty.
name This is the event name, which is expressed as a path similar to "Request-URI".

JSON Event Payload Example

Code Snippet

Copy {
    "type": "event",
    "params": {
        "line": 1,
        "callId": 0,
        "callState": "Dialing"
    },
    "name": "/api/Call/v1/CallStateChanged"
 }