Client events

Events sent from client on GUI action

Diagnostic events

• ping
• noop

Mixer events

• channelProperty

{
    [channel_id]: {
        name: 'muted' | 'mode' | 'recording' | 'level' | 'autoanswer'
        value: value
    }
}

• channelMuted

{
    [channel_id]: false | true
}

• channelMode

{
    [channel_id]: 'master' | 'ivr' | 'on_hold' | 'free' | user_id
}

notes: 'free' means that host initiated channel hangup

• channelAutoAnswer

{
    [channel_id]: 'master' | 'ivr' | 'on_hold' | user_id | null
}

• channelRecording

{
    [channel_id]: false | true
}

• channelVolume

{
    [channel_id]: Number (1-100)
}

• channelContactInfo

{
    [channel_id]: {
        [property] : value
    }
}

• channelCallNumber (see callNumber)

{
    [channel_id]: {
        number: Number,
        mode: 'master' | 'ivr' | 'on_hold' | host_id
    }
}

• masterProperty

{
    name: 'muted' | 'on_air' | 'recording' | 'level' | 'delay'
    value: value
}

• masterMuted

false | true

• masterVolume

Number (1-100)

• masterRecording

false | true

• masterOnAir

false | true

• masterDelay

Number

• userVolume

{
    [user_id]: Number (1-100)
}

• userProperty

{
    [user_id]: {
        name: 'muted' | 'level' | 'recording',
        value: value
    }
}

• userMuted

{
    [user_id]: false | true
}

• userRecording

{
    [user_id]: false | true
}

• userWhisper

{
    [user_id]: channel_id
}

note: user can whisper to a channel only if both are in 'master' mode

• hostVolume

    Number (1-100)

• hostMuted

    false | true

• callNumber

{
        number: Number,
        mode: 'master' | 'ivr' | 'on_hold' | user_id,
        channel_id: channel_id | null
}

note: if channel_id is null, the system chooses automatically how to originate the call

Address-book events

• addrBookSuggestions

String

Message events

• currentBucketUpdate

bucket_id

• messages:send

{
    [temp_id]: { // temp_id is used for referencing potential errors while sending
        type: "sms_out",
        //contact_id: String, // in case of sms, this is the mobile number
        endpoint: String, // in case of sms, this is the mobile number
        content: String,
        channel_id: channel_id | null, // force sending via channel_id 
        reply_to: message_id | null
    }
}

• messages:delete

{
    [message_id]: null
}

• messages:favorite

    [message_ids]

• messages:unfavorite

    [message_ids]

• messages:addTags

{
    message_ids: [message_ids],
    tags: [String]
}

• message:removeTags

{
    message_ids: [message_ids],
    tags: [String]
}

• messages:fetch

{
    tags: [String], // filter by tags (...AND)
    from: timestamp | null,
    to: timestamp | null,
    bucket_ids: [String] // (...OR)
}

Q&A events

* questions:delete
```javascript
{
    [message_id]: null
}

• questions:favorite

    [message_ids]

• questions:unfavorite

    [message_ids]

• questions:fetch

{
    tags: [String], // filter by tags (...AND)
    from: timestamp | null,
    to: timestamp | null,
    ids: [String] // (...OR)
}

Call History events

* calls:delete
```javascript
{
    [message_id]: null
}

• calls:favorite

    [message_ids]

• calls:unfavorite

    [message_ids]

• calls:fetch

{
    tags: [String], // filter by tags (...AND)
    from: timestamp | null,
    to: timestamp | null,
    ids: [String] // (...OR)
}