Meetings API
Starting on August 31st 2024, users will no longer be able to create Meetings API applications. Existing applications will continue to work uninterrupted until June 30th, 2025. If you are looking to build with video, please consider Vonage Video API or Vonage Video Express services, or contact your account managers or support for help.
Opérations disponibles
Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
Demande de renseignements Paramètres
The room serial number to filter from - This number is not the room Id
The room serial number to filter to (excluding end_id itself) - This number is not the room Id
20The maximum number of rooms in the current page
25The number of results returned on this page
30The overall number of results
9f6fe8ae-3458-4a72-b532-8276d5533e97The room UUID
200My custom roomThe name of the meeting room
500Welcome to my custom roomFree text that can be attached to a room. This will be passed in the form of a header in events related to this room.
instantThe type of meeting which can be instant or long term. An instant is active for 10 minutes until the first participant joins the roo, and remains active for 10 minutes after the last participant leaves. A long term room expires after a specific date
instantlong_termAn object containing various meeting recording options
Automatically record all sessions in this room. Recording cannot be stopped when this is set to true.
Record only the owner screen or any share screen of the video.
9280674154The meeting PIN number
trueOnce a room becomes unavailable, no new sessions can be created under it
ef2b46f3-8ebb-437e-a671-272e4990fbc8The theme UUID
{}The time for when the room was created, expressed in ISO 8601 format
{}The time for when the room will be expired, expressed in ISO 8601 format. The value must be greater than 10 minutes from now
trueClose the room after a session ends. Only relevant for long_term rooms
The level of approval needed to join the meeting in the room. When set to "after_owner_only" the participants will join the meeting only after the host joined. When set to "explicit_approval" the participants will join the waiting room and the host will deny/approve them.
noneafter_owner_onlyexplicit_approvalSets the default options for participants
defaultonSet the default microphone option for users in the pre-join screen of this room.
onoffdefaultProvides callback URLs to listen to events
https://example.com/roomsCallback url for rooms events, overrides application level rooms callback url.
https://example.com/sessionsCallback url for sessions events, overrides application level sessions callback url.
https://example.com/recordingsCallback url for recordings events, overrides application level recordings callback url.
trueDetermine if recording feature is available in the UI.
trueDetermine if chat feature is available in the UI.
trueDetermine if whiteboard feature is available in the UI.
trueDetermine if the locale switcher is available in the UI.
Determine if captions are available in the UI.
Provides options to customize the user interface
enesThe desired language of the UI. The default is English.
arcadeenesfrheitpt-brzh-twzh-cnProvides links to join the meeting room
The link to join the meeting as participant, using the meeting code
https://meetings.vonage.com/280674154The link to join the meeting as host, using the meeting code
https://meetings.vonage.com/?room_token=280674154&participant_token=eyJhbGciOiJIUzI1NiIsInR5cCRepresents HAL links for navigation purposes
Provides a link to the first element
https://api-eu.vonage.com/v1/meetings/rooms?page_size=50Provides a link to the current element
https://api-eu.vonage.com/v1/meetings/rooms?page_size=50&start_id=2293905Provides a link to the next element
https://api-eu.vonage.com/v1/meetings/rooms?page_size=50&start_id=2293906Provides a link to the previous element
https://api-eu.vonage.com/v1/meetings/rooms?page_size=50&start_id=2293904Exemple Réponse
{
"page_size": 25,
"total_items": 30,
"_embedded": [
{
"id": "9f6fe8ae-3458-4a72-b532-8276d5533e97",
"display_name": "My custom room",
"metadata": "Welcome to my custom room",
"type": "instant",
"recording_options": {
"auto_record": false,
"record_only_owner": false
},
"meeting_code": "280674154",
"is_available": true,
"theme_id": "ef2b46f3-8ebb-437e-a671-272e4990fbc8",
"created_at": {},
"expires_at": {},
"expire_after_use": true,
"join_approval_level": "none",
"initial_join_options": {
"microphone_state": "on"
},
"callback_urls": {
"rooms_callback_url": "https://example.com/rooms",
"sessions_callback_url": "https://example.com/sessions",
"recordings_callback_url": "https://example.com/recordings"
},
"available_features": {
"is_recording_available": true,
"is_chat_available": true,
"is_whiteboard_available": true,
"is_locale_switcher_available": true,
"is_captions_available": false
},
"ui_settings": {
"language": "es"
},
"_links": {
"guest_url": {
"href": "https://meetings.vonage.com/280674154"
},
"host_url": {
"href": "https://meetings.vonage.com/?room_token=280674154&participant_token=eyJhbGciOiJIUzI1NiIsInR5cC"
}
}
}
],
"_links": {
"first": {
"href": "https://api-eu.vonage.com/v1/meetings/rooms?page_size=50"
},
"self": {
"href": "https://api-eu.vonage.com/v1/meetings/rooms?page_size=50&start_id=2293905"
},
"next": {
"href": "https://api-eu.vonage.com/v1/meetings/rooms?page_size=50&start_id=2293906"
},
"prev": {
"href": "https://api-eu.vonage.com/v1/meetings/rooms?page_size=50&start_id=2293904"
}
}
}Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
200My custom roomThe name of the meeting room
500Welcome to my custom roomFree text that can be attached to a room. This will be passed in the form of a header in events related to this room.
instantRepresents a room that is active for 10 minutes until the first participant joins the room, and remains active for 10 minutes after the last participant leaves.
instantAn object containing various meeting recording options
Automatically record all sessions in this room. Recording cannot be stopped when this is set to true.
Record only the owner screen or any share screen of the video.
ef2b46f3-8ebb-437e-a671-272e4990fbc8The theme UUID
The level of approval needed to join the meeting in the room. When set to "after_owner_only" the participants will join the meeting only after the host joined. When set to "explicit_approval" the participants will join the waiting room and the host will deny/approve them.
noneafter_owner_onlyexplicit_approvalSets the default options for participants
defaultonSet the default microphone option for users in the pre-join screen of this room.
onoffdefaultProvides callback URLs to listen to events
https://example.com/roomsCallback url for rooms events, overrides application level rooms callback url.
https://example.com/sessionsCallback url for sessions events, overrides application level sessions callback url.
https://example.com/recordingsCallback url for recordings events, overrides application level recordings callback url.
trueDetermine if recording feature is available in the UI.
trueDetermine if chat feature is available in the UI.
trueDetermine if whiteboard feature is available in the UI.
trueDetermine if the locale switcher is available in the UI.
Determine if captions are available in the UI.
Provides options to customize the user interface
enesThe desired language of the UI. The default is English.
arcadeenesfrheitpt-brzh-twzh-cnExemple Demande
{
"display_name": "My custom room",
"metadata": "Welcome to my custom room",
"type": "instant",
"recording_options": {
"auto_record": false,
"record_only_owner": false
},
"theme_id": "ef2b46f3-8ebb-437e-a671-272e4990fbc8",
"join_approval_level": "none",
"initial_join_options": {
"microphone_state": "on"
},
"callback_urls": {
"rooms_callback_url": "https://example.com/rooms",
"sessions_callback_url": "https://example.com/sessions",
"recordings_callback_url": "https://example.com/recordings"
},
"available_features": {
"is_recording_available": true,
"is_chat_available": true,
"is_whiteboard_available": true,
"is_locale_switcher_available": true,
"is_captions_available": false
},
"ui_settings": {
"language": "es"
}
}{
"display_name": "My custom room",
"metadata": "Welcome to my custom room",
"type": "instant",
"recording_options": {
"auto_record": false,
"record_only_owner": false
},
"theme_id": "ef2b46f3-8ebb-437e-a671-272e4990fbc8",
"join_approval_level": "none",
"initial_join_options": {
"microphone_state": "on"
},
"callback_urls": {
"rooms_callback_url": "https://example.com/rooms",
"sessions_callback_url": "https://example.com/sessions",
"recordings_callback_url": "https://example.com/recordings"
},
"available_features": {
"is_recording_available": true,
"is_chat_available": true,
"is_whiteboard_available": true,
"is_locale_switcher_available": true,
"is_captions_available": false
},
"ui_settings": {
"language": "es"
}
}9f6fe8ae-3458-4a72-b532-8276d5533e97The room UUID
200My custom roomThe name of the meeting room
500Welcome to my custom roomFree text that can be attached to a room. This will be passed in the form of a header in events related to this room.
instantThe type of meeting which can be instant or long term. An instant is active for 10 minutes until the first participant joins the roo, and remains active for 10 minutes after the last participant leaves. A long term room expires after a specific date
instantlong_termAn object containing various meeting recording options
Automatically record all sessions in this room. Recording cannot be stopped when this is set to true.
Record only the owner screen or any share screen of the video.
9280674154The meeting PIN number
trueOnce a room becomes unavailable, no new sessions can be created under it
ef2b46f3-8ebb-437e-a671-272e4990fbc8The theme UUID
{}The time for when the room was created, expressed in ISO 8601 format
{}The time for when the room will be expired, expressed in ISO 8601 format. The value must be greater than 10 minutes from now
trueClose the room after a session ends. Only relevant for long_term rooms
The level of approval needed to join the meeting in the room. When set to "after_owner_only" the participants will join the meeting only after the host joined. When set to "explicit_approval" the participants will join the waiting room and the host will deny/approve them.
noneafter_owner_onlyexplicit_approvalSets the default options for participants
defaultonSet the default microphone option for users in the pre-join screen of this room.
onoffdefaultProvides callback URLs to listen to events
https://example.com/roomsCallback url for rooms events, overrides application level rooms callback url.
https://example.com/sessionsCallback url for sessions events, overrides application level sessions callback url.
https://example.com/recordingsCallback url for recordings events, overrides application level recordings callback url.
trueDetermine if recording feature is available in the UI.
trueDetermine if chat feature is available in the UI.
trueDetermine if whiteboard feature is available in the UI.
trueDetermine if the locale switcher is available in the UI.
Determine if captions are available in the UI.
Provides options to customize the user interface
enesThe desired language of the UI. The default is English.
arcadeenesfrheitpt-brzh-twzh-cnProvides links to join the meeting room
The link to join the meeting as participant, using the meeting code
https://meetings.vonage.com/280674154The link to join the meeting as host, using the meeting code
https://meetings.vonage.com/?room_token=280674154&participant_token=eyJhbGciOiJIUzI1NiIsInR5cCExemple Réponse
{
"id": "9f6fe8ae-3458-4a72-b532-8276d5533e97",
"display_name": "My custom room",
"metadata": "Welcome to my custom room",
"type": "instant",
"recording_options": {
"auto_record": false,
"record_only_owner": false
},
"meeting_code": "280674154",
"is_available": true,
"theme_id": "ef2b46f3-8ebb-437e-a671-272e4990fbc8",
"created_at": {},
"expires_at": {},
"expire_after_use": true,
"join_approval_level": "none",
"initial_join_options": {
"microphone_state": "on"
},
"callback_urls": {
"rooms_callback_url": "https://example.com/rooms",
"sessions_callback_url": "https://example.com/sessions",
"recordings_callback_url": "https://example.com/recordings"
},
"available_features": {
"is_recording_available": true,
"is_chat_available": true,
"is_whiteboard_available": true,
"is_locale_switcher_available": true,
"is_captions_available": false
},
"ui_settings": {
"language": "es"
},
"_links": {
"guest_url": {
"href": "https://meetings.vonage.com/280674154"
},
"host_url": {
"href": "https://meetings.vonage.com/?room_token=280674154&participant_token=eyJhbGciOiJIUzI1NiIsInR5cC"
}
}
}Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
9f6fe8ae-3458-4a72-b532-8276d5533e97The room UUID
200My custom roomThe name of the meeting room
500Welcome to my custom roomFree text that can be attached to a room. This will be passed in the form of a header in events related to this room.
instantThe type of meeting which can be instant or long term. An instant is active for 10 minutes until the first participant joins the roo, and remains active for 10 minutes after the last participant leaves. A long term room expires after a specific date
instantlong_termAn object containing various meeting recording options
Automatically record all sessions in this room. Recording cannot be stopped when this is set to true.
Record only the owner screen or any share screen of the video.
9280674154The meeting PIN number
trueOnce a room becomes unavailable, no new sessions can be created under it
ef2b46f3-8ebb-437e-a671-272e4990fbc8The theme UUID
{}The time for when the room was created, expressed in ISO 8601 format
{}The time for when the room will be expired, expressed in ISO 8601 format. The value must be greater than 10 minutes from now
trueClose the room after a session ends. Only relevant for long_term rooms
The level of approval needed to join the meeting in the room. When set to "after_owner_only" the participants will join the meeting only after the host joined. When set to "explicit_approval" the participants will join the waiting room and the host will deny/approve them.
noneafter_owner_onlyexplicit_approvalSets the default options for participants
defaultonSet the default microphone option for users in the pre-join screen of this room.
onoffdefaultProvides callback URLs to listen to events
https://example.com/roomsCallback url for rooms events, overrides application level rooms callback url.
https://example.com/sessionsCallback url for sessions events, overrides application level sessions callback url.
https://example.com/recordingsCallback url for recordings events, overrides application level recordings callback url.
trueDetermine if recording feature is available in the UI.
trueDetermine if chat feature is available in the UI.
trueDetermine if whiteboard feature is available in the UI.
trueDetermine if the locale switcher is available in the UI.
Determine if captions are available in the UI.
Provides options to customize the user interface
enesThe desired language of the UI. The default is English.
arcadeenesfrheitpt-brzh-twzh-cnProvides links to join the meeting room
The link to join the meeting as participant, using the meeting code
https://meetings.vonage.com/280674154The link to join the meeting as host, using the meeting code
https://meetings.vonage.com/?room_token=280674154&participant_token=eyJhbGciOiJIUzI1NiIsInR5cCExemple Réponse
{
"id": "9f6fe8ae-3458-4a72-b532-8276d5533e97",
"display_name": "My custom room",
"metadata": "Welcome to my custom room",
"type": "instant",
"recording_options": {
"auto_record": false,
"record_only_owner": false
},
"meeting_code": "280674154",
"is_available": true,
"theme_id": "ef2b46f3-8ebb-437e-a671-272e4990fbc8",
"created_at": {},
"expires_at": {},
"expire_after_use": true,
"join_approval_level": "none",
"initial_join_options": {
"microphone_state": "on"
},
"callback_urls": {
"rooms_callback_url": "https://example.com/rooms",
"sessions_callback_url": "https://example.com/sessions",
"recordings_callback_url": "https://example.com/recordings"
},
"available_features": {
"is_recording_available": true,
"is_chat_available": true,
"is_whiteboard_available": true,
"is_locale_switcher_available": true,
"is_captions_available": false
},
"ui_settings": {
"language": "es"
},
"_links": {
"guest_url": {
"href": "https://meetings.vonage.com/280674154"
},
"host_url": {
"href": "https://meetings.vonage.com/?room_token=280674154&participant_token=eyJhbGciOiJIUzI1NiIsInR5cC"
}
}
}Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
Contains information to be updated on the room. It is mandatory to provide at least one value to update; you will receive a 400 response otherwise.
{}The time for when the room will be expired, expressed in ISO 8601 format. The value must be greater than 10 minutes from now
trueClose the room after a session ends. Only relevant for long_term rooms
ef2b46f3-8ebb-437e-a671-272e4990fbc8The theme UUID
The level of approval needed to join the meeting in the room. When set to "after_owner_only" the participants will join the meeting only after the host joined. When set to "explicit_approval" the participants will join the waiting room and the host will deny/approve them.
noneafter_owner_onlyexplicit_approvalSets the default options for participants
defaultonSet the default microphone option for users in the pre-join screen of this room.
onoffdefaultProvides callback URLs to listen to events
https://example.com/roomsCallback url for rooms events, overrides application level rooms callback url.
https://example.com/sessionsCallback url for sessions events, overrides application level sessions callback url.
https://example.com/recordingsCallback url for recordings events, overrides application level recordings callback url.
trueDetermine if recording feature is available in the UI.
trueDetermine if chat feature is available in the UI.
trueDetermine if whiteboard feature is available in the UI.
trueDetermine if the locale switcher is available in the UI.
Determine if captions are available in the UI.
Exemple Demande
{
"update_details": {
"expires_at": {},
"expire_after_use": true,
"theme_id": "ef2b46f3-8ebb-437e-a671-272e4990fbc8",
"join_approval_level": "none",
"initial_join_options": {
"microphone_state": "on"
},
"callback_urls": {
"rooms_callback_url": "https://example.com/rooms",
"sessions_callback_url": "https://example.com/sessions",
"recordings_callback_url": "https://example.com/recordings"
},
"available_features": {
"is_recording_available": true,
"is_chat_available": true,
"is_whiteboard_available": true,
"is_locale_switcher_available": true,
"is_captions_available": false
}
}
}{
"update_details": {
"expires_at": {},
"expire_after_use": true,
"theme_id": "ef2b46f3-8ebb-437e-a671-272e4990fbc8",
"join_approval_level": "none",
"initial_join_options": {
"microphone_state": "on"
},
"callback_urls": {
"rooms_callback_url": "https://example.com/rooms",
"sessions_callback_url": "https://example.com/sessions",
"recordings_callback_url": "https://example.com/recordings"
},
"available_features": {
"is_recording_available": true,
"is_chat_available": true,
"is_whiteboard_available": true,
"is_locale_switcher_available": true,
"is_captions_available": false
}
}
}9f6fe8ae-3458-4a72-b532-8276d5533e97The room UUID
200My custom roomThe name of the meeting room
500Welcome to my custom roomFree text that can be attached to a room. This will be passed in the form of a header in events related to this room.
instantThe type of meeting which can be instant or long term. An instant is active for 10 minutes until the first participant joins the roo, and remains active for 10 minutes after the last participant leaves. A long term room expires after a specific date
instantlong_termAn object containing various meeting recording options
Automatically record all sessions in this room. Recording cannot be stopped when this is set to true.
Record only the owner screen or any share screen of the video.
9280674154The meeting PIN number
trueOnce a room becomes unavailable, no new sessions can be created under it
ef2b46f3-8ebb-437e-a671-272e4990fbc8The theme UUID
{}The time for when the room was created, expressed in ISO 8601 format
{}The time for when the room will be expired, expressed in ISO 8601 format. The value must be greater than 10 minutes from now
trueClose the room after a session ends. Only relevant for long_term rooms
The level of approval needed to join the meeting in the room. When set to "after_owner_only" the participants will join the meeting only after the host joined. When set to "explicit_approval" the participants will join the waiting room and the host will deny/approve them.
noneafter_owner_onlyexplicit_approvalSets the default options for participants
defaultonSet the default microphone option for users in the pre-join screen of this room.
onoffdefaultProvides callback URLs to listen to events
https://example.com/roomsCallback url for rooms events, overrides application level rooms callback url.
https://example.com/sessionsCallback url for sessions events, overrides application level sessions callback url.
https://example.com/recordingsCallback url for recordings events, overrides application level recordings callback url.
trueDetermine if recording feature is available in the UI.
trueDetermine if chat feature is available in the UI.
trueDetermine if whiteboard feature is available in the UI.
trueDetermine if the locale switcher is available in the UI.
Determine if captions are available in the UI.
Provides options to customize the user interface
enesThe desired language of the UI. The default is English.
arcadeenesfrheitpt-brzh-twzh-cnProvides links to join the meeting room
The link to join the meeting as participant, using the meeting code
https://meetings.vonage.com/280674154The link to join the meeting as host, using the meeting code
https://meetings.vonage.com/?room_token=280674154&participant_token=eyJhbGciOiJIUzI1NiIsInR5cCExemple Réponse
{
"id": "9f6fe8ae-3458-4a72-b532-8276d5533e97",
"display_name": "My custom room",
"metadata": "Welcome to my custom room",
"type": "instant",
"recording_options": {
"auto_record": false,
"record_only_owner": false
},
"meeting_code": "280674154",
"is_available": true,
"theme_id": "ef2b46f3-8ebb-437e-a671-272e4990fbc8",
"created_at": {},
"expires_at": {},
"expire_after_use": true,
"join_approval_level": "none",
"initial_join_options": {
"microphone_state": "on"
},
"callback_urls": {
"rooms_callback_url": "https://example.com/rooms",
"sessions_callback_url": "https://example.com/sessions",
"recordings_callback_url": "https://example.com/recordings"
},
"available_features": {
"is_recording_available": true,
"is_chat_available": true,
"is_whiteboard_available": true,
"is_locale_switcher_available": true,
"is_captions_available": false
},
"ui_settings": {
"language": "es"
},
"_links": {
"guest_url": {
"href": "https://meetings.vonage.com/280674154"
},
"host_url": {
"href": "https://meetings.vonage.com/?room_token=280674154&participant_token=eyJhbGciOiJIUzI1NiIsInR5cC"
}
}
}Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
9f6fe8ae-3458-4a72-b532-8276d5533e97The recording UUID
2_MX40NjMwODczMn5-MTU3NTgyODEwNzQ2MH5OZDJrVmdBRUNDbG5MUzNqNX20yQ1Z-fgCorresponds to the underlying Video API session id
{}The date the recording started
{}The date the recording stopped
stoppedThe recording current status
startedstoppedpauseduploadedProvide links for the current recording
The recording url
https://prod-meetings-recordings.s3.amazonaws.com/123/9f6fe8ae-3458-4a72-b532-8276d5533e97/archive.mp4Exemple Réponse
{
"id": "9f6fe8ae-3458-4a72-b532-8276d5533e97",
"session_id": "2_MX40NjMwODczMn5-MTU3NTgyODEwNzQ2MH5OZDJrVmdBRUNDbG5MUzNqNX20yQ1Z-fg",
"started_at": {},
"ended_at": {},
"status": "stopped",
"_links": {
"url": {
"href": "https://prod-meetings-recordings.s3.amazonaws.com/123/9f6fe8ae-3458-4a72-b532-8276d5533e97/archive.mp4"
}
}
}Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
List of recordings for the given session
9f6fe8ae-3458-4a72-b532-8276d5533e97The recording UUID
2_MX40NjMwODczMn5-MTU3NTgyODEwNzQ2MH5OZDJrVmdBRUNDbG5MUzNqNX20yQ1Z-fgCorresponds to the underlying Video API session id
{}The date the recording started
{}The date the recording stopped
stoppedThe recording current status
startedstoppedpauseduploadedProvide links for the current recording
The recording url
https://prod-meetings-recordings.s3.amazonaws.com/123/9f6fe8ae-3458-4a72-b532-8276d5533e97/archive.mp4Exemple Réponse
{
"_embedded": {
"recordings": [
{
"id": "9f6fe8ae-3458-4a72-b532-8276d5533e97",
"session_id": "2_MX40NjMwODczMn5-MTU3NTgyODEwNzQ2MH5OZDJrVmdBRUNDbG5MUzNqNX20yQ1Z-fg",
"started_at": {},
"ended_at": {},
"status": "stopped",
"_links": {
"url": {
"href": "https://prod-meetings-recordings.s3.amazonaws.com/123/9f6fe8ae-3458-4a72-b532-8276d5533e97/archive.mp4"
}
}
}
]
}
}17323338801The phone number
en-USThe language culture name
United StatesThe name of the number
Exemple Réponse
[
{
"number": 17323338801,
"locale": "en-US",
"display_name": "United States"
}
]Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
ef2b46f3-8ebb-437e-a671-272e4990fbc8The theme UUID
200Theme1The name of the theme (must be unique). If null, a UUID will automatically be generated
VCPThe domain of the theme
VCPVBC123ab4cdThe applications account id (ApiKey)
921a6f5b-1f94-49f4-8107-26f0c75fc6e7The application Id
7#12f64eThe main color that will be used for the meeting room.
128short-urlThe URL that will represent every meeting room with this theme. The value must be unique across Vonage
200BrandThe text that will appear on the meeting homepage, in the case that there is no brand image
branded-image-coloredColored logo's key in storage system
branded-image-whiteWhite logo's key in storage system
branded-faviconFavicon key in storage system
branded-image-colored-urlColored logo's link
branded-image-white-urlWhite logo's link
branded-favicon-urlFavicon link
Exemple Réponse
[
{
"theme_id": "ef2b46f3-8ebb-437e-a671-272e4990fbc8",
"theme_name": "Theme1",
"domain": "VCP",
"account_id": "123ab4cd",
"application_id": "921a6f5b-1f94-49f4-8107-26f0c75fc6e7",
"main_color": "#12f64e",
"short_company_url": "short-url",
"brand_text": "Brand",
"brand_image_colored": "branded-image-colored",
"brand_image_white": "branded-image-white",
"branded_favicon": "branded-favicon",
"brand_image_colored_url": "branded-image-colored-url",
"brand_image_white_url": "branded-image-white-url",
"branded_favicon_url": "branded-favicon-url"
}
]Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
200Theme1The name of the theme (must be unique). If null, a UUID will automatically be generated
7#12f64eThe main color that will be used for the meeting room.
200BrandThe text that will appear on the meeting homepage, in the case that there is no brand image
128short-urlThe URL that will represent every meeting room with this theme. The value must be unique across Vonage
Exemple Demande
{
"theme_name": "Theme1",
"main_color": "#12f64e",
"brand_text": "Brand",
"short_company_url": "short-url"
}{
"theme_name": "Theme1",
"main_color": "#12f64e",
"brand_text": "Brand",
"short_company_url": "short-url"
}ef2b46f3-8ebb-437e-a671-272e4990fbc8The theme UUID
200Theme1The name of the theme (must be unique). If null, a UUID will automatically be generated
VCPThe domain of the theme
VCPVBC123ab4cdThe applications account id (ApiKey)
921a6f5b-1f94-49f4-8107-26f0c75fc6e7The application Id
7#12f64eThe main color that will be used for the meeting room.
128short-urlThe URL that will represent every meeting room with this theme. The value must be unique across Vonage
200BrandThe text that will appear on the meeting homepage, in the case that there is no brand image
branded-image-coloredColored logo's key in storage system
branded-image-whiteWhite logo's key in storage system
branded-faviconFavicon key in storage system
branded-image-colored-urlColored logo's link
branded-image-white-urlWhite logo's link
branded-favicon-urlFavicon link
Exemple Réponse
{
"theme_id": "ef2b46f3-8ebb-437e-a671-272e4990fbc8",
"theme_name": "Theme1",
"domain": "VCP",
"account_id": "123ab4cd",
"application_id": "921a6f5b-1f94-49f4-8107-26f0c75fc6e7",
"main_color": "#12f64e",
"short_company_url": "short-url",
"brand_text": "Brand",
"brand_image_colored": "branded-image-colored",
"brand_image_white": "branded-image-white",
"branded_favicon": "branded-favicon",
"brand_image_colored_url": "branded-image-colored-url",
"brand_image_white_url": "branded-image-white-url",
"branded_favicon_url": "branded-favicon-url"
}Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
ef2b46f3-8ebb-437e-a671-272e4990fbc8The theme UUID
200Theme1The name of the theme (must be unique). If null, a UUID will automatically be generated
VCPThe domain of the theme
VCPVBC123ab4cdThe applications account id (ApiKey)
921a6f5b-1f94-49f4-8107-26f0c75fc6e7The application Id
7#12f64eThe main color that will be used for the meeting room.
128short-urlThe URL that will represent every meeting room with this theme. The value must be unique across Vonage
200BrandThe text that will appear on the meeting homepage, in the case that there is no brand image
branded-image-coloredColored logo's key in storage system
branded-image-whiteWhite logo's key in storage system
branded-faviconFavicon key in storage system
branded-image-colored-urlColored logo's link
branded-image-white-urlWhite logo's link
branded-favicon-urlFavicon link
Exemple Réponse
{
"theme_id": "ef2b46f3-8ebb-437e-a671-272e4990fbc8",
"theme_name": "Theme1",
"domain": "VCP",
"account_id": "123ab4cd",
"application_id": "921a6f5b-1f94-49f4-8107-26f0c75fc6e7",
"main_color": "#12f64e",
"short_company_url": "short-url",
"brand_text": "Brand",
"brand_image_colored": "branded-image-colored",
"brand_image_white": "branded-image-white",
"branded_favicon": "branded-favicon",
"brand_image_colored_url": "branded-image-colored-url",
"brand_image_white_url": "branded-image-white-url",
"branded_favicon_url": "branded-favicon-url"
}Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
200Theme1The name of the theme (must be unique). If null, a UUID will automatically be generated
7#12f64eThe main color that will be used for the meeting room.
200BrandThe text that will appear on the meeting homepage, in the case that there is no brand image
128short-urlThe URL that will represent every meeting room with this theme. The value must be unique across Vonage
Exemple Demande
{
"update_details": {
"theme_name": "Theme1",
"main_color": "#12f64e",
"brand_text": "Brand",
"short_company_url": "short-url"
}
}{
"update_details": {
"theme_name": "Theme1",
"main_color": "#12f64e",
"brand_text": "Brand",
"short_company_url": "short-url"
}
}ef2b46f3-8ebb-437e-a671-272e4990fbc8The theme UUID
200Theme1The name of the theme (must be unique). If null, a UUID will automatically be generated
VCPThe domain of the theme
VCPVBC123ab4cdThe applications account id (ApiKey)
921a6f5b-1f94-49f4-8107-26f0c75fc6e7The application Id
7#12f64eThe main color that will be used for the meeting room.
128short-urlThe URL that will represent every meeting room with this theme. The value must be unique across Vonage
200BrandThe text that will appear on the meeting homepage, in the case that there is no brand image
branded-image-coloredColored logo's key in storage system
branded-image-whiteWhite logo's key in storage system
branded-faviconFavicon key in storage system
branded-image-colored-urlColored logo's link
branded-image-white-urlWhite logo's link
branded-favicon-urlFavicon link
Exemple Réponse
{
"theme_id": "ef2b46f3-8ebb-437e-a671-272e4990fbc8",
"theme_name": "Theme1",
"domain": "VCP",
"account_id": "123ab4cd",
"application_id": "921a6f5b-1f94-49f4-8107-26f0c75fc6e7",
"main_color": "#12f64e",
"short_company_url": "short-url",
"brand_text": "Brand",
"brand_image_colored": "branded-image-colored",
"brand_image_white": "branded-image-white",
"branded_favicon": "branded-favicon",
"brand_image_colored_url": "branded-image-colored-url",
"brand_image_white_url": "branded-image-white-url",
"branded_favicon_url": "branded-favicon-url"
}Change given logo to be permanent
Use the theme ID of the theme you wish to update, along with the key used in the previous step, to link the logo with the theme that you wish to update. You can even make multiple upload calls, and then pass multiple keys to the theme update.
Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
List of temporary theme's logos to make permanent
Key used for uploading a logo
Exemple Demande
{
"keys": [
"logo-key1",
"logo-key2"
]
}{
"keys": [
"logo-key1",
"logo-key2"
]
}Get URLs that can be used to upload logos for a theme via a POST
Use a GET on this API to retrieve the credentials needed for upload. The response will contain objects for each favicon, light logo, and colored logo. The Policy will be your JWT. Grab the values for the image type you wish to upload.
Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
https://storage-url.comStorage system URL
Fields property has to be part of the POST request's body
image/pngauto-expiring-temp/logos/white/ca63a155-d5f0-4131-9903-c59907e53df0Logo's key in storage system
faviconwhitecoloredfaviconroomservice-whitelabel-logos-prodBucket name to upload to
AWS4-HMAC-SHA256ASSCSSQSAMKJISDGBW/20220410/us-east-1/s3/aws4_request20220410T200246ZIQoJb3JpZ2luX2VjEBIaCXVzLWVhc3QtMSJHMEUCIDMxvPG4eyJleHBpcmF0aW9uIjoiMjAyMy0wNi0wN1QxMjo0Njo0MFofcb46c1adfa98836f0533aadebedc6fb1edbd90aa583f3264c0ae5bb63d83123Exemple Réponse
[
{
"url": "https://storage-url.com",
"fields": {
"Content-Type": "image/png",
"key": "auto-expiring-temp/logos/white/ca63a155-d5f0-4131-9903-c59907e53df0",
"logoType": "favicon",
"bucket": "roomservice-whitelabel-logos-prod",
"X-Amz-Algorithm": "AWS4-HMAC-SHA256",
"X-Amz-Credential": "ASSCSSQSAMKJISDGBW/20220410/us-east-1/s3/aws4_request",
"X-Amz-Date": "20220410T200246Z",
"X-Amz-Security-Token": "IQoJb3JpZ2luX2VjEBIaCXVzLWVhc3QtMSJHMEUCIDMxvPG4",
"Policy": "eyJleHBpcmF0aW9uIjoiMjAyMy0wNi0wN1QxMjo0Njo0MFo",
"X-Amz-Signature": "fcb46c1adfa98836f0533aadebedc6fb1edbd90aa583f3264c0ae5bb63d83123"
}
}
]Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
25The number of results returned on this page
30The overall number of results
9f6fe8ae-3458-4a72-b532-8276d5533e97The room UUID
200My custom roomThe name of the meeting room
500Welcome to my custom roomFree text that can be attached to a room. This will be passed in the form of a header in events related to this room.
instantThe type of meeting which can be instant or long term. An instant is active for 10 minutes until the first participant joins the roo, and remains active for 10 minutes after the last participant leaves. A long term room expires after a specific date
instantlong_termAn object containing various meeting recording options
Automatically record all sessions in this room. Recording cannot be stopped when this is set to true.
Record only the owner screen or any share screen of the video.
9280674154The meeting PIN number
trueOnce a room becomes unavailable, no new sessions can be created under it
ef2b46f3-8ebb-437e-a671-272e4990fbc8The theme UUID
{}The time for when the room was created, expressed in ISO 8601 format
{}The time for when the room will be expired, expressed in ISO 8601 format. The value must be greater than 10 minutes from now
trueClose the room after a session ends. Only relevant for long_term rooms
The level of approval needed to join the meeting in the room. When set to "after_owner_only" the participants will join the meeting only after the host joined. When set to "explicit_approval" the participants will join the waiting room and the host will deny/approve them.
noneafter_owner_onlyexplicit_approvalSets the default options for participants
defaultonSet the default microphone option for users in the pre-join screen of this room.
onoffdefaultProvides callback URLs to listen to events
https://example.com/roomsCallback url for rooms events, overrides application level rooms callback url.
https://example.com/sessionsCallback url for sessions events, overrides application level sessions callback url.
https://example.com/recordingsCallback url for recordings events, overrides application level recordings callback url.
trueDetermine if recording feature is available in the UI.
trueDetermine if chat feature is available in the UI.
trueDetermine if whiteboard feature is available in the UI.
trueDetermine if the locale switcher is available in the UI.
Determine if captions are available in the UI.
Provides options to customize the user interface
enesThe desired language of the UI. The default is English.
arcadeenesfrheitpt-brzh-twzh-cnProvides links to join the meeting room
The link to join the meeting as participant, using the meeting code
https://meetings.vonage.com/280674154The link to join the meeting as host, using the meeting code
https://meetings.vonage.com/?room_token=280674154&participant_token=eyJhbGciOiJIUzI1NiIsInR5cCRepresents HAL links for navigation purposes
Provides a link to the first element
https://api-eu.vonage.com/v1/meetings/rooms?page_size=50Provides a link to the current element
https://api-eu.vonage.com/v1/meetings/rooms?page_size=50&start_id=2293905Provides a link to the next element
https://api-eu.vonage.com/v1/meetings/rooms?page_size=50&start_id=2293906Provides a link to the previous element
https://api-eu.vonage.com/v1/meetings/rooms?page_size=50&start_id=2293904Exemple Réponse
{
"page_size": 25,
"total_items": 30,
"_embedded": [
{
"id": "9f6fe8ae-3458-4a72-b532-8276d5533e97",
"display_name": "My custom room",
"metadata": "Welcome to my custom room",
"type": "instant",
"recording_options": {
"auto_record": false,
"record_only_owner": false
},
"meeting_code": "280674154",
"is_available": true,
"theme_id": "ef2b46f3-8ebb-437e-a671-272e4990fbc8",
"created_at": {},
"expires_at": {},
"expire_after_use": true,
"join_approval_level": "none",
"initial_join_options": {
"microphone_state": "on"
},
"callback_urls": {
"rooms_callback_url": "https://example.com/rooms",
"sessions_callback_url": "https://example.com/sessions",
"recordings_callback_url": "https://example.com/recordings"
},
"available_features": {
"is_recording_available": true,
"is_chat_available": true,
"is_whiteboard_available": true,
"is_locale_switcher_available": true,
"is_captions_available": false
},
"ui_settings": {
"language": "es"
},
"_links": {
"guest_url": {
"href": "https://meetings.vonage.com/280674154"
},
"host_url": {
"href": "https://meetings.vonage.com/?room_token=280674154&participant_token=eyJhbGciOiJIUzI1NiIsInR5cC"
}
}
}
],
"_links": {
"first": {
"href": "https://api-eu.vonage.com/v1/meetings/rooms?page_size=50"
},
"self": {
"href": "https://api-eu.vonage.com/v1/meetings/rooms?page_size=50&start_id=2293905"
},
"next": {
"href": "https://api-eu.vonage.com/v1/meetings/rooms?page_size=50&start_id=2293906"
},
"prev": {
"href": "https://api-eu.vonage.com/v1/meetings/rooms?page_size=50&start_id=2293904"
}
}
}Authentification
| Clé | Description | Où | Exemple |
|---|---|---|---|
| Authorization | Votre jeton web JSON. | Headers | Bearer <JWT> |
Contains information to be updated on the application. It is mandatory to provide at least one value to update; you will receive a 400 response otherwise.
The application default theme id
Exemple Demande
{
"update_details": {
"default_theme_id": "e86a7335-35fe-45e1-b961-5777d4748022"
}
}{
"update_details": {
"default_theme_id": "e86a7335-35fe-45e1-b961-5777d4748022"
}
}921a6f5b-1f94-49f4-8107-26f0c75fc6e7The application Id
123ab4cdThe applications account id (ApiKey)
The application default theme id
Exemple Réponse
{
"application_id": "921a6f5b-1f94-49f4-8107-26f0c75fc6e7",
"account_id": "123ab4cd",
"default_theme_id": "e86a7335-35fe-45e1-b961-5777d4748022"
}Crochets Web
Les webhooks sont une extension d'une API, mais au lieu que votre code demande des données, l'API vous envoie des données. Les données arrivent dans une requête web à votre application.
Pour en savoir plus sur les webhooks, consultez notre site documentation sur les webhooks.
Cette API peut envoyer l'un des webhooks décrits ci-dessous à l'URL que vous avez configurée. Vous devez répondre avec une réponse HTTP 200 ou 204, sinon les demandes seront relancées.
Opérations disponibles
room:expired9f6fe8ae-3458-4a72-b532-8276d5533e97The room UUID
instantThe type of meeting which can be instant or long term. An instant is active for 10 minutes until the first participant joins the roo, and remains active for 10 minutes after the last participant leaves. A long term room expires after a specific date
instantlong_term{}The time for when the room will be expired, expressed in ISO 8601 format. The value must be greater than 10 minutes from now
{}The time for when the room was created, expressed in ISO 8601 format
Exemple Charge utile»Room expired
{
"event": "room:expired",
"room_id": "9f6fe8ae-3458-4a72-b532-8276d5533e97",
"room_type": "instant",
"expires_at": {},
"created_at": {}
}