Creación de una serie de reuniones recurrentes
Descripción
Esta API se utiliza para programar una serie de reuniones recurrentes.
Depuración
Puede depurar esta API en API Explorer.
Prototipo
Método de solicitud |
POST |
---|---|
Dirección de solicitud |
/v1/mmc/management/cycleconferences |
Protocolo de transporte |
HTTPS |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Localización |
Descripción |
---|---|---|---|---|
userUUID |
No |
String |
Query |
UUID del usuario (registrado en el USG). |
X-Access-Token |
Sí |
String |
Header |
Token de autorización. Utilice el valor de accessToken en la respuesta a la solicitud de Autenticación de un ID de aplicación. |
X-Authorization-Type |
No |
String |
Header |
Si la solicitud se envía desde un portal de terceros. |
X-Site-Id |
No |
String |
Header |
ID del sitio HCS Online donde se realiza la autenticación. |
startTime |
No |
String |
Body |
Hora UTC cuando comienza la reunión.
NOTA:
Formato: aaaa-MM-dd HH:mm. |
length |
No |
Integer |
Body |
Duración de la reunión, en minutos. Rango de valores: 15 a 1440. Valor predeterminado: 30. |
subject |
No |
String |
Body |
Tema de la reunión. El valor puede contener hasta 128 caracteres. |
mediaTypes |
Sí |
String |
Body |
Tipo de medios de comunicación de la reunión. El valor consta de uno o varios valores enumerados, que están separados por comas (,). Los valores enumerados son los siguientes:
|
groupuri |
No |
String |
Body |
ID de grupo temporal utilizado cuando se crea una reunión instantánea en el cliente. Este parámetro se incluye en el encabezado de conference-info o cuando se invita a otros participantes. El valor puede contener hasta 31 caracteres. |
attendees |
No |
Array of Attendee objects |
Body |
Lista de participantes, que se puede utilizar para enviar notificaciones y recordatorios de reuniones y que la plataforma de gestión de Huawei Cloud Meeting puede usar para invitar automáticamente a los participantes a la hora de inicio de la reunión. |
cycleParams |
No |
CycleParams object |
Body |
Lista de parámetros de reunión recurrente, que es obligatoria para una serie de reuniones recurrentes. La lista de parámetros incluye la fecha de inicio, la fecha de finalización, el intervalo y la hora de inicio de la serie de reuniones periódicas. |
isAutoRecord |
No |
Integer |
Body |
Si se iniciará automáticamente la grabación para la reunión. Este parámetro sólo es válido cuando recordType se establece en 2 o 3. Valor predeterminado: 0.
|
encryptMode |
No |
Integer |
Body |
Modo de encriptación de medios de reunión. El valor predeterminado se define en la configuración de nivel empresarial.
|
language |
No |
String |
Body |
Idioma predeterminado de la reunión. El valor predeterminado lo define el servidor de Huawei Cloud Meeting. Los idiomas compatibles con la plataforma de gestión de Huawei Cloud Meeting se transmiten como se especifica en el RFC 3066 común.
|
timeZoneID |
No |
String |
Body |
Zona horaria de la reunión en las notificaciones de la reunión. Para obtener más información, consulte Asignación de zona horaria.
NOTA:
|
recordType |
No |
Integer |
Body |
Tipo de grabación. Valor predeterminado: 0.
|
liveAddress |
No |
String |
Body |
Dirección de transmisión en vivo del vídeo. El valor puede contener hasta 255 caracteres. Este parámetro sólo es válido cuando recordType se establece en 2 o 3. |
auxAddress |
No |
String |
Body |
Dirección de transmisión en directo de la presentación. El valor puede contener hasta 255 caracteres. Este parámetro sólo es válido cuando recordType se establece en 2 o 3. |
recordAuxStream |
No |
Integer |
Body |
Si desea grabar la presentación. Este parámetro sólo es válido cuando recordType se establece en 2 o 3.
|
confConfigInfo |
No |
ConfConfigInfo object |
Body |
Otras configuraciones de reunión. |
recordAuthType |
No |
Integer |
Body |
Modo de autenticación de grabación. Este parámetro sólo es válido cuando recordType se establece en 2 o 3.
|
vmrFlag |
No |
Integer |
Body |
Si desea utilizar una sala de reuniones en la nube o una ID de reunión personal para celebrar la reunión programada. Valor predeterminado: 0.
|
vmrID |
No |
String |
Body |
ID de la sala de reuniones en la nube vinculada a la cuenta que crea la reunión. Obtenga el valor llamando a la API para enumerar las salas de reuniones en la nube y las ID de reuniones personales.
NOTA:
|
concurrentParticipants |
No |
Integer |
Body |
Número máximo de participantes en la reunión.
|
Códigos de estado
Código de estado de HTTP |
Descripción |
---|---|
200 |
Operación exitosa. |
400 |
Parámetros no válidos. |
401 |
La autenticación no se realiza o falla. |
403 |
Permisos insuficientes. |
500 |
Excepción del servidor. |
Parámetros de respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
[Array element] |
Array of ConferenceInfo |
Lista de información de la reunión. |
Parámetro |
Tipo |
Descripción |
---|---|---|
cycleSubConfID |
string |
UUID de una reunión recurrente. |
conferenceID |
string |
ID de reunión, que contiene hasta 32 caracteres. |
mediaType |
string |
Tipo de medios de comunicación de la reunión. El valor consta de uno o varios valores enumerados, que están separados por comas (,). Los valores enumerados son los siguientes:
|
startTime |
string |
Hora de inicio de la reunión (formato: AAAA-MM-DD HH:MM). |
endTime |
string |
Hora de finalización de la reunión (formato: AAAA-MM-DD HH:MM). |
isAutoRecord |
Integer |
Si la grabación está activada automáticamente. |
confConfigInfo |
Confconfinginfo object |
Otras configuraciones acerca de la reunión periódica. |
recordAuthType |
Integer |
Modo de autenticación de grabación. Este parámetro sólo es válido cuando recordType se establece en 2 o 3.
|
description |
string |
Descripción de la reunión, que contiene hasta 200 caracteres. |
Parámetro |
Tipo |
Descripción |
---|---|---|
callInRestriction |
Integer |
Participantes que pueden unirse a la reunión.
|
audienceCallInRestriction |
Integer |
Participantes que pueden unirse al webinar.
|
allowGuestStartConf |
Boolean |
Si se debe permitir que los invitados comiencen la reunión. (Este parámetro solo es válido para reuniones con ID aleatorias.)
|
enableWaitingRoom |
Boolean |
Si la sala de espera está habilitada. |
showAudienceCountInfo |
ShowAudienceCountInfo object |
Regla para mostrar el número de asistentes al webinar. |
Parámetro |
Tipo |
Descripción |
---|---|---|
showAudienceMode |
Integer |
Regla para mostrar el número de asistentes. El servidor calcula y entrega el número de asistentes a los clientes.
|
baseAudienceCount |
Integer |
Base de cantidad de asistentes, que oscila entre 0 y 10,000. |
multiple |
Double |
Multiplicador, que varía de 1 a 10. El valor puede ser exacto a un decimal. |
Ejemplo de solicitud
POST /v1/mmc/management/cycleconferences Connection: keep-alive X-Access-Token: cnr1510zTBhrfUsymQ0srhW2RYS99r9G5SQoTLWN Content-Type: application/json user-agent: WeLink-desktop Content-Length: 548 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "subject": "Regular Recurring Meeting", "mediaTypes": "Data,Voice,HDVideo", "startTime": "", "length": 120, "timeZoneID": "56", "vmrFlag": 1, "vmrID": "ff80808167ef1edf0167f339533f05a8", "cycleParams": { "startDate": "2021-08-31", "endDate": "2021-09-02", "cycle": "Day", "interval": 1, "preRemindDays": 1 }, "attendees": [ { "userUUID": "ff80808167ef1edf0167f339533d05a6", "name": "Suzhou Branch", "email": "cloudmeeting@huawei.com", "sms": "+991116006724", "deptName": "Enterprise Collaboration Cloud Service Program", "role": 0, "phone": "+991199006724", "type": "normal" } ], "confConfigInfo": { "isSendNotify": "false", "isSendSms": "false", "isSendCalendar": "false" }, "recordType": 0 }
Ejemplo de respuesta
HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 1153 Connection: keep-alive http_proxy_id: 79ea4d8bdb461a4b811a117f9cf3dbde Server: api-gateway X-Request-Id: 1ccc1d7937dd0f66067aeecb9f1df241 [ { "conferenceID": "986256843", "mediaTypes": "HDVideo,Data,Voice", "subject": "Regular Recurring Meeting", "size": 0, "timeZoneID": "56", "startTime": "2021-09-01 08:39", "endTime": "2021-09-01 09:09", "conferenceState": "Schedule", "accessNumber": "+86571150", "language": "zh-CN", "passwordEntry": [ { "conferenceRole": "chair", "password": "999712" }, { "conferenceRole": "general", "password": "891009" } ], "userUUID": "fe235be7aa6045b98a33f27b365cbca9", "scheduserName": "Suzhou Branch", "multiStreamFlag": 1, "conferenceType": 2, "confType": "CYCLE", "cycleParams": { "startDate": "2021-09-01", "cycle": "Day", "endDate": "2021-09-02", "cycleCount": 0, "interval": 1, "preRemindDays": 1 }, "isAutoMute": 0, "isHardTerminalAutoMute": 0, "isSoftTerminalAutoMute": 0, "isAutoRecord": 0, "chairJoinUri": "https://100.95.188.184:443/#/j/986256843/fa4def332cb83f5b1ec74c64d0658a8570f45ad3e8d0df8c", "guestJoinUri": "https://100.95.188.184:443/#/j/986256843/53f55ec44263d666e8ed70594624aa10497c631a91d3b8c1", "recordType": 0, "recordAuxStream": 0, "recordAuthType": 2, "confConfigInfo": { "inviteMode": "AUTO_INVITE", "prolongLength": 15, "isGuestFreePwd": false, "isSendNotify": true, "isSendSms": true, "isSendCalendar": true, "isAutoMute": false, "isHardTerminalAutoMute": false, "callInRestriction": 0, "audienceCallInRestriction": 0, "allowGuestStartConf": true, "enableWaitingRoom": false }, "vmrFlag": 0, "scheduleVmr": false, "isHasRecordFile": false, "terminlCount": 0, "normalCount": 0, "deptName": "corpzxytest111", "confMode": "RTC", "webinar": false, "concurrentParticipants": 0, "subConfs": [ { "cycleSubConfID": "fe24d1350a3611ecbe71a328ac3ca004", "conferenceID": "986256843", "startTime": "2021-09-01 08:39", "endTime": "2021-09-01 09:09", "mediaType": "HDVideo,Data,Voice", "isAutoRecord": 0, "recordAuthType": 2, "confConfigInfo": { "callInRestriction": 0, "audienceCallInRestriction": 0, "allowGuestStartConf": true, "enableWaitingRoom": false } }, { "cycleSubConfID": "fe24d1360a3611ecbe71fdd2c36bc8c2", "conferenceID": "986256843", "startTime": "2021-09-02 08:39", "endTime": "2021-09-02 09:09", "mediaType": "HDVideo,Data,Voice", "isAutoRecord": 0, "recordAuthType": 2, "confConfigInfo": { "callInRestriction": 0, "audienceCallInRestriction": 0, "allowGuestStartConf": true, "enableWaitingRoom": false } } ] } ]
Códigos de error
Si se devuelve un código de error que comienza con MMC o USG cuando utiliza esta API, corrija el error siguiendo las instrucciones proporcionadas en Centro de errores de la API de Huawei Cloud.
Ejemplo de comando cURL
curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token:cnr1510zTBhrfUsymQ0srhW2RYS99r9G5SQoTLWN' -d '{"conferenceType": "2","subject": "user01 conference","mediaTypes": "HDVideo","attendees": [{"name": "user01","role": 1,"phone": "+8657*******"}], "cycleParams": {"startDate": "2021-08-31","endDate": "2021-09-02","cycle": "Day","interval": 1,"preRemindDays": 1}}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/cycleconferences'