Note: By default, callbacks of the old version are enabled after you activate Kingsoft Cloud Live Service (KLS). We recommend that you enable callbacks of the new version in the KLS console.

Callbacks of the new version at the start and end of stream pushing

Callbacks of the new version use the JSON format. You can enable callbacks of the new version in the KLS console.

Callback at the start of stream pushing

When stream pushing over RTMP begins, the corresponding callback API is called. The following table describes the callback parameters.

Sample callback at the start of stream pushing

{
    "Version":"1.0",
    "App":"live",
    "Pubdomain":"xxx.xxx.com",
    "Stream":"test",
    "PubStartUnixTime":"1456800010000",
    "NotifyType":"PubStart",
    "ClientIp":" ",
    "ClientPort":" ",
    "Node":" ",
    "PubParam":{
        "param1": "123456",
        "param2":11
    }
}

Callback at the end of stream pushing

When stream pushing over RTMP ends, the corresponding callback API is called. The following table describes the callback parameters.

Sample callback at the end of stream pushing

{
    "Version":"1.0",
    "App":"live",
    "Pubdomain":"xxx.xxx.com",
    "Stream":"test",
    "PubEndUnixTime":1456800010000,
    "NotifyType":"PubEnd",
    "ClientIp":" ",
    "ClientPort":" ",
    "Node":" ",
    "PubEndMessage":" ",
    "PubParam":{
        "param1":"123456",
        "param2":11
    }
}

Callbacks of the old version at the start and end of stream pushing

In the old version, the callback URLs for notifying the start and end of RTMP stream pushing use the HTTP POST method. The parameters of the callback API include the app name, stream name, request type (the call parameter), and the flashver, swfurl, and tcurl parameters that are associated with the stream pushing. The value of the call parameter is user_publish at the start of stream pushing, and user_publish_done at the end of stream pushing.

Callback at the start of stream pushing

When stream pushing over RTMP begins, the corresponding callback API is called.

Example

HTTP body
app=live&name=asdf&swfurl=nil&flashver=nil&tcurl=rtmp://test.uplive.ks-cdn.com/live&call=user_publish&vdoid=123456

The parameters of the callback API include the app name, stream name, request type (the call parameter), and the flashver, swfurl, and tcurl parameters that are associated with the stream pushing. The value of the call parameter is user_publish at the start of stream pushing, and user_publish_done at the end of stream pushing.

Parameter description

Callback at the end of stream pushing

When stream publishing over RTMP ends, the corresponding callback API is called.

Example

HTTP header
POST /callback HTTP/1.0
Host: Notification host provided by the user
Connection: close
Content-Length: 128

HTTP body
app=live&name=asdf&swfurl=nil&flashver=nil&tcurl=rtmp://test.uplive.ks-cdn.com/live&call=user_publish_done&close_mode=nil&vdoid=123456

Parameter description

Error description