Get Channel List

Last Updated on : 2023-06-20 14:54:06download

Get a list of channels based on the ID of a specified remote control, including an online channel list, custom channel list, and selected channel list.

API address

GET: /v2.0/infrareds/{infrared_id}/remote/{remote_id}/channels

Request parameter

Parameter name	Type	IN	Required	Description
infrared_id	String	uri	true	The device ID.
remote_id	String	uri	true	The ID of a specified remote control.

Return parameter

Parameter name	Type	Description
result	List	The returned result.

Description of result

Parameter name	Type	Description
id	Long	The ID of a specified channel table.
index	Integer	The index of a specified channel table.
is_default	Boolean	Indicates whether it is the default channel table or not.
channel_type	Integer	The type of a specified channel table. Valid values: `0`: user-defined channel. `1`: unpublished channels in the allowlist. `2`: online channel.
custom_channel_name	String	The name of a specified channel table.
channel_list	List	The list of channels.

Description of channel_list

Parameter name	Type	Description
cid	Integer	The ID of a specified channel.
name	String	The name of a specified channel.
num	Integer	The number of a specified channel.

Request example

GET: /v2.0/infrareds/vdevo15345926009****/remote/d5s65ca55/channels

Return example

{
    "result": [
        {
            "custom_channel_name": "Channel Table 7",
            "index": 7,
            "id": 7027770,
            "channel_list": [
                {
                    "num": 0,
                    "name": "TV Guide",
                    "cid": 7757
                },
                {
                    "num": 21,
                    "name": "CCTV-1 HD",
                    "cid": 110274
                },
                {
                    "num": 22,
                    "name": "CCTV-2",
                    "cid": 30
                },
                {
                    "num": 24,
                    "name": "CCTV-4",
                    "cid": 37
                },
                {
                    "num": 27,
                    "name": "CCTV-7",
                    "cid": 35
                },
                {
                    "num": 30,
                    "name": "CCTV-10",
                    "cid": 33
                },
                {
                    "num": 31,
                    "name": "CCTV-11",
                    "cid": 39
                },
                {
                    "num": 32,
                    "name": "CCTV-12",
                    "cid": 40
                }
            ],
            "channel_type": 2
        }
    ],
    "t": 1632815018568,
    "success": true
}

Error code

For more information, see error code.