PbxTableUsers

The PbxTableUsers protocol is available on AppWebsocket connections to innovaphone PBX objects, if the object is enabled for the TableUsers. It allows the App to replicate the User Objects from the PBX using the Replicator.

{
    "api": "PbxTableUsers",
    "src": string,
    "mt": string,
    }

api

To address this interface the value "PbxTableUsers" has t0 be used for the api property

src

The AppWebsocket src mechanism is supported on the interface. So a src property may be used

mt

The message type identifies the requested operation

In general operatios are performed by sending a message with a message type <name> to the PBX. The result is retured with a message with message type <name>Result.

• ReplicateStart - Start the replication
• ReplicateNext - Get next rows
• ReplicateAdd - Add a row
• ReplicateDel - Delete a row
• ReplicateUpdate - Update a row

• users - users table
• emails - emails table
• allows - privacy settings configured on the user object
• t-allows (depricated) - privacy settings inherited from the config templates
• grps - groups table
• devices - devices table
• cds - call diversions table
• forks - forks table
• wakeups - wakeups table

• ReplicateUpdate - how the ReplicateUpdate message should look like

Tables

users

Table with the user data

emails

Table with the emails of the users

allows

Table with the visibility filters defined for the user

t-allows (depricated)

Table with the visibility filters defined on the config templates. Do not use anymore, this does not work together with the new replication alogoritm, which only replicates changes after reconnect.

grps

Table with the users groups

devices

Table with the users devices

cds

Table with the users call diversions

forks

Table with the users forks

wakeups

Table with the users wakeups

Examples

ReplicateUpdate

After the user object has been edited on the PBX side, a ReplicateUpdate message is sent to the app instance including all the user object data. An example of how the message would look like is this one:

{
    "mt":"ReplicateUpdate",
    "api":"PbxTableUsers",
    "columns":
    {
        "guid":"c9ebcc5914bd5e01c8020090334106ee",
        "h323":"user0",
        "pwd":"05a14fa93ec663b04deaf54277b1eb874612793587f0b287",
        "cn":"User0",
        "apps-my":"apps,usersadmin,profile,phone,users,users2,softphone,devices,pbxmanager",
        "config":"Config",
        "node":"root",
        "loc":"master",
        "hide":false,
        "e164":"201",
        "emails":[
            {
                "email":"user0@example.com"
            }
        ],
        "allows":[
            {
                "name":"@test1.com",
                "presence":true,
                "visible":true
            },
            {
                "name":"@test2.com",
                "presence":true,
                "visible":true
            }
        ],
        "t-allows":[
            {
                "name":"@test1.com",
                "online":true,
                "presence":true,
                "visible":true
            }
        ],
        "grps":[
            {
                "name":"group1",
                "mode":"active",
                "dyn":"in"
            }
        ],
        "devices":[
            {
                "hw":"Swphone_user0",
                "text":"softphone",
                "app":"softphone",
                "tls":true,
                "sreg":true
            }
        ],
        "cds":[
            {
                "type":"cfnr",
                "bool":"booltest",
                "e164":"203"
            },
            {
                "type":"cfb",
                "h323":"test",
                "src":"<src type=\"do\"><ep ext=\"false\" fwd=\"fwd\" /></src>"
            }
        ],
        "forks":[
            {
                "e164":"9999",
                "bool":"booltest",
                "bool-not":true,
                "mobility":"Mobility",
                "delay":30,
                "hw":"Smartphone",
                "app":"rcc",
                "cw":true,
                "min":1,
                "max":10
            }
        ]
    }
}

ReplicateStart for specific object types

It is possible to replicate PBX object of other types than User Objects. Therefore a ReplicateStart message is extended by the property pseudo which is an array of types that should be replicated. In the example below the PBX objects of type Waiting Queue are replicated.

{
    "mt": "ReplicateStart",
    "api": "PbxTableUsers",
    "columns": {
        "cn": {
            "update": true
        },
        "guid": {},
        "h323": {
            "update": true
        },
        "pseudo": {
            "update": true
        }
    },
    "pseudo": [
        "waiting"
    ]
}