TVOpen Message Manager API Common Parameters
Jump to navigation
Jump to search
COMMANDS COMMON PARAMETERS
| Name | Description | Parameter | Mandatory | Type | Format |
|---|---|---|---|---|---|
| instance_id | Identifier of MIB instance | Common | true | integer | int64 |
| source_id | Unique identifier origin of commands (GVP DataHuB, MiB, GAL BSS) |
Common | true | integer | int64: - 0 (youbora) - 1 (mib) - 2 (gal_bss) - 3 (vrm proxy) |
| command_id | Unique identifier of commands (pattern: ^[A-Za-z0-9\\-_]+$) | Common | true | string | string (24 characters) |
| start_time | Start date command execution (in UTC) | Common | true | string | date (ISO-8601) |
| end_time | End date command execution (in UTC) | Common | true | string | date (ISO-8601) |
| device_type | Device type to send command | Common | true | string | values: - 802 (iptv) - 803 (ej: dth) - 802,803 |
| force_datahub_report | This parameter allows to receive report, in real time, about the command execution |
Common | false | boolean | boolean (True/False) |
| target_type | Type of segmentation applied | Common | true | string | enum: - stb_id (sprayer) - stb_list_file (sprayer) - list_id (infopush) - stb_model (infopush) - subscription_id (infopush) - region_id (infopush) - all (infopush) |
| stb_id | Identifier of STB | Common | false | string | string (uuid) |
| stb_list_file | List of STB receivers | Common | false | file | File in csv format with the list of STB uuid's separated by comma |
| list_id | ID of a dynamic list of STB associated to a specific package name | Common | false | string | string |
| stb_model | Model of STB | Common | false | string | string |
| subscription_id | ID of MiB subscription | Common | false | string | string |
| region_id | Applied filter to all STBS of a region | Common | false | string | string |
