Convide de participantes
Descrição
Esta API é usada para convidar participantes para uma reunião.
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/control/conferences/participants |
Protocolo de transporte |
HTTPS |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Localização |
Descrição |
---|---|---|---|---|
conferenceID |
Sim |
String |
Consulta |
ID da reunião. |
X-Conference-Authorization |
Sim |
String |
Cabeçalho |
Token de controle de reunião, que é obtido através da API para obter um token de controle de reunião. |
attendees |
Sim |
Array of attendee objects |
Corpo |
Lista de participantes a convidar. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
userUUID |
Não |
String |
UUID do participante. |
accountId |
Não |
String |
Conta de participante, que é compatível com terminais de versões anteriores. Se userUUID não for especificado, a Plataforma de gerenciamento do Huawei Cloud Meeting consulta o participante usando accountId. |
name |
Sim |
String |
Nome ou alias do participante. O valor pode conter até 96 caracteres. |
role |
Não |
Integer |
Papel de participante na reunião. Valor padrão: 0.
|
phone |
Sim |
String |
Número de telefone. (Os formatos SIP e de número de telefone são suportados.) O valor pode conter até 127 caracteres. phone, email ou sms devem ser especificados. Se type estiver definido como telepresence e o dispositivo usado para ingressar na reunião for uma telepresença de tela tripla, defina esse parâmetro como o número da tela do meio. |
phone2 |
Não |
String |
Campo reservado. Os tipos de valor são os mesmos que os do parâmetro phone. Se type estiver definido para telepresence e o dispositivo usado para ingressar na reunião for uma telepresença de tela tripla, defina esse parâmetro para o número da tela esquerda. |
phone3 |
Não |
String |
Campo reservado. Os tipos de valor são os mesmos que os do parâmetro phone. Se type estiver definido para telepresence e o dispositivo usado para ingressar na reunião for uma telepresença de tela tripla, defina esse parâmetro para o número de tela correto. |
|
Não |
String |
Endereço de e-mail. O valor pode conter até 255 caracteres. phone, email ou sms devem ser especificados. (Nenhuma notificação é enviada aos participantes convidados durante a reunião.) |
sms |
Não |
String |
Número de telemóvel para receber notificações por SMS. O valor pode conter até 32 caracteres. phone, email ou sms devem ser especificados. (Nenhuma notificação é enviada aos participantes convidados durante a reunião.) |
type |
Sim |
String |
O valor padrão é definido pelo servidor do Huawei Cloud Meeting. Os valores enumerados são os seguintes:
|
deptUUID |
Não |
String |
ID do departamento. O valor pode conter até 64 caracteres. |
deptName |
Não |
String |
Nome do departamento. O valor pode conter até 128 caracteres. |
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
Nenhum
Exemplo de solicitação
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" }] }
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: 39 Connection: keep-alive http_proxy_id: b77bb5478e0b1fc0dbbb4e8d4e26ba65 Server: api-gateway X-Request-Id: 479fdc1d80e2e7ae19c4a08c28821822
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 na Centro de erros da API da Huawei Cloud.
Exemplo 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