Criação de uma série de reuniões recorrentes
Descrição
Esta API é usada para agendar uma série de reuniões recorrentes.
Depuração
Você pode depurar essa API no API Explorer.
Protótipo
Método de solicitação |
POST |
---|---|
Endereço de solicitação |
/v1/mmc/management/cycleconferences |
Protocolo de transporte |
HTTPS |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Localização |
Descrição |
---|---|---|---|---|
userUUID |
Não |
String |
Consulta |
UUID do usuário (registrado no USG). |
X-Access-Token |
Sim |
String |
Cabeçalho |
Token de autorização. Use o valor de accessToken na resposta à solicitação de Autenticação de um ID de aplicação. |
X-Autorização-Tipo |
Não |
String |
Cabeçalho |
Se a solicitação é enviada de um portal de terceiros. |
X-Site-Id |
Não |
String |
Cabeçalho |
ID do site do HCS On-line onde a autenticação é realizada. |
startTime |
Não |
String |
Corpo |
Hora UTC quando a reunião começa.
NOTA:
Formato: aaaa-MM-dd HH:mm. |
length |
Não |
Integer |
Corpo |
Duração da reunião, em minutos. Intervalo de valores: 15 até 1440. Valor padrão: 30. |
subject |
Não |
String |
Corpo |
Tópico da reunião. O valor pode conter até 128 caracteres. |
mediaTypes |
Sim |
String |
Corpo |
Tipo de mídia da reunião. O valor consiste em um ou vários valores enumerados, que são separados por vírgulas (,). Os valores enumerados são os seguintes:
|
groupuri |
Não |
String |
Corpo |
ID de grupo temporário usado quando uma reunião instantânea é criada no cliente. Este parâmetro é transportado no cabeçalho conference-info ou quando outros participantes são convidados. O valor pode conter até 31 caracteres. |
attendees |
Não |
Array of Attendee objects |
Corpo |
Lista de participantes, que pode ser usada para enviar notificações e lembretes de reuniões e ser usada pela Plataforma de gerenciamento do Huawei Cloud Meeting para convidar automaticamente participantes na hora de início da reunião. |
cycleParams |
Não |
CycleParams object |
Corpo |
Lista de parâmetros de reuniões recorrentes, que é obrigatória para uma série de reuniões recorrentes. A lista de parâmetros inclui a data de início, a data de término, o intervalo e a hora de início da série de reuniões recorrentes. |
isAutoRecord |
Não |
Integer |
Corpo |
Se iniciar automaticamente a gravação para a reunião. Este parâmetro é válido somente quando recordType é definido como 2 ou 3. Valor padrão: 0.
|
encryptMode |
Não |
Integer |
Corpo |
Modo de criptografia de mídia de reunião. O valor padrão é definido na configuração de nível empresarial.
|
language |
Não |
String |
Corpo |
Idioma padrão da reunião. O valor padrão é definido pelo servidor do Huawei Cloud Meeting. Os idiomas suportados pela Plataforma de gerenciamento do Huawei Cloud Meeting são transmitidos conforme especificado no RFC 3066 comum.
|
timeZoneID |
Não |
String |
Corpo |
Fuso horário de reunião em notificações de reunião. Para obter detalhes, consulte Mapeamento de fuso horário.
NOTA:
|
recordType |
Não |
Integer |
Corpo |
Tipo de gravação. Valor padrão: 0.
|
liveAddress |
Não |
String |
Corpo |
Endereço de transmissão ao vivo do vídeo. O valor pode conter até 255 caracteres. Este parâmetro é válido somente quando recordType é definido como 2 ou 3. |
auxAddress |
Não |
String |
Corpo |
Endereço de transmissão ao vivo da apresentação. O valor pode conter até 255 caracteres. Este parâmetro é válido somente quando recordType é definido como 2 ou 3. |
recordAuxStream |
Não |
Integer |
Corpo |
Se gravar a apresentação. Este parâmetro é válido somente quando recordType é definido como 2 ou 3.
|
confConfigInfo |
Não |
ConfConfigInfo object |
Corpo |
Outras configurações de reunião. |
recordAuthType |
Não |
Integer |
Corpo |
Modo de autenticação de gravação. Este parâmetro é válido somente quando recordType é definido como 2 ou 3.
|
vmrFlag |
Não |
Integer |
Corpo |
Se usar uma sala de reunião na nuvem ou ID de reunião pessoal para realizar a reunião agendada. Valor padrão: 0.
|
vmrID |
Não |
String |
Corpo |
ID da sala de reunião na nuvem vinculada à conta que cria a reunião. Obtenha o valor chamando a API para listar salas de reunião na nuvem e IDs de reunião pessoais.
NOTA:
|
concurrentParticipants |
Não |
Integer |
Corpo |
Número máximo de participantes na reunião.
|
Códigos de status
Código de status HTTP |
Descrição |
---|---|
200 |
Operação bem-sucedida. |
400 |
Parâmetros inválidos. |
401 |
A autenticação não é executada ou falha. |
403 |
Permissões insuficientes. |
500 |
Exceção do servidor. |
Parâmetros de resposta
Parâmetro |
Tipo |
Descrição |
---|---|---|
[Array element] |
Array of ConferenceInfo |
Lista de informações da reunião. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
cycleSubConfID |
String |
UUID de uma reunião recorrente. |
conferenceID |
String |
ID da reunião, que contém até 32 caracteres. |
mediaType |
String |
Tipo de mídia da reunião. O valor consiste em um ou vários valores enumerados, que são separados por vírgulas (,). Os valores enumerados são os seguintes:
|
startTime |
String |
Hora de início da reunião (formato: AAAA-MM-DD HH:MM). |
endTime |
String |
Hora de fim da reunião (formato: AAAA-MM-DD HH:MM). |
isAutoRecord |
Integer |
Se a gravação é ativada automaticamente. |
confConfigInfo |
Confconfinginfo object |
Outras configurações sobre a reunião recorrente. |
recordAuthType |
Integer |
Modo de autenticação de gravação. Este parâmetro é válido somente quando recordType é definido como 2 ou 3.
|
description |
String |
Descrição da reunião, que contém até 200 caracteres. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
callInRestriction |
Integer |
Participantes que podem participar da reunião.
|
audienceCallInRestriction |
Integer |
Participantes que podem participar do webinar.
|
allowGuestStartConf |
Boolean |
Se permitir que os convidados iniciem a reunião. (Esse parâmetro é válido somente para reuniões com IDs aleatórios.)
|
enableWaitingRoom |
Boolean |
Se a sala de espera está ativada. |
showAudienceCountInfo |
ShowAudienceCountInfo object |
Regra de exibição do número de participantes do webinar. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
showAudienceMode |
Integer |
Regra de exibição do número de participantes. O servidor calcula e entrega o número de participantes aos clientes.
|
baseAudienceCount |
Integer |
Base de quantidade de participantes, variando de 0 a 10.000. |
multiple |
Double |
Multiplicador, variando de 1 a 10. O valor pode ser preciso até uma casa decimal. |
Exemplo de solicitação
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 }
Exemplo de resposta
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 erro
Se um código de erro começando com MMC ou USG for retornado quando você usar essa API, corrija a falha seguindo as instruções fornecidas no Centro de erros da API da Huawei Cloud.
Exemplo 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'