API Version: Development

Reference

/

REST API

/

keevio

/

keevio commands

   
  • keevio commands
  • Permissions
  • command 'dial'
  • Types
  • command 'create'
  • command 'start'

    • keevio commands

    Permissions

    Requires User permissions, but may only inject commands for the currently authenticated user.

    command 'dial'

    Path: /rest/command/dial/
    Dial a call, either using keevio, a handset, or by trying keevio followed by a handset.
    {    
    "type": "direct" "keevio" "auto" "teams" or "handset",
    "values": {
        "number": nnn,
        "autoanswer": true or false,
        "autohold": true or false
    }
}

    Types

    • "auto" - Use chat/command channel if chat is online, else teams/owned phone
    • "direct" - No keevio, look for teams/owned phone
    • "keevio" - Use chat/command channel if chat is online
    • "teams" - Like direct, but teams phone only 6.5.0
    • "handset" - Like direct, but owned phone only 6.5.0

    command 'create'

    Path: /rest/command/create/
    Request a keevio chat room be opened.
    {
    "type": "room",
    "values": {
        "internal": [contact-id, ...],
        "external": [
            {
                "name": "External Name",
                "email": "external@email",
                "mobile": mobile_nnn
            }, ...
        ]
    }
}

    command 'start'

    Path: /rest/command/start/
    Request a keevio chat room be opened, and then initiate a video chat.
    {
    "type": "video",
    "values": {
        "internal": [contact-id, ...],
        "external": [
            {
                "name": "External Name",
                "email": "external@email",
                "mobile": mobile_nnn
            }, ...
        ]
    }
}