Etiquetado blanco: Gestión temática de salas de reuniones

Utilice la Meetings API para crear temas personalizados con diferentes colores, logotipos y texto. Los temas pueden aplicarse a una sala, a unas cuantas salas o a todas las salas de reuniones de su aplicación.

Requisitos previos

  • Cuenta de desarrollador de Vonage: Si aún no tiene una, regístrese para obtener una Account gratuita en el Cuenta de desarrollador de Vonage.

  • Identificación y secreto de la solicitud: Una vez iniciada la sesión en Panel de API de VonageHaga clic en Applications y cree una nueva Application. Haga clic en Generate public and private key y registre la clave privada. Utilizará la clave privada con el ID de la aplicación para Generar un token web JSON (JWT). Para más información sobre los JWT, consulte Autenticación. Asegúrese también de que la Meetings API está activada para su aplicación en "Capacidades":

Enable the Meetings API for your application using the dashboard

Crear un tema

POST
: https://api-eu.vonage.com/v1/meetings/themes

Contenido

Se pueden asignar valores a los siguientes campos en la solicitud POST:

Campo ¿Es necesario? Descripción
theme_name No El nombre del tema (debe ser único). Si es nulo, se generará automáticamente un UUID.
main_color El color principal que se utilizará para la sala de reuniones.
brand_text El texto que aparecerá en la página de inicio de la reunión, en caso de que no haya imagen de marca.
short_company_url No La URL que representará a cada sala de reuniones con este tema (debe ser única).

Ejemplo de solicitud

El siguiente ejemplo creará un tema con el naranja como color principal y un texto para mostrar de "Naranja". El nombre del tema se utiliza internamente y debe ser único para cada tema.

curl -X POST 'https://api-eu.vonage.com/v1/meetings/themes' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer '$JWT \ -d '{ "main_color": "#ff6500", "brand_text": "Orange", "theme_name": "orange-room", }'

Ejemplo de respuesta

{
    "theme_id": "49d900c8-372b-4c9e-b682-5601cbdc1f7a",
    "theme_name": "orange-room",
    "domain": "VCP",
    "account_id": "123ab4cd",
    "application_id": "921a6f5b-1f94-49f4-8107-26f0c75fc6e7",
    "main_color": "#ff6500",
    "short_company_url": null,
    "brand_text": "Orange",
    "brand_image_colored": null,
    "brand_image_white": null,
    "branded_favicon": null,
    "brand_image_white_url": null,
    "brand_image_colored_url": null,
    "branded_favicon_url": null
}

Tenga en cuenta que los valores nulos representan imágenes temáticas que pueden añadirse mediante la función proceso de gestión de imágenes. Las URL que se generarán una vez cargadas esas imágenes.

Actualizar un tema

PATCH: https://api-eu.vonage.com/v1/meetings/themes/:theme_id

Las propiedades del tema que pueden actualizarse son las mismas que las que pueden establecerse en crear. Todas las imágenes deben añadirse a través de proceso de gestión de imágenes.

Para actualizar las propiedades, necesitará la función theme_id y un objeto llamado update_details:

Ejemplo de solicitud

curl -X PATCH 'https://api-eu.vonage.com/v1/meetings/themes/86da462e-fac4-4f46-87ed-63eafc81be48' \ -H 'Authorization: Bearer '$JWT \ -H 'Content-Type: application/json' \ -d '{ "update_details": { "theme_name": "Theme1", "main_color": "#12f64e", "brand_text": "Brand", "short_company_url": "short-url" } }'

Ejemplo de respuesta

{
   "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"
}

Obtener un tema

GET
: https://api-eu.vonage.com/v1/meetings/themes/:theme_id

Envíe una solicitud

GET
para ver todos los detalles de un tema:

Ejemplo de solicitud

curl -X GET 'https://api-eu.vonage.com/v1/meetings/themes/ef2b46f3-8ebb-437e-a671-272e4990fbc8' \ -H 'Authorization: Bearer '$JWT

Ejemplo de respuesta

{
   "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"
}

Tematizar una habitación

Un tema puede aplicarse a un Habitación de larga duración al crear o actualizar una sala.

Creación de salas

POST
: https://api-eu.vonage.com/v1/meetings/rooms

Este ejemplo crear una sala de reuniones a largo plazo con el tema naranja:

curl -X POST 'https://api-eu.vonage.com/v1/meetings/rooms' \ -H 'Authorization: Bearer '$JWT \ -H 'Content-Type: application/json' \ -d '{ "display_name":"New Meeting Room", "type":"long_term", "expires_at":"$EXPIRY_DATE", "theme_id": "e8b1d80b-8f78-4578-94f2-328596e01387" }'

Actualización de la sala

PATCH: https://api-eu.vonage.com/v1/meetings/rooms/{ROOM_ID}

Para actualizar el tema de una habitación, necesitará la función theme_id e identificación de la habitación:

curl -X PATCH 'https://api-eu.vonage.com/v1/meetings/rooms/9f6fe8ae-3458-4a72-b532-8276d5533e97' \ -H 'Authorization: Bearer '$JWT \ -H 'Content-Type: application/json' \ -d '{ "update_details": { "theme_id": "e8b1d80b-8f78-4578-94f2-328596e01387" } }

Eliminar un tema de una habitación

PATCH: https://api-eu.vonage.com/v1/meetings/rooms/{ROOM_ID}

Para eliminar un tema de una sala, actualice la sala mediante una opción PATCH y el ID de la sala. Actualice el theme_id con null para eliminar el tema y utilizar el tema por defecto en su lugar.

Tenga en cuenta que sólo se pueden actualizar las habitaciones de larga estancia.

Ejemplo de solicitud

curl -X PATCH 'https://api-eu.vonage.com/v1/meetings/rooms/9f6fe8ae-3458-4a72-b532-8276d5533e97' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer '$JWT \ -d '{ "update_details": { "theme_id": "null" } }'

Establecer tema por defecto

PATCH: https://api-eu.vonage.com/v1/meetings/applications

Un tema puede establecerse como tema por defecto para la aplicación, lo que significa que todas las salas creadas utilizarán automáticamente el tema por defecto. Para ello, cree primero un tema y, a continuación, añádalo como tema por defecto de la aplicación. default_theme_id en un objeto llamado update_details.

Ejemplo de solicitud

curl -X PATCH 'https://api-eu.vonage.com/v1/meetings/applications' \ -H 'Authorization: Bearer '$JWT \ -d '{ "update_details": { "default_theme_id": "e8b1d80b-8f78-4578-94f2-328596e01387" } }'

Ejemplo de respuesta

{
    "application_id":"3db604ce-b4c0-48f4-8b82-4a03ac9f6bk7",
    "account_id":"69b2a6d2",
    "default_theme_id":"e8b1d80b-8f78-4578-94f2-328596e01387"
}

Eliminar un tema

[BORRAR]: https://api-eu.vonage.com/v1/meetings/themes/{THEME_ID}

Para eliminar un tema, envíe una solicitud DELETE utilizando el ID del tema. Tenga en cuenta que un tema que esté configurado como predeterminado o que esté siendo utilizado por cualquier sala no se puede eliminar y devolverá un error.

Para eliminar un tema en uso, debe eliminarlo de cada sala que lo esté utilizando de la siguiente manera encontrar todas las salas que utilizan ese tema y eliminar el tema.

Alternativamente, si desea anular y eliminar el tema sin eliminarlo manualmente, añada un parámetro de consulta de force=true. El tema predeterminado se aplicará ahora a todas las salas que estaban utilizando este tema.

curl -X DELETE 'https://api-eu.vonage.com/v1/meetings/themes/e8b1d80b-8f78-4578-94f2-328596e01387?force=true'

Obtener todas las habitaciones con un tema determinado

GET
: https://api-eu.vonage.com/v1/meetings/themes/{THEME_ID}/rooms

Para obtener una lista de las salas que utilizan un tema determinado, envíe una solicitud

GET
utilizando el método theme_id:

Ejemplo de solicitud

curl -X GET 'https://api-eu.vonage.com/v1/meetings/themes/e8b1d80b-8f78-4578-94f2-328596e01387/rooms' \ -H 'Authorization: Bearer $JWT'

Esto devolverá una lista de todas las salas que utilizan este tema.

Referencia