Updated on 2023-12-22 GMT+08:00

Configuring Event Push

Description

This API is used by an administrator to configure meeting event subscription at the enterprise level.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

POST

Request Address

/v1/mmc/management/webhook/link-config

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.

corpId

No

String

Body

Enterprise ID. This parameter is mandatory for enterprise registration callback.

spId

No

String

Body

SP ID. In the multi-tenant scenario, this parameter is mandatory for SP registration callback.

subscriberId

Yes

String

Body

Subscriber ID.

subscriberKey

Yes

String

Body

Subscriber password.

url

Yes

String

Body

Subscription URL.

NOTE:

HTTPS must be used.

Status Codes

Table 3 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/mmc/management/webhook/link-config
Connection: keep-alive
X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC
Content-Type: application/json
user-agent: WeLink-desktop
Content-Length: 372
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{   "corpId": "1387317060",  
    "subscriberId": "12345678",
    "subscriberKey": "123465",
    "url": "https://meeting.huaweicloud.com" 
}

Example Response

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 1157
Connection: keep-alive
http_proxy_id: 462abfcfa8a41c2c5450eb7648bf5ad2
Server: api-gateway
X-Request-Id: 7ba6f742610c03a64262b126fb336a5d

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:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -d '{"corpId": "1387317060","subscriberId": "12345678","subscriberKey": "123465","url": "https://meeting.huaweicloud.com"}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/webhook/link-config'