Summary
This article describes the certified specifications CostGuard Provisioning supports for MobiTV. Provisioning currently supports a subset of the MobiTV provisioning capabilities. This article contains a detailed list of actions and parameters.
Specifications
Provider: Tivo Managed IPTV Service (Formerly MobiTV)
Link: Managed IPTV Service
Application Interface: MobiTV Provisioning and Billing Interface
Application Version: v17
CostGuard MobiTV Provider Version: 1.3
CostGuard Bundle Version: 23.2
Overview
The section below will highlight how Provisioning interacts with the MobiTV APIs. As well as some helpful advice and guidelines.
The MobiTV provisioning offering supports full subscription lifecycle management, including creation, disconnection, suspension, and restoration.
If an error occurs on an API call, none of the objects in the request were processed and must be corrected and regenerated accordingly.
When upgrading or downgrading a feature offer (DVR or concurrent stream), the system will only pass the “create” action to MobiTV. The MobiTV platform will handle the cancellation of the existing feature offer.
Available Actions:
The current actions supported for MobiTV include:
Provider | Action | Available |
MobiTV | 23.2 | |
MobiTV | 23.2 | |
MobiTV | 23.2 | |
MobiTV | 23.2 | |
MobiTV | 23.2 | |
MobiTV | 23.2 | |
MobiTV | 23.2 |
Add Feature
This action is used to add new subscribers and features as well as add features to existing subscribers.
The MobiTV platform will evaluate if the subscriber account already exists.
A new MobiTV account will be created if a subscriber does not exist in the MobiTV platform.
If the subscriber already exists in the MobiTV platform, the new or updated features will be added to the account.
Operators must provide at least one regional offer on the first call to create a purchase for an account.
The “Product ID List” value can contain one or many product IDs; a comma must separate the product ids.
When upgrading or downgrading a feature offer (DVR or concurrent stream), the system will only pass the “create” action to MobiTV. The MobiTV platform will handle the cancellation of the existing feature offer.
Parameters:
Name | Type | Required* | Notes |
ConnectionInformation | |||
URL | String | Required | URL of the MobiTV Web Service |
Partner ID | String | Required | Partner ID provided by MobiTV |
Operator | String | Required | Name of the operator initiating the transaction. MobiTV will provide this. |
Billing System | String | Required | The external billing system from which the purchase originated. Used for reporting purposes. |
Secret Key | String | Required | Partner Secret provided by MobiTV |
MessageInformation | |||
External ID | String | Required | User identifier from the operator’s system. Typically service number or account number. |
Zip Code | Number | Conditional* | ZIP code for the account. If provided, MobiTV systems will be updated with the FIPS code. It’s a mandatory field when provisioning the account for the first time. |
County | String | Optional | County for the account. Mobi systems will use this to translate to the appropriate FIPS code if provided. This has to be provided with the state. County and state both need to be provided to determine the FIPS code. |
State | String | Optional | The state abbreviation for the account. Mobi systems will use this to translate to the appropriate FIPS code if provided. This has to be provided with the county. County and state both need to be provided to determine the FIPS code. |
Product ID List | String | Required | The billing product/offer ID for the operator’s system. The product ID list can be added as comma separated values. |
* Field is conditionally required. Values selected in preceding fields may change the field from optional to required.
Disconnect Account
This action disconnects the entire account on the MobiTV platform.
Parameters:
Name | Type | Required. | Notes |
Connection Information | |||
URL | String | Required | URL of the MobiTV Web Service |
Partner ID | String | Required | Partner ID provided by MobiTV |
Operator | String | Required | Name of the operator initiating the transaction. MobiTV will provide this. |
Billing System | String | Required | The external billing system from which the purchase originated. Used for reporting purposes. |
Secret Key | String | Required | Partner Secret provided by MobiTV |
Message Information | |||
External ID | String | Required | User identifier from the operator’s system. Typically service number or account number. |
Zip Code | Number | Required | ZIP code for the account. If provided, Mobi systems will be updated with the FIPS code. It is a mandatory field when provisioning the account for the first time. |
County | String | Required | County for the account. If provided, Mobi systems will use this to translate to the appropriate FIPS code. This has to be provided with the state. County and state both need to be provided to determine the FIPS code. |
State | String | Required | The state abbreviation for the account. If provided, Mobi systems will use this to translate to the appropriate FIPS code. This has to be provided with the county. County and state both need to be provided to determine the FIPS code. |
Product ID List | String | Required | The billing product/offer ID for the operator’s system. The product ID list can be added as comma separated values. |
* Field is conditionally required. Values selected in preceding fields may change the field from optional to required.
Disconnect Feature
This action will disconnect a feature from an existing MobiTV subscription.
Parameters:
Name | Type | Required | Notes |
Connection Information | |||
URL | String | Required | URL of the MobiTV Web Service |
Partner ID | String | Required | Partner ID provided by MobiTV |
Operator | String | Required | Name of the operator initiating the transaction. MobiTV will provide this. |
Billing System | String | Required | The external billing system from which the purchase originated. Used for reporting purposes. |
MessageInformation | |||
External ID | String | Required | User identifier from the operator’s system. Typically service number or account number. |
Product ID List | String | Required | The billing product/offer ID for the operator’s system. The product ID list can be added as comma separated values. |
Restore an Account
This action restores a suspended account.
Parameters:
Name | Type | Required | Notes |
ConnectionInformation | |||
URL | String | Required | URL of the MobiTV Web Service |
Partner ID | String | Required | Partner ID provided by MobiTV |
Operator | String | Required | Name of the operator initiating the transaction. MobiTV will provide this. |
Billing System | String | Required | The external billing system from which the purchase originated. Used for reporting purposes. |
MessageInformation | |||
External ID | String | Required | User identifier from the operator’s system. Typically service number or account number. |
Suspend Account
This action suspends the MobiTV account.
Parameters:
Name | Type | Required | Notes |
ConnectionInformation | |||
URL | String | Required | URL of the MobiTV Web Service |
Partner ID | String | Required | Partner ID provided by MobiTV |
Operator | String | Required | Name of the operator initiating the transaction. MobiTV will provide this. |
Billing System | String | Required | The external billing system from which the purchase originated. Used for reporting purposes. |
MessageInformation | |||
External ID | String | Required | User identifier from the operator’s system. Typically service number or account number. |
Update Billing ID
This action updates the external billing id in MobiTV to a new value.
Note:
If you’re using the service number as the “External ID” value, and you change the service number as part of the order, if the request errors in MobiTV and is force completed, you’ll need to update the new Billing ID in MobiTV manually. This will keep the values in CostGuard and MobiTV in sync since completing the order in CostGuard will update the service number in CostGuard.
Parameters:
Name | Type | Required | Notes |
ConnectionInformation | |||
URL | String | Required | URL of the MobiTV Web Service |
Partner ID | String | Required | Partner ID provided by MobiTV |
Operator | String | Required | Name of the operator initiating the transaction. MobiTV will provide this. |
Billing System | String | Required | The external billing system from which the purchase originated. Used for reporting purposes. |
MessageInformation | |||
External ID | String | Required | Existing external identifier or InternalObjectID |
New External ID | String | Required | New external Id of the account to which the user account should be updated in the request. |
Update Extended Data
This action updates extended data on a MobiTV account. The action allows you to perform the following updates:
Update the account as whitelisted for in-home detection.
Tag the account as a test account.
Set the Standby Timer
Parameters:
Name | Type | Required | Notes |
ConnectionInformation | |||
URL | String | Required | URL of the MobiTV Web Service |
Partner ID | String | Required | Partner ID provided by MobiTV |
Operator | String | Required | Name of the operator initiating the transaction. MobiTV will provide this. |
Billing System | String | Required | The external billing system from which the purchase originated. Used for reporting purposes. |
MessageInformation | |||
External ID | String | Required | User identifier from the operator’s system. Typically service number or account number. |
ExtendedData | |||
In Home Whitelist Expiration Date | Date/Time | Optional | Value of expiry date of whitelist |
Test Account Type | String | Optional | Used to Tag test accounts so they are not counted in reporting. |
Standby Timer | Number | Optional | Value is in seconds |