The companion device service uses data configured in the subscriber’s Metaswitch-TAS-Services document. To see what operator-wide service configuration is available for the companion device service, check Companion device.
- Example document
- Setting up the companion device service
- I want to …
- Authorize and activate the companion device service for the subscriber
- Set the shared SIP identity for the subscriber’s companion devices
- Add a PS domain only companion device
- Add a PS and CS domain capable companion device
- Add a PS and CS domain capable companion device with a defined IMPI, IMSI, and IMEI
- I want to …
- Schema
Example document
This example subscriber data document specifies that:
-
The companion device service is active for the subscriber and authorized by the operator.
-
The shared identities of all companion devices declared is
sip:bob@home1.opencloud.co.nz
-
A PS-only companion device is configured for the subscriber.
<metaswitch-services xmlns="http://metaswitch.com/XMLSchema/tas">
<complete-basic-settings>
<basic-settings active="true"/>
<operator-basic-settings authorized="true"/>
</complete-basic-settings>
<complete-companion-device>
<companion-device active="true"/>
<operator-companion-device authorized="true">
<shared-identity-sip>sip:bob@home1.opencloud.co.nz</shared-identity-sip>
<devices>
<device active="true">
<model>companion-device-1</model>
<impi/>
<imsi/>
<imei/>
<radio-access>
<PS/>
</radio-access>
</device>
</devices>
</operator-companion-device>
</complete-companion-device>
</metaswitch-services>
Setting up the companion device service
I want to …
Authorize and activate the companion device service for the subscriber
In the element at /metaswitch-services/complete-companion-device/operator-companion-device
, set the authorized
attribute to true
:
<operator-companion-device authorized="true">
In the element at /metaswitch-services/complete-companion-device/companion-device
, set the active
attribute to true
:
<companion-device active="true"/>
Set the shared SIP identity for the subscriber’s companion devices
In the element at /metaswitch-services/complete-companion-device/operator-companion-device/shared-identity-sip
,
set the shared-identity-sip
element to the SIP identity for the subscriber’s companion devices:
<shared-identity-sip>sip:bob@home1.opencloud.co.nz</shared-identity-sip>
Add a PS domain only companion device
In the element at /metaswitch-services/complete-companion-device/operator-companion-device/devices
,
add the following device
type element to it:
<devices>
<device active="true">
<model>companion-device-1</model>
<impi/>
<imsi/>
<imei/>
<radio-access>
<PS/>
</radio-access>
</device>
</devices>
Add a PS and CS domain capable companion device
In the element at /metaswitch-services/complete-companion-device/operator-companion-device/devices
,
add the following device
type element to it:
<devices>
<device active="true">
<model>companion-device-1</model>
<impi/>
<imsi/>
<imei/>
<radio-access>
<PS/>
<CS msisdn="641234567"/>
</radio-access>
</device>
</devices>
Add a PS and CS domain capable companion device with a defined IMPI, IMSI, and IMEI
In the element at /metaswitch-services/complete-companion-device/operator-companion-device/devices
,
add the following device
type element to it:
<devices>
<device active="true">
<model>companion-device-1</model>
<impi>234150999999999@ims.mnc015.mcc234.3gppnetwork.org</impi>
<imsi>234150999999999</imsi>
<imei>90420156-025763-0</imei>
<radio-access>
<PS/>
<CS msisdn="1234567"/>
</radio-access>
</device>
</devices>
Schema
The schema definition dedicated to the companion device service is stored in the companion-device.xsd
.