Get Stream Forwarding Channel Transcoder

Request

Query Params

channel

string

required

The format of channel is: {device sn_camera}, taking the sample value as an example: {6QCDL5R0000128} is the device sn, and {165-0-7} is the camera. The device sn and camera need to correspond to the input parameters of the start stream forwarding interface [manage/api/v1.0/stream-converters].

Example:

6QCDL5R0000128_165-0-7

Header Params

X-Organization-Key

string

required

Example:

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET '/manage/api/v1.0/stream-converters?channel=6QCDL5R0000128_165-0-7' \
--header 'X-Organization-Key: {{orgnazation_key}}' \
--header 'X-Organization-Key;'

Responses

🟢200成功

application/json

Body

data

object

required

total_count

integer

required

Total number of Converters

cursor

integer

required

members

array [object]

required

rtc_channel

string

required

status

string

required

converter_name

string

required

The name of the Converter.

update_ts

string

required

Unix timestamp (in seconds) of when the Converter configuration was last updated.

rtmp_url

string

required

CDN streaming address.

converter_id

string

required

The ID of a Converter is a UUID (Universally Unique Identifier) generated by the server, which identifies a created Converter.

idle_timeout

string

required

The maximum length of time (in seconds) that a Converter is idle. Idle means that the live source is offline, such as when the dock is shut down or the aircraft is disconnected from the dock. When the Converter is idle for longer than idleTimeout, the Converter is automatically destroyed and the streaming stops. The value range is [5,300]. The default value is 300.

state

string

required

Converter running status:
"connecting": Connecting to the streaming server and CDN server.
"running": Streaming is in progress.

code

integer

required

Non-zero indicates an exception

message

string

required

Message prompt

Example

{
    "data": {
        "total_count": 0,
        "cursor": 0,
        "members": [
            {}
        ],
        "rtc_channel": "string",
        "status": "string",
        "converter_name": "string",
        "update_ts": "string",
        "rtmp_url": "string",
        "converter_id": "string",
        "idle_timeout": "string",
        "state": "string"
    },
    "code": 0,
    "message": "string"
}

🟠401未授权