Read All Iotum Video Hosts in a Domain

get https://{server}/ns-api/v2/domains/{domain}/video/hosts

Responses

Response body

array of objects

object

integer

required

The meeting id

domain

string

required

length ≤ 64

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (*).

user

string

required

This is the main user extension for the user account.

description

string

The description about the meeting

current_timestamp

date-time

required

The current timestamp value of the meeting

meeting-calendar-invite-id

string

The read only value for the meeting to use with calendar integration

meeting-ordinal-sequence

integer

The read only value for the meeting with manage the calendar integrations

core-server

string

The core server which the meeting was created on and events are driven from

chat-session-id

string

The read only value identifying the meeting chat room session

meeting-registration-id

string

The token value for guest to use to register for a webinar

meeting-instance-id

string

The instance value of a meeting with used to associate with a recording or differentiating recurring meetings

meeting-name

string

The descriptive name of the meeting

meeting-type

string

Defaults to conference

The meeting category either the standard meeting 'conference' or a webinar style meeting by using 'presentation'

presentation conference

limits-max-participants

integer

The maximum number of participants allows in the meeting

meeting-status

required

The current status of the meeting

meeting-schedule-start-datetime

date-time

required

The scheduled start time for the meeting

timezone

string

required

The timezone which the meeting was created with

US/Alaska US/Central US/Eastern US/Hawaii US/Mountain US/Pacific Africa/Addis_Ababa Africa/Algiers Africa/Brazzaville Africa/Cairo Africa/Casablanca Africa/Dakar Africa/Dar_es_Salaam Africa/Djibouti Africa/Johannesburg Africa/Khartoum Africa/Kigali Africa/Kinshasa Africa/Lagos Africa/Nairobi Africa/Timbuktu Africa/Tripoli Africa/Tunis America/Antigua America/Aruba America/Belize America/Bogota America/Buenos_Aires America/Cancun America/Caracas America/Cayman America/Chihuahua America/Costa_Rica America/Denver America/Detroit America/Edmonton America/El_Salvador America/Ensenada America/Grenada America/Guadeloupe America/Guatemala America/Havana America/Indianapolis America/Jamaica America/Juneau America/La_Paz America/Lima America/Los_Angeles America/Louisville America/Martinique America/Mazatlan America/Mendoza America/Menominee America/Merida America/Mexico_City America/Miquelon America/Moncton America/Monterrey America/Montevideo America/Montreal America/Montserrat America/Nassau America/New_York America/Panama America/Phoenix America/Port-au-Prince America/Port_of_Spain America/Regina America/Santiago America/Santo_Domingo America/Sao_Paulo America/Thule America/Thunder_Bay America/Tijuana America/Toronto America/Vancouver America/Winnipeg America/Yellowknife Antarctica/South_Pole Arctic/Longyearbyen Asia/Amman Asia/Baghdad Asia/Bahrain Asia/Bangkok Asia/Beirut Asia/Brunei Asia/Calcutta Asia/Colombo Asia/Dacca Asia/Damascus Asia/Dhaka Asia/Dubai Asia/Gaza Asia/Hong_Kong Asia/Istanbul Asia/Jakarta Asia/Jerusalem Asia/Kabul Asia/Katmandu Asia/Kuala_Lumpur Asia/Kuching Asia/Kuwait Asia/Macau Asia/Manila Asia/Muscat Asia/Phnom_Penh Asia/Rangoon Asia/Riyadh Asia/Saigon Asia/Seoul Asia/Shanghai Asia/Singapore Asia/Taipei Asia/Tehran Asia/Tel_Aviv Asia/Thimphu Asia/Tokyo Asia/Ulan_Bator Asia/Vientiane Asia/Vladivostok Atlantic/Azores Atlantic/Bermuda Atlantic/Canary Atlantic/Cape_Verde Atlantic/Faeroe Atlantic/Reykjavik Australia/ACT Australia/Adelaide Australia/Brisbane Australia/Canberra Australia/Darwin Australia/LHI Australia/Melbourne Australia/North Australia/NSW Australia/Perth Australia/Queensland Australia/South Australia/Sydney Australia/Tasmania Australia/Victoria Australia/West Canada/Atlantic Canada/Central Canada/Eastern Canada/Mountain Canada/Newfoundland Canada/Pacific Canada/Saskatchewan Canada/Yukon Cuba Etc/GMT Etc/GMT+1 Etc/GMT+10 Etc/GMT+11 Etc/GMT+12 Etc/GMT+2 Etc/GMT+3 Etc/GMT+4 Etc/GMT+5 Etc/GMT+6 Etc/GMT+7 Etc/GMT+8 Etc/GMT+9 Etc/GMT-1 Etc/GMT-10 Etc/GMT-11 Etc/GMT-12 Etc/GMT-13 Etc/GMT-14 Etc/GMT-2 Etc/GMT-3 Etc/GMT-4 Etc/GMT-5 Etc/GMT-6 Etc/GMT-7 Etc/GMT-8 Etc/GMT-9 Etc/Greenwich Europe/Amsterdam Europe/Athens Europe/Belfast Europe/Belgrade Europe/Berlin Europe/Brussels Europe/Bucharest Europe/Budapest Europe/Copenhagen Europe/Dublin Europe/Helsinki Europe/Istanbul Europe/Kiev Europe/Lisbon Europe/Ljubljana Europe/London Europe/Madrid Europe/Malta Europe/Monaco Europe/Moscow Europe/Oslo Europe/Paris Europe/Prague Europe/Rome Europe/Sofia Europe/Stockholm Europe/Vienna Europe/Warsaw Europe/Zurich Greenwich Pacific/Auckland Pacific/Easter Pacific/Fiji Pacific/Galapagos Pacific/Gambier Pacific/Guam Pacific/Honolulu Pacific/Marquesas Pacific/Midway Pacific/Palau Pacific/Rarotonga Pacific/Tahiti

meeting-schedule-duration-minutes

integer

The scheduled length of the meeting

meeting-schedule-recurrence-rule

string

The read only value describing the recuring nature of the meeting using RFC 5545

meeting-video-allowed-from

string

The value indicating which attendee types can share video

everyone host presenters

meeting-audio-allowed-from

string

The value indicating which attendee types can share audio

everyone host presenters

meeting-chat-enabled

integer

Defaults to 1

The value indicating if chat is enabled for this meeting

meeting-chat-history-enabled

integer

Defaults to 1

The value indicating if chat is enabled for this meeting

meeting-question-answer-enabled

integer

Defaults to 0

The value indicating if question and answer feature is enabled

meeting-recording-enabled

integer

Defaults to 0

The value indicating if question and answer feature is enabled

meeting-join-require-invite-enabled

integer

Defaults to 0

The value indicating if question and answer feature is enabled

meeting-join-require-passcode-enabled

integer

Defaults to 0

The value indicating if question and answer feature is enabled

meeting-require-host-to-begin-enabled

integer

Defaults to 0

The value indicating if question and answer feature is enabled

meeting-allow-changes-from-hosts-enabled

integer

Defaults to 1

The value indicating if chat is enabled for this meeting

meeting-hide-attendee-list-enabled

integer

Defaults to 0

The value indicating if question and answer feature is enabled

meeting-lock-enabled

integer

Defaults to 0

The value indicating if question and answer feature is enabled

meeting-lock-allowed

string

The value indicating if the meeting is allowed to be locked

meeting-room-enabled

integer

required

Defaults to 0

The value indicating if question and answer feature is enabled

meeting-dial-in-number-blob

The number for audio-only users to dial in to the meeting

meeting-passcode

string

The passcode used to enter meeting if it is required

meeting-previous-presenter-attendee-id

string

The value of the previous attendee that prsented their screen

meeting-presenter-attendee-id

string

The value of the current attendee that is sharing their screen

meeting-video-layout

string

The current meeting layout default for entire meeting

spotlight conversation grid

last-modified-datetime

date-time

The timestamp of the last time the meeting was modified

meeting-instance-actual-start-datetime

date-time

The timestamp the current meeting instance was started

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://ns-api.com/ns-api/v2/domains/~/video/hosts' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

401Authentication Required

404Record not found