Livestream/Livestream Sharing & Forwarding/Bypass Streaming

Create / Enable / Disable / Update Stream Forwarder

This endpoint executes four operations based on the request body:

① Create Forwarder (no converter_id) Create a new bypass push-stream transcoder. schema defaults to rtmp if omitted. auto_push_stream=false persists config without starting the stream (can be enabled later via ②); omitting the field or setting auto_push_stream=true starts streaming immediately (default).

② Enable Streaming (converter_id + auto_push_stream=true) Resume streaming for a created-but-not-started or stopped forwarder. Configuration is reused — no need to re-supply device parameters.

③ Disable Streaming (converter_id + auto_push_stream=false) Stop streaming for the specified forwarder while retaining configuration. Can be re-enabled at any time. Unlike DELETE, which destroys the configuration.

④ Update Configuration (converter_id, no auto_push_stream) Update converter_name, sn, camera, video_type, schema/bypass_option. The forwarder must be in stopped state (error returned otherwise). schema update supports rtmp (requires bypass_option.url) and gb28181 (requires bypass_option.server_id); updating to rtsp is not supported.

Note: sn and camera are binding required fields and must be provided in all scenarios.

post/openapi/v2.0/manage/api/v1.0/stream-converters

Request

  • Base URL
    https://41b04hdzmc.apifox.cn (the document declares no server; this is the origin it was published from)
  • URL
    https://41b04hdzmc.apifox.cn/openapi/v2.0/manage/api/v1.0/stream-converters
  • Auth
    none required

Headers

X-Organization-Keystring required

Organization Authentication Key (used by OpenAPI third-party callers)

X-Request-Idstring

Request Trace ID

x-user-tokenstring required

User Authentication Token

Request body

converter_idstring

Forwarder ID. Required for enable/disable/update; omit when creating.

auto_push_streamboolean

Stream control. Create (no converter_id): false=persist without streaming, omit/true=stream immediately (default). Enable/Disable (with converter_id): true=enable, false=stop (config retained). Update (converter_id, no auto_push_stream): field ignored.

snstring required

Aircraft SN (required in all scenarios; not used by handler in enable/disable/update but enforced by binding validation)

camerastring required

Camera identifier (required in all scenarios, same as above)

videostring required

Video stream identifier, fixed value normal-0.

video_typestring

Video type (e.g. normal-0)

schema'rtmp' | 'rtsp' | 'gb28181'

Push protocol: rtmp / rtsp / gb28181. Defaults to rtmp if omitted. Update supports rtmp (requires bypass_option.url) and gb28181 (requires bypass_option.server_id); updating to rtsp is not supported.

rtmp_urlstring

RTMP push URL (alternative to bypass_option.url; bypass_option.url takes precedence)

converter_namestring

Transcoder name (optional)

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.