Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
minLevel1
maxLevel6
outlinefalse
stylenone
typelist
printablefalse

Overview

Switchvox's Realtime API lets clients create calls and receive realtime notification of call state. The API requires authentication using the same credentials used to log into an extension's account from a web browser. The methods of the API are gated by permissions set by the PBX admin.

...

Access to the API is over a socketa socket.io 1io 1.0.x connection to the PBX. To connect to the server via Javascript:

...

Responses to requests are emitted by the server as socket.io 'response' events. The argument to the event is a JSON RPC 2.0 response object. Notifications, resulting from 'subscribe' requests, are emitted as 'notification' events. The argument is similar to a response object, but omits the 'id' field per the spec.

...