com.innovaphone.devices

The com.innovaphone.devices services api enables apps to use the whole websocket communication API from devices. 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.

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

GetLoginInfoResult

The result message for the GetLoginInfo 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, a DeviceProvisioned message will be triggered later.

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
        }
    ]
}

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

Parameters