Help Center/ Meeting/ Server API Reference/ Meeting Event Push/ Configuring Enterprise-Level Meeting Event Push/ APIs/ Querying Event Push
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Event Push

Description

This API is used by an administrator to query the event subscription settings of an enterprise.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

GET

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

Query

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

spId

No

String

Query

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

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

Table 4 Response parameters

Parameter

Type

Description

returnCode

Integer

Result code.

returnDesc

string

Result description.

id

string

ID of a subscription configuration record.

subscriberId

string

Subscription ID.

url

string

Subscription URL.

status

Integer

Event push status.

  • 0: enabled.
  • 1: disabled.
  • 2: locked.

Example Request

GET /v1/mmc/management/webhook/link-config?corpId=1387317060
Connection: keep-alive
X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC
user-agent: WeLink-desktop
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

Example Response

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

{
   "id": "b958adc3639b11ecb310e97279c39e66",
   "subscriberId": "12345678",
   "url": "https://meeting.huaweicloud.com",
   "status": 1
}

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 -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' 
'https://api.meeting.huaweicloud.com/v1/mmc/management/webhook/link-config?corpId=1387317060'
Parent topic: APIs