com.innovaphone.devices

The com.innovaphone.devices services api enables apps to use the whole websocket communication API from devices. E.g. the users App uses this functionality on the C++ part of the App for provisioning.
All messages are send as JSON strings and must use the mt property which is the message type.
You can also use this API to execute HTTP requests on connected devices, so called sysclients.

Summary

See services for the information how to exactly work with IServices!

        IServicesApi * services = ...;    // must be retrieved within the PBX websocket connection PbxInfo message to the app service.
        IService * service = services->GetService("com.innovaphone.devices");
        class IAppWebsocketClient * awsClient = IAppWebsocketClient::Create(iomux, this, tcpSocketProvider, tlsSocketProvider, dns, log);
        awsClient->Connect(service->GetWebsocketUrl(), service->GetName(), session->services->CreateAuthenticator());

If you do not work with IServices and you know the intance password of the Devices instance, you can also use the standard AppLogin mechanism to login to Devices.
In a multi domain environment in Devices, you're automatically admin with access to all domains, if you login with the instance password and the instance domain.
If you login with the domain password from a domain different than the instance domain, you just have access to your own domain or domains, where you got access to.

Query the login info of the logged in user.

Parameters

GetUserInfoResult

The result message for the GetUserInfo request.

Parameters

Retrieves all provisioning categories. With type='PHONE' you can just retrieve provisioning categories suitable for phones (device configurations Phone/Analog Phone exist).

Parameters

GetProvisioningCategoriesResult

The result message for the GetProvisioningCategories request.

Parameters

Example

{
    "mt":"GetProvisioningCategories",
    "last":true,
    "categories":[
        {
            "id":1,
            "name":"Cat1",
            "domainId":2,
            "config":true
        }
    ]
}

Generates a new provisioning code and triggers a DeviceProvisioned message on provisioning afterwards.

Parameters

GetProvisioningCodeResult

The result message for the GetProvisioningCode request.

Parameters

Gets the device provisioned with a certain code. This is useful if a provisioning was interrupted and might have been finished in the meantime.
If not yet finished, a DeviceProvisioned message will be triggered on the actual provisioning.

Parameters

GetProvisionedDeviceResult

The result message for the GetProvisionedDevice request.

Parameters

Example

{
    "mt":"GetProvisionedDeviceResult",
    "code": "123123123123",
    "device":[
        {
            "id":1,
            "hwId":"0090334100be",
            "name":"Kari2",
            "domainId":2,
            "product":"IP811",
            "version":"13r1 dvl [13.A110/13A146/200]",
            "type":"GW",
            "pbxActive":true,
            "online":true
        }
    ]
}

Gets domains.
The answer might be sent multiple times until the last property is set.

Parameters

GetDomainsResult

The result message for the GetDomains request.

Parameters

Example

{
    "mt": "GetDomainsResult",
    "last": true,
    "domains": [{
            "id": 1,
            "name": "domain.com",
            "hasRentalProducts": true,
            "deployAdminPasswords": true,
            "isInstanceDomain": true,
            "categories": [{
                    "id": 1,
                    "name": "Test",
                    "config": false
                }, {
                    "id": 2,
                    "name": "Test2",
                    "config": false
                }
            ]
        }
    ]
}
    

Gets devices with certain filters.
The answer might be sent multiple times until the last property is set.

Parameters

Note

Example

{
    "mt": "GetDevices",
    "recvUpdates": true,
    "domainIds": "1",
    "categories": "",
    "subcategories": "",
    "unassigned": true
}
    

GetDevicesResult

The result message for the GetDevices request.

Parameters

Example

{
    "mt": "GetDevicesResult",
    "devices": [{
            "id": 0,
            "hwId": "009033280177",
            "domainId": 0,
            "product": "IP111",
            "version": "13r2 sr2 [13.6146/136146/400]",
            "type": "PHONE",
            "pbxActive": false,
            "online": true,
            "ethIfs": [{
                    "if": "ETH0",
                    "ipv4": "172.16.136.105",
                    "ipv6": "2002:91fd:9d07:136:290:33ff:fe28:177"
                }
            ]
        }
    ],
    "last": true
}
    

Gets devices with certain filters.
The answer might be sent multiple times until the last property is set.

Parameters

GetFilteredDevicesResult

The result message for the GetFilteredDevices request.

Parameters

Gets device configurations of a domain.
The answer might be sent multiple times until the last property is set.

Parameters

GetDeviceConfigsResult

The result message for the GetDeviceConfigs request.

Parameters

A device configuration object always has common fields. Every device configuration type has its own fields in addition.

Common fields

Fields type ALARM_SERVER

Note: the logPassword field is transferred encrypted to 3rd party sysclients inside the configuration message! Instead of seed, use logSeed and see for how to decrypt it!

Fields type EXPERT

Note: the script field is not transferred to 3rd party sysclients inside the configuration message!

Fields type FXS_PHONE and PHONE

Fields type MEDIA

Note: the turnPassword field is transferred encrypted to 3rd party sysclients inside the configuration message! Instead of seed, use turnSeed and see for how to decrypt it!

Fields type NTP

Fields type TLS_PROFILE

Gets a specific device configuration.

Parameters

GetDeviceConfigValueResult

A GetDeviceConfig message may trigger 0 ... n GetDeviceConfigValueResult messages before you receive the final GetDeviceConfigResult message, as a configuration value may exceed the maximum size of a single JSON message.
You must concatenate all values received for the same name to build the final value.

Parameters

GetDeviceConfigResult

The result message for the GetDeviceConfig request.

Parameters

Message from the service if a device has been provisioned after the GetProvisioningCode request.

Parameters

Message from the service if a domain has been edited. This message is just triggered if a GetDomains request with recvUpdates true has been send before.

Parameters

Message from the service if a domain has been deleted. This message is just triggered if a GetDomains request with recvUpdates true has been send before.

Parameters

Message from the service if a domain has been added. This message is just triggered if a GetDomains request with recvUpdates true has been send before.

Parameters

Message from the service if a device has been updated. This message is just triggered if a GetDevices request with recvUpdates true has been send before.

Parameters

Message from the service if a device has been added. This message is just triggered if a GetDevices request with recvUpdates true has been send before.

Parameters

Message from the service if a device has been removed. This message is just triggered if a GetDevices request with recvUpdates true has been send before.

Parameters