Start Stream Forwarding

POST

/manage/api/v1.0/stream-converters

Request

Header Params

Body Params application/json

Example

{
    "region": "en",
    "converter_name": "test",
    "sn": "6QCD0000000000",
    "camera": "165-0-7",
    "video": "normal-0",
    "idle_timeout": 500,
    "video_quality": 0,
    "bypass_option": {
        "url": "rtmp://xx.xx.xx"
    },
    "rtmp_url": "rtmp://xx.xx.xx"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/manage/api/v1.0/stream-converters' \
--header 'X-Organization-Key: {{organization_key}}' \
--header 'Content-Type: application/json' \
--data '{
    "region": "en",
    "converter_name": "test",
    "sn": "6QCD0000000000",
    "camera": "165-0-7",
    "video": "normal-0",
    "idle_timeout": 500,
    "video_quality": 0,
    "bypass_option": {
        "url": "rtmp://xx.xx.xx"
    },
    "rtmp_url": "rtmp://xx.xx.xx"
}'

Responses

🟢200成功

application/json

Bodyapplication/json

Example

{
    "code": 0,
    "message": "OK",
    "data": {
        "code": 0,
        "message": "OK",
        "data": {
            "converter_id": "160FDCB4E94171AB9F7A86A5F5B1C990",
            "create_ts": 1704167612,
            "update_ts": 1704167612,
            "converter_state": "running"
        },
        "converter_id": "160FDCB4E94171AB9F7A86A5F5B1C990",
        "create_ts": 1704167612,
        "update_ts": 1704167612,
        "converter_state": "running"
    }
}

🟠401未授权

Modified at 2025-03-03 09:28:03

Error Code

Stop Stream Forwarding