BLF Status Indication Guide
This guide will provide an overview of setting up BLF to report the status of a Qubicle recipient.
Prerequisites
- A valid user that has a device configured, and is enabled as a Qubicle recipient
Configuration
In order to enable BLF indications for a recipient, we must first configure the ‘presence_id’ that we wish to use on the recipient. This can be achieved with the following Crossbar request:
NOTE this is using the users API.
curl -X PATCH -H "X-Auth-Token: {AUTH_TOKEN}" http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/users/{RECIPIENT_ID}/ -d '{"data":{"qubicle":{"presence_id":"{PRESENCE_ID}"}}}'
Phone Configuration
Phone configuration will vary by the model of phone / sip device you are using. However you can now configure your device to subscribe to {PRESENCE_ID}@{REALM} and you will be provided with BLF updates when the state of the recipient changes.
States
The BLF states correspond to the following recipient states:
- IDLE: logged out
- RINGING: logged in, but away
- ON-A-CALL: logged in, ready