Help Center/ Meeting/ Server API Reference/ Bulletin Board Management/ Bulletin Board Program Management/ Adding a Bulletin Board Program
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Adding a Bulletin Board Program

Description

This API is used to add a bulletin board program.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

POST

Request Address

/v1/usg/sss/programs

Transport Protocol

HTTPS

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Location

Description

X-Access-Token

Yes

String

Header

Authorization token. Use the value of accessToken in the response to the request for Authenticating an App ID.

X-Request-Id

No

String

Header

Request ID, which is used for fault tracing and locating. You are advised to use a UUID. If this parameter is not carried, a request ID is automatically generated.

Accept-Language

No

String

Header

Language. Values: zh-CN for Chinese (default) and en-US for English.

programName

Yes

String

Body

Program name.

programItemList

Yes

Array of ProgramItemRequestBase objects

Body

Program material list.
Table 3 ProgramItemRequestBase data structure

Parameter

Mandatory

Type

Location

Description

materialId

Yes

String

Body

Material ID.

playTime

Yes

Integer

Body

Playback duration.

Status Codes

Table 4 Status codes

HTTP Status Code

Description

200

Operation successful.

400

Invalid parameters.

401

Authentication is not performed or fails.

403

Insufficient permissions.

500

Server exception.

Response Parameters

None

Example Request

POST /v1/usg/sss/programs
Connection: keep-alive
X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE
content-type: application/json
Content-Length: 128
Host: api.meeting.huaweicloud.com 
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191))

{
    "programItemList": [
        {
            "materialId": "dcf8988212414ecba07368ed1d5f8916",
            "playTime": 10
        }
    ],
    "programName": "kY234TVnlL"
}

Example Response

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: afd3e12b2d9fa554d3526sd5d66ca0sc

Error Codes

If an error code starting with MMC or USG is returned when you use this API, rectify the fault by following the instructions provided in Huawei Cloud API Error Center.

Example cURL Command

curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stbH3o4N83uDQPOcFtScKC9nbqCXt3cIDB1U' -d '{"programItemList": [{"materialId": "dcf8988212414ecba07368ed1d5f8916","playTime": 10}],"programName": "kY234TVnlL"}'
https://api.meeting.huaweicloud.com/v1/usg/sss/programs