Get stream transcoder list

Developing

GET

/openapi/v0.1/live-stream/converter

Obtain the stream forwarder list. After creating a stream forwarder, you can call this interface to get the created stream forwarder.

Request

Header Params

X-Request-Id

string <uuid>

required

Request Unique Identifier

X-Language

enum<string>

optional

Allowed values:

zhen

Default:

X-Project-Uuid

string

optional

Project Number

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/openapi/v0.1/live-stream/converter' \
--header 'X-Request-Id;' \
--header 'X-Language: zh' \
--header 'X-Project-Uuid: {{X-Project-Uuid}}'

Responses

🟢200Success

application/json

Body

code

integer

required

Non-zero indicates an exception

message

string

required

Message prompt

data

object

required

list

array [object {11}]

required

Example

{
  "code": 0,
  "message": "OK",
  "data": {
    "list": [
      {
        "converter_name": "custom-name-gb",
        "converter_id": "acfb0e79-87a7-4d61-898e-2f32792996e5",
        "sn": "7CTDM3D00BZNVZ",
        "camera_index": "165-0-7",
        "schema": "gb28181",
        "schema_option": {
          "server_id": "00000000000000000001",
          "server_ip": "127.0.0.1",
          "server_port": "5060",
          "device_password": "password",
          "local_port": "7060",
          "device_id": "34020000001310000004",
          "local_channel": "34020000001310000004"
        },
        "auto_push_stream": false,
        "device_online_status": true,
        "device_callsign": "司空惠州1号机场",
        "state": "initialized",
        "state_code": 213050
      },
      {
        "converter_name": "custom-name-rtmp",
        "converter_id": "6d84b264-934e-49bc-835c-78ef631b4d25",
        "sn": "7CTDM3D00BZNVZ",
        "camera_index": "165-0-7",
        "schema": "rtmp",
        "schema_option": {
          "url": "rtmp://live.restream.io/live31/"
        },
        "auto_push_stream": false,
        "device_online_status": true,
        "device_callsign": "司空惠州1号机场",
        "state": "initialized",
        "state_code": 213050
      }
    ]
  }
}

Enable/Disable stream forwarder

Delete stream forwarder