RTMP stream publishing and pulling scheduling

1 Description

Calling this interface can initiate RTMP streaming scheduling, supporting both "pull" and "publish" scheduling modes.

When you need to manually publish or pull RTMP streaming from ZEGOCLOUD's audio and video cloud, you can use this interface to obtain the RTMP streaming publish or pull nodes. After developers pass the stream ID (StreamId), scheduling mode (Type), client IP (ClientIP), and sequence number (Sequence) to the server, ZEGOCLOUD media server (RTC service) returns the scheduling result set for clients to publish or pull streams.

For example, when using third-party streaming tools like OBS to publish RTMP streams, scheduling for streaming is required. Similarly, when using a third-party player to pull and play RTMP streams, scheduling for pulling streams is necessary.

2 Interface prototype

• Request method：GET
• Request address：https://rtc-api.zego.im/?Action=RTMPDispatchV2
• Transfer protocol：HTTPS
• Call frequency limit (under the same AppID): 40 times per second

3 Request parameters

Listed below are the parameters specific to this request and part of the public request parameters. For the complete list of public request parameters, see Server APIs public request parameters.

4 Request example

https://rtc-api.zego.im/?Action=RTMPDispatchV2
&StreamId=rtc01
&Sequence=1617249600001
&Type=pull
&ClientIP=47.102.152.118
&<Public request parameters>

5 Response parameters

6 Response example

{
    "Code":0,
    "Message":"ok",
    "RequestId":"5094436160208407316",
    "Data":[
        "rtmp://81.69.49.115:1935/1540531164/caodantest"
    ]
}

7 Return code

Listed below are the return codes related to this API. For the complete list of return codes, see Return codes.

Instructions for using the old interface

{
    "Code":0,
    "Message":"ok",
    "RequestId":"5094436160208407316",
    "Data":[
        "81.69.49.115:1935"
    ]
}