Channel Change Callback Notification
Purpose
When a channel is created or deleted in the legacy admin panel, or when a channel is created, deleted, modified (editing live room information only), or its viewing conditions are changed in the new admin panel, Polyv will send a callback notification to the configured callback URL.
Details
Request Method
POST
Request Content-Type
application/json
Normal Response
如果您正常接收到请求，10秒内返回http状态码为200即可。
若超时或者返回http状态码非200，保利威将在间隔5秒、10秒发起重试。（只要有一次请求成功，下次将不再发起重试）
Callback Parameter Description
Note: Request parameters are obtained from Query parameters
| Parameter | Type | Description |
|---|---|---|
| timestamp | Long | Request timestamp |
| sign | String | Encrypted string for verification. Generation rule: md5(AppSecret+timestamp). AppSecret is the secret key of the live streaming system |
Note: Request parameters are obtained from the body
Fields for callback when type is delete
| Parameter | Type | Description |
|---|---|---|
| type | String | Operation type, delete for deletion |
| channelId | String | Channel ID |
| operationTime | Long | Operation timestamp, a 13-digit timestamp |
Fields for callback when type is create or update
| Parameter | Type | Description |
|---|---|---|
| type | String | Operation type, create for creation, update for modification |
| channelId | String | Channel ID |
| operationTime | Long | Operation timestamp, a 13-digit timestamp |
| categoryName | String | Category name of the channel |
| scene | String | Live streaming scene of the channel. topclass - Large class, double - Dual-teacher class, train - Enterprise training, seminar - Seminar, alone - Event marketing, portrait - E-commerce live streaming |
| pureRtcEnabled | String | Whether ultra-low latency is enabled. Y indicates enabled, N indicates disabled |
| linkMicLimit | Integer | Maximum number of participants for co-streaming |
| transmitType | String | Relay channel type. normal - Relay not enabled, transmit - Initiating relay, receive - Receiving relay |
| coverImg | String | Live streaming cover image |
| liveType | String | Live streaming template. ppt - Document + video, alone - Video only, topclass - Video only - Fast (formerly Large class), seminar - Seminar |
| startTime | String | Live streaming start time, e.g., 2022-01-20 00:00:00 |
| watchType | String | Viewing template. normal - Landscape, portrait - Portrait |
| name | String | Channel name |
| bgImg | String | Pre-show image |
| splashImg | String | Splash image |
| publisher | String | Host |
Fields for callback when type is auth
| Parameter | Type | Description |
|---|---|---|
| channelId | String | Channel ID |
| userId | String | User ID |
| rank | Integer | Used to set two viewing conditions for one channel. Value is 1 or 2 (1 for primary condition, 2 for secondary condition) |
| globalSettingEnabled | String | Whether global settings are enabled (this value is only valid for the legacy admin panel) Y: Enabled N: Disabled |
| enabled | String | Whether viewing conditions are enabled Y: Enabled N: Disabled |
| authType | String | Viewing condition type none: No restriction code: Verification code viewing pay: Paid viewing phone: Whitelist viewing info: Registration viewing wxshare: Share viewing custom: Custom authorization viewing external: External authorization viewing direct: Independent authorization |
| subAuthType | String | Corresponding value when authType is none. public - Public viewing, wx - WeChat authorization |
| wxAuthExpireValue | String | When subAuthType is wx, the corresponding WeChat authorization validity period, e.g., 3d means 3 days, 3h means 3 hours |
| codeAuthTips | String | Prompt message for verification code viewing condition |
| authCode | String | Verification code for verification code viewing |
| qcodeTips | String | QR code prompt for verification code viewing |
| qcodeImg | String | QR code image for verification code viewing |
| payAuthTips | String | Prompt message for paid viewing |
| price | Float | Price for paid viewing, unit: yuan |
| watchEndTime | Long | Deadline for paid viewing. null means: one-time payment, permanently valid |
| validTimePeriod | Integer | Validity duration for paid viewing (days) |
| customKey | String | Key for custom authorization viewing |
| customUri | String | Interface URL for custom authorization viewing |
| externalKey | String | Key for external authorization viewing |
| externalUri | String | Interface URL for external authorization viewing |
| externalRedirectUri | String | Redirect URL for external authorization viewing when users directly access the viewing page |
| externalButtonEnabled | String | Login button for external authorization viewing. Y for enabled, N for disabled. When enabled, the guide page will display a login button when users access the link |
| directKey | String | Key for independent authorization |
| trialWatchEnabled | String | Trial watch toggle for paid viewing. Default is N Y: On N: Off |
| trialWatchTime | Integer | Trial watch duration, in minutes |
| trialWatchEndTime | Long | Trial watch expiration date. null means permanently valid for this channel |
| whiteListInputTips | String | Input prompt for whitelist |
| whiteListEntryText | String | Entry text for whitelist |
| onceWhitelistEnabled | String | Whether the whitelist cannot be reused. Default is N. Y: Yes, N: No |
| authTips | String | Prompt message for whitelist viewing |
| infoDesc | String | Description field for registration viewing |
| infoAuthTips | String | Prompt message for registration viewing condition |
Request Body Example
Request Query Example
sign=8cc3607a4eb5bb3b5ded247b36c11c03×tamp=1662081806366
Request JSON Example
{
"type": "create",
"operationTime": 1660286426422,
"channelId": 3289191,
"categoryName": "默认分类",
"scene": "topclass",
"pureRtcEnabled": "N",
"linkMicLimit": 0,
"transmitType": "normal",
"startTime": "",
"coverImg": "//liveimages.videocc.net/uploaded/images/2022/08/gcfk857g37.png",
"liveType": "ppt",
"watchType": "normal"
}
How to Configure
Prerequisite: The account needs to have the channel modification callback feature enabled. If this feature is not enabled, the "Live Room Information Modification Callback URL" option will not appear in the callback settings.
Configuration via the admin panel:
Log in to your account - Go to [Cloud Live Streaming] - Click [Developer Settings] - Click [Callback Settings] - Find "Live Room Information Modification Callback URL"
Note: The submitted interface address must start with http:// or https://
If you cannot find the corresponding setting, it may be due to insufficient account permissions. For assistance, please contact the online customer service at the bottom right corner.
