Invitación a participantes
Descripción
Esta API se utiliza para invitar a los participantes a una reunión.
Depuración
Puede depurar esta API en API Explorer.
Prototipo
Método de solicitud |
POST |
---|---|
Dirección de solicitud |
/v1/mmc/control/conferences/participants |
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. |
X-Conference-Authorization |
Sí |
String |
Header |
Token de control de reunión, que se obtiene a través de la API para obtener un token de control de reunión. |
attendees |
Sí |
Array of attendee objects |
Body |
Lista de participantes a invitar. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
userUUID |
No |
String |
UUID del participante. |
accountId |
No |
String |
Cuenta de participante, que es compatible con terminales de versiones anteriores. Si no se especifica userUUID, Huawei Cloud Meeting Management Platform consulta al participante mediante accountId. |
name |
Sí |
String |
Nombre o alias del participante. El valor puede incluir hasta 96 caracteres. |
role |
No |
Integer |
Papel de participante en la reunión. Valor predeterminado: 0.
|
phone |
Sí |
String |
Número de teléfono. (Se admiten tanto los formatos SIP como los de número de teléfono.) El valor puede contener hasta 127 caracteres. Se debe especificar el phone, email o sms. Si el type 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 central. |
phone2 |
No |
String |
Campo reservado. Los tipos de valor son los mismos que los del parámetro phone. Si el type 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. |
phone3 |
No |
String |
Campo reservado. Los tipos de valor son los mismos que los del parámetro phone. Si el type 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. |
|
No |
String |
Dirección de correo electrónico. El valor puede incluir hasta 255 caracteres. Se debe especificar el phone, email o sms. (No se envía ninguna notificación a los participantes invitados durante la reunión.) |
sms |
No |
String |
Número de móvil para recibir notificaciones SMS. El valor puede incluir hasta 32 caracteres. Se debe especificar el phone, email o sms. (No se envía ninguna notificación a los participantes invitados durante la reunión.) |
type |
Sí |
String |
El valor predeterminado lo define el servidor de Huawei Cloud Meeting. Los valores enumerados son los siguientes:
|
deptUUID |
No |
String |
ID del departamento. El valor puede incluir hasta 64 caracteres. |
deptName |
No |
String |
Nombre del departamento. El valor puede incluir hasta 128 caracteres. |
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
Ninguno
Ejemplo de solicitud
POST /v1/mmc/control/conferences/participants?conferenceID=914083136 Connection: keep-alive X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb Content-Type: application/json user-agent: WeLink-desktop Content-Length: 175 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "attendees": [ { "name": "user01", "role": 1, "phone": "+8657*******" "type": "normal" }] }
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: 39 Connection: keep-alive http_proxy_id: b77bb5478e0b1fc0dbbb4e8d4e26ba65 Server: api-gateway X-Request-Id: 479fdc1d80e2e7ae19c4a08c28821822
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-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' -d '{"attendees":[{"name":"user01","role":0,"phone":"+8657*******"}]}' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/participants?conferenceID=914083136