Consulta de detalles de reunión
Descripción
- Esta API se utiliza para consultar detalles de todas las reuniones en el dominio de administración de un administrador o consultar detalles de todas las reuniones administradas por un usuario común.
- Solo puede consultar reuniones en curso y próximas. Para obtener detalles sobre cómo consultar detalles sobre una reunión histórica, consulte Visualización de los detalles históricos de la reunión.
Depuración
Puede depurar esta API en API Explorer.
Prototipo
Método de solicitud |
GET |
---|---|
Dirección de solicitud |
/v1/mmc/management/conferences/confDetail |
Protocolo de transporte |
HTTPS |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Localización |
Descripción |
---|---|---|---|---|
conferenceID |
Sí |
String |
Query |
ID de la reunión. |
offset |
No |
Integer |
Query |
Índice de página de la lista de participantes que se va a devolver. Valor predeterminado: 0. Este parámetro se utiliza para mostrar los datos PageParticipant por página. |
limit |
No |
Integer |
Query |
Número de registros de participantes a devolver. El valor predeterminado es 20. Este parámetro se utiliza para mostrar los datos PageParticipant por página. |
searchKey |
No |
String |
Query |
Cadena de palabra clave utilizada para la consulta. El valor puede contener de 1 a 128 caracteres. |
userUUID |
No |
String |
Query |
UUID de un usuario. Este parámetro debe llevarse durante la autenticación de terceros. |
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-Type |
No |
Integer |
Header |
Valor predeterminado: 0.
|
X-Query-Type |
No |
Integer |
Header |
Este parámetro solo es válido cuando X-Type se establece en 2. Valor predeterminado: 0
|
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 web de HCS Online donde se realiza la autenticación. |
Códigos de estado
Código de estado de HTTP |
Descripción |
---|---|
200 |
Operación exitosa. |
400 |
Parámetros invá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 |
---|---|---|
conferenceData |
ConferenceInfo object |
Detalles de la conferencia. |
data |
PageParticipant object |
Lista de participantes. |
Parámetro |
Tipo |
Descripción |
---|---|---|
limit |
Integer |
Número de registros en cada página. |
count |
Integer |
Número total de registros. |
offset |
Integer |
Desfase del número de registros, es decir, el número de registros antes de esta página. |
data |
Array of ParticipantInfo objects |
Información sobre los participantes invitados durante la programación de la reunión e invitados por el host durante la reunión.
NOTA:
|
Parámetro |
Tipo |
Descripción |
---|---|---|
participantID |
String |
ID del participante. |
name |
String |
Nombre o alias del participante. |
subscriberID |
String |
Número del participante. Este campo está reservado. |
role |
Integer |
Papel de participante en la reunión.
|
state |
String |
Estado del usuario. Actualmente, el valor se fija a MEETTING. |
address |
String |
Información sobre la sala de reuniones donde se encuentra una terminal. Este campo está reservado. |
attendeeType |
String |
El valor predeterminado lo define el servidor de Huawei Cloud Meeting.
|
accountId |
String |
ID de cuenta de un participante.
|
phone2 |
String |
Si attendeeType se establece en telepresence y el dispositivo utilizado para unirse a la reunión es una telepresencia de pantalla triple, establezca este parámetro en el número de pantalla de la izquierda. Este campo está reservado. |
phone3 |
String |
Si attendeeType se establece en telepresence y el dispositivo utilizado para unirse a la reunión es una telepresencia de pantalla triple, establezca este parámetro en el número de pantalla de la derecha. Este campo está reservado. |
|
String |
Dirección de correo. El valor puede incluir hasta 255 caracteres. |
sms |
String |
Número de móvil para recibir notificaciones SMS. El valor puede incluir hasta 127 caracteres. |
deptName |
String |
Nombre del departamento. El valor puede incluir hasta 96 caracteres. |
userUUID |
String |
UUID del usuario que programa la reunión. |
appId |
String |
ID de la aplicación. Puede crear un ID de aplicación para una aplicación solo una vez. Para obtener más información, consulte Requesting an App ID. |
isAutoInvite |
Integer |
Si desea invitar automáticamente a los participantes cuando comience la reunión. El valor predeterminado se define en la configuración de nivel empresarial. 0: No invite automáticamente a los participantes.
|
isNotOverlayPidName |
Boolean |
Si los nombres de sitios no están superpuestos.
|
Ejemplo de solicitud
GET /v1/mmc/management/conferences/confDetail?conferenceID=914083136 Connection: keep-alive X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC user-agent: WeLink-desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
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: 1811 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: acf5bd2cc7c7f90fe7ab6b95a8c753d5 Server: api-gateway X-Request-Id: e2bc0a1429cb2fd52db88ba6fa2c44a8 { "conferenceData": { "conferenceID": "914083136", "mediaTypes": "Voice,Data,Video", "subject": "user01's meeting", "size": 1, "timeZoneID": "56", "startTime": "2019-12-18 07:28", "endTime": "2019-12-18 09:28", "conferenceState": "Created", "accessNumber": "+991117", "language": "zh-CN", "passwordEntry": [ { "conferenceRole": "chair", "password": "157599" }, { "conferenceRole": "general", "password": "582397" } ], "userUUID": "ff808081699b56cb0169be103500012b", "scheduserName": "user8002", "multiStreamFlag": 1, "conferenceType": 0, "confType": "IMMEDIATELY", "isAutoMute": 1, "isAutoRecord": 0, "chairJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083136/6a30b8b5a325105da031442627828e496f91021ece36405f", "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914083136/9505dc3349228b1ce0db8165590cc977bcff89785130fe0d", "recordType": 0, "recordAuxStream": 0, "confConfigInfo": { "isSendNotify": true, "isSendSms": true, "isAutoMute": true }, "vmrFlag": 0, "scheduleVmr": false, "isHasRecordFile": false, "partAttendeeInfo": [ { "phone": "+991116003815", "name": "user01", "type": "normal" } ], "terminlCount": 0, "normalCount": 1, "deptName": "wangyue", "confUUID": "050c7898216811eaa6958bf3bb9ac167" }, "data": { "offset": 0, "limit": 20, "count": 1, "data": [ { "participantID": "+991116003815", "name": "user01", "role": 0, "state": "MEETTING", "attendeeType": "normal", "accountId": "user01" } ] } }
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 -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' 'https://api.meeting.huaweicloud.com/v1/mmc/management/conferences/confDetail?conferenceID=914083136'