Get webinar details

Retrieve details from live or past webinars.

Scopes: dashboard_webinars:read:admin
Rate Limit Label: Heavy
Prerequisites:

Business, Education or API Plan with Webinar add-on.

{ "uuid": "CJaaaaaaaEV6A==", "id": 00001, "topic": "MyTestWebinar", "host": "Henry Chao", "email": "hc@sdfdfdsfdfsdf.com", "user_type": "Pro|Webinar1000", "start_time": "2019-07-16T17:14:39Z", "end_time": "2019-07-16T17:26:20Z", "duration": 12, "participants": 1, "has_pstn": false, "has_voip": false, "has_3rd_party_audio": false, "has_video": false, "has_screen_share": false, "has_recording": false, "has_sip": false }

请求参数

Path 参数

webinarId

string

必需

The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance.

If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.

Query 参数

type

enum<string>

可选

The webinar type.

枚举值:

pastlive

默认值:

live

返回响应

🟢200**HTTP Status Code:** `200` Webinar details returned. Only available for paid accounts that have enabled the Dashboard feature.

application/json

Body

Webinar metric details.

custom_keys

array [object {2}]

可选

Custom keys and values assigned to the Webinar.

<= 10 items

key

string

可选

Custom key associated with the Webinar.

<= 64 字符

value

string

可选

Value of the custom key associated with the Webinar.

<= 256 字符

dept

string

可选

Department of the host.

duration

string

可选

Webinar duration, formatted as hh:mm:ss, for example: 10:00 for ten minutes.

string

可选

User email.

end_time

string <date-time>

可选

Webinar end time.

has_3rd_party_audio

boolean

可选

Indicates whether or not TSP was used for the Webinar.

has_pstn

boolean

可选

Indicates whether or not PSTN was used for the Webinar.

has_recording

boolean

可选

Indicates whether or not recording was used for the Webinar.

has_screen_share

boolean

可选

Indicates whether or not screen sharing was used for the Webinar.

has_sip

boolean

可选

Indicates whether or not SIP was used for the Webinar.

has_video

boolean

可选

Indicates whether or not video was used for the Webinar.

has_voip

boolean

可选

Indicates whether or not VoIP was used for the Webinar.

host

string

可选

User display name.

integer <int64>

可选

Webinar ID in "long" format(represented as int64 data type in JSON), also known as the webinar number.

participants

integer

可选

Webinar participant count.

start_time

string <date-time>

可选

Webinar start time.

topic

string

可选

Webinar topic.

user_type

string

可选

User type.

uuid

string <uuid>

可选

Webinar UUID.

🔵300**Error Code:** `200` Can not access webinar info, {webinarId}.

🟠404**HTTP Status Code:** `404` **Error Code:** `3001` The webinar has not ended yet or the Webinar ID is not valid. This webinar's detail is not available.