VoIP Cloud

Triggered when the call attempt has started

The schema defines the following properties:

state (string, enum)

Current state of the call. Allowed values are started, answered

This element must be one of the following enum values:

apiCode (string, required)

The code used to authorize against VoIP provider API.

callId (string, required)

Call identifier complient with UUID V4.

Additional restrictions:

from (string, required)

Caller phone number for incoming call/User Extension for outgoing call.

to (string, required)

Caller phone number for outgoing call/User Extension for incoming call.

direction (string, enum, required)

Call direction: outgoing if call was made from registered user to external number/incoming if call was made from external number to extension.

This element must be one of the following enum values:

timestamp (string, required)

Time when the event was dispatched. Must be complient with RFC3339 section 5.6. Example: 2016-01-30T15:56:03+02:00

actualTime (string, required)

Time when the event has actually happened. Must be complient with RFC3339 section 5.6. Example: 2016-01-30T15:56:03+02:00

metadata (object)

Arbitrary metadata.

Example

{
  "apiCode":"QWERTASDRZXC",
  "callId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "from": "380999991234",
  "to": "abcde43xyz",
  "direction": "outgoing",
  "timestamp": "2016-04-03T15:24:16Z",
  "actualTime": "2016-04-03T15:24:11Z",
  "state": "started"
}