- Página inicial
- /
- Artigo
Cisco Webex Meetings geral das atualizações de API da reunião (API 41)
Encontre todas as informações importantes de que você precisa sobre a API Cisco Webex Meetings recente, como alterações de esquema e outros anúncios.
Para obter mais informações sobre a API XML 39 e API XML 11, consulte a Visão geral das atualizações da API XML do Cisco Webex Meetings (API XML 39 e anterior).
Para obter mais informações sobre a API XML 40, consulte a Visão geral das atualizações da API XML do Cisco Webex Meetings (API XML 40 e posterior).
Para atualizações para XML API 11 SP9 e anterior, vá para Cisco DevNet.
Atualizações api 41.12.0
Atualizações XML API 41.12.0
O XMLAPI bloqueará a agenda e edição do Webex Events (Clássico) de acordo com o item de configuração do site do EnableClassicEvent
que é falso
Alterações de APIs e esquema afetados
Na página de configuração da administração do site, se a caixa de seleção Ativar evento clássico for falsa, este site não suportará mais Webex Events reuniões (clássicas).
Se a caixa de seleção Habilitar clássicoEvent for falsa, você liga para estas APIs para operar Webex Events reunião (clássica) :
Criar evento
, SetEvent
, GetEvent
, Informações do GetSessionInfo
, Evento Lstsummary
, LstrecordedEvent
, Programa LstsummaryProgram
, UploadEventImage
A API responderá à nova exceção 010106 O Evento clássico foi desativado .
Alterações de esquema
Nenhuma alteração de esquema.
Exemplo de resposta e solicitação API
CriarEvent Solicitação e resposta da API
Solicitação de CreateEvent
XXXXXXXX
Testes XMLAPI EC
17/07/2021 01:29:15
15
Resposta de CreateEvent
<?xml version="1.0" encoding="ISO-8859-1"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:event="http://www.webex.com/schemas/2002/06/service/event">
<serv:header>
<serv:response>
<serv:result>FALHA</serv:result>
<serv:reason>O Evento clássico foi desativado.</serv:reason>
<serv:gsbStatus>PRIMÁRIO</serv:gsbStatus>
<serv:exceptionID>010106</serv:exceptionID>
</serv:resposta>
</serv:header>
<serv:body>
<serv:bodyContent/>
</serv:body>
CreateEvent3.1.3 Afeta as APIs:
-
SetEvent GetEvent
-
ObterInformações da sesessão
-
LstsummaryEvent
-
LstrecordedEvent
-
LstsummaryProgram
-
UploadEventImage
XMLAPI LstMeetingType
responderá ao novo elemento de subProductCodePrefix
APIs impactadas
Atual o elemento de resposta API LstMeetingType
de productionCodePrefix
: PRO, AUO e outros que são prefixos do tipo de reunião predefinidos do Webex.
Após esse novo aprimoramento, a API responderá ao novo elemento do subProdctCodePrefix
:PRO1, PRO2, etc., que pode ser personalizado para atender ao prefixo do tipo.
Alterações de esquema na API: Tipo LstMeeting
Será um novo elemento de resposta: subProdctCodePrefix
Exemplo de resposta e solicitação API
LstMeetingType
Solicitação e resposta de API
Solicitação de LstMeetingType
13810
Resposta de LstMeetingType
<serv:bodyContent xsi:type="mtgtype:lstMeetingTypeResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<mtgtype:matchingRecords>
<serv:total>1</serv:total>
<serv:returned>1</serv:returned>
<serv:startFrom>1</serv:startFrom>
</mtgtype:matchingRecords>
<mtgtype:productCodePrefix>PRO</mtgtype:productCodePrefix>
<mtgtype:subProductCodePrefix>PRO3</mtgtype:subProductCodePrefix> //Novo elemento para tipo de reunião personalizado
<mtgtype:active>ATIVADO</mtgtype:active>
<mtgtype:name>Cus_Chat_Fechado</mtgtype:name>
<mtgtype:displayName>Cus_Chat_Fechado</mtgtype:displayName>
Atualizações api 41.11.0
Atualizações XML API 41.11.0
Compatibilidade encaminhada de suporte API xml na API de gerenciamento de usuários para sites gerenciados pelo Control Hub
Alterações de APIs e esquema afetados
Se o seu aplicativo de integração estiver usando atualmente APIs de gerenciamento de usuário XMLAPI Webex: CreateUser
, SetUser
, DelUser
, e GetUser
para provisionar ou gerenciar usuários, após seu site clássico Webex convertido no site gerenciado pelo Control Hub, essas APIs continuarão a funcionar para compatibilidade avançada. Existem algumas mudanças de comportamento, como se pode ver abaixo:
-
Ao usar createUser - se o status do usuário no Control Hub não for "ativo", o status do usuário no site não estará ativo. Se o status do usuário no Control Hub estiver ativo, o status do usuário no site também será ativo, referência: Status do usuário de usuários novos e convertidos no Control Hub .
-
O elemento de senha das APIs CreateUser e SetUser será ignorado. Começará a enviar e-mail de ativação para novos usuários e os usuários poderão clicar no link no e-mail para ativar a nova conta e inserir a nova senha.
-
O active element of CreateUser API será ignorado, o novo usuário (não verificado) não poderá ser ativado através do esse parâmetro usando a API SetUser .
-
O valor do elemento webExId no corpoContent de CreateUser APIs deve ser igual ao e-mail. Se webExId for diferente de email , trataremos o webExId mesmo que email ao armazená-lo no WebDB e o valor será ignorado.
-
O valor do webExId elemento no bodyContent de SetUser APIs deve ser a identidade do usuário do endereço de e-mail, você pode alterá-lo usando < email > no bodyContent.
-
A API SetUser suportará a alteração do e-mail do usuário existente: isso será bem-sucedido se a conta de operação no SecurityContext for o administrador completo do site do Control Hub. Caso contrário, o API reporta erro com novo código de erro e mensagem abaixo:
-
030120 A conta deve ser um administrador completo do site para alterar o e-mail.
-
-
O elemento newWebExId no bodyContent do SetUser API será ignorado.
-
A API SetUser tenta alterar para um e-mail que já está em uso, a API aumenta abaixo o novo código de erro e a mensagem de erro:
-
030118 O e-mail já é usado em sites gerenciados pelo Control Hub.
-
-
A API do DelUser desativa o usuário do lado da reunião Webex e a licença de reunião correspondente é removida do site Webex. Este usuário desativado pode ser reativado usando o API: SetUser (ATIVADO), desde que o usuário seja verificado antes.
-
As APIs CreateUser e SetUser levantam o novo código de erro e a mensagem de erro como mostrado abaixo:
-
030117 , este usuário existe fora da sua organização, portanto, precisa ser reivindicado, para se mover para sua organização através do processo de reivindicação de usuário. Para saber as etapas para reivindicar o usuário em sua organização, consulte Reivindicar usuários para sua organização (Converter usuários). Você precisará verificar o domínio ao que o usuário pertence antes de reivindicar o usuário.
-
030119 O token de acesso CI deve incluir escopo webexsquare: admin ao provisionar usuário.
-
Somente a compatibilidade de encaminhamento de um período limitado é suportada. Forneceremos um aviso avançado antes que essa compatibilidade seja removida.
Alterações de esquema
Nenhuma alteração de esquema nessas APIs: CreateUser
, SetUser
, DelUser
, e GetUser
.
Exemplo de resposta e solicitação API
CriarUsuário Solicitação de API e resposta
Solicitação de API:
<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:serv="http://www.webex.com/schemas/2002/06/service"
xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service http://www.webex.com/schemas/2002/06/service/service.xsd">
<cabeçalho>
<securityContext>
<siteName>{siteName}</siteName>
<webExID>{site Admin account}</webExID>
<email>{site Admin account}</email>
<sessionTicket>xxxx</sessionTicket> ou ou
ou , ao usar CI "accessToken", ele deve incluir o escopo webexsquare:admin ao provisionar o usuário
</securityContext>
</cabeçalho>
<head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/></head><body>
<bodyContent xsi:type="java:com.webex.service.binding.user.CreateUser">
<webExId>Jack@qa.webex.com</webExId> --- deve ser a identidade do usuário do endereço de e-mail
<email>Jack@qa.webex.com</email>
<firstName>Jack</firstName>
<lastName>Smith</lastName>
<password>....</password>
<privilégio>
<host>verdadeiro</host>
</privilégio>
<active>ACTIVATED</active> ---esse parâmetro não pode ativar o usuário diretamente até que o usuário se ative por e-mail de ativação.
</bodyContent>
</body>
Exemplo de resposta da API:
<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:use="http://www.webex.com/schemas/2002/06/service/user">
<serv:header>
<serv:response>
<serv:result>SUCESSO</serv:result>
<serv:gsbStatus>PRIMÁRIO</serv:gsbStatus>
</serv:resposta>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="use:createUserResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<use:userId>23778617</use:userId>
</serv:bodyContent>
Afetar APIs:
-
Createuser
-
Setuser
-
DelUser
API XML suporta a compatibilidade encaminhada de autenticação do usuário existente depois que o site clássico Webex é convertido para o site gerenciado pelo Control Hub
APIs impactadas
Depois que o site clássico Webex é convertido para o site gerenciado pelo Control Hub, o valor do elemento no precisa ser igual ao e-mail, detalhes abaixo:
-
Para usuários existentes criados no site clássico Webex, suportamos tanto o webExID antigo (por exemplo: Jack) e o novo webExID (o conteúdo é o mesmo que o e-mail, exemplo: Jack@xx.com) para fazer logon, essa compatibilidade com compatibilidade retrotrógrada de autenticação é para todas as APIs XML.
-
Para novos usuários criados nos sites gerenciados pelo Control Hub, o valor do elemento webExID deve ser o mesmo que o e-mail para logon.
{siteName}
{userName} --- usuários existentes foram criados no site clássico do webEx, pode ser: jack ou jack@xx.com; novo usuário deve usar jack@xx.com
xxxx ou ou ou
Afetar APIs:
Todas as APIs XML.
Depois que o site clássico Webex convertido em um site gerenciado pelo Control Hub, o valor do < webExID> elemento < bodyContent > precisa ser igual ao e-mail, detalhes abaixo:
-
Para usuários existentes criados no site Webex clássico, suportamos o antigo webExId (por exemplo: Jack) e o novo webExId (o conteúdo é o mesmo que o e-mail, por exemplo: Jack@xx.com) no bodyContent.
-
Para novos usuários criados em sites gerenciados pelo Control Hub, o valor do elemento webExId deve ser igual ao e-mail no
bodyContent
.
xxxx --- usuários existentes foram criados no site clássico webEx, pode ser: jack ou jack@xx.com; novo usuário deve usar jack@xx.com
Afetar APIs: GetUser
, SetUser
, e DelUser
.
Alterações de esquema
Nenhuma alteração de esquema em nenhuma APIs.
Exemplo de resposta e solicitação API
GetUser Solicitação e resposta da API
Solicitação de API:
<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:serv="http://www.webex.com/schemas/2002/06/service"
xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service http://www.webex.com/schemas/2002/06/service/service.xsd">
<siteName>{siteName}</siteName>
<webExID>{userName}</webExID> --- usuários existentes foram criados no site clássico webEx, pode ser: jack ou jack@xx.com; novo usuário deve usar jack@xx.com
xxxx ou ou ou
xxxx --- usuários existentes foram criados no site clássico do webEx, pode ser: jack ou jack@xx.com; novo usuário deve usar jack@xx.com
Exemplo de resposta da API:
...o mesmo de antes
Melhoria na API do relatório de histórico de exibição de gravação para suportar Webex Meetings, Webex Events (nova) e Webex Events (clássica)
APIs impactadas
API atual: lstrecordaccessHistory
e lstrecordaccessDetailHistory
suportam apenas o relatório do histórico acessado na exibição de gravações do Webex Trainings. O novo aprimoramento suporta Webex Meetings, Webex Events (novo) e Webex Events (clássico) relatório de histórico de gravação acessado também.
Alterações de esquema
Suportamos abaixo novo esquema no API lstrecordaccessHistory no corpo da solicitação de API:
MeetingCenter
TrainingCenter
EventCenter
Detalhes
A API: lstrecordaccessHistory
é capaz de retornar o histórico de acesso da exibição de gravação para Webex Meetings, Webex Events (novo), Webex Events (clássico) e Webex Trainings.
-
Se não houver nenhum serviceType especificado na solicitação de API, a API do
lstrecordaccessHistory
retorna apenas o histórico de acesso da exibição de gravação do Webex Trainings. -
Quando o serviceType é MeetingCenter, a API do
lstrecordaccessHistory
retorna o histórico acessado da exibição de gravação Webex Meetings e Webex Events (novo). -
Quando o serviceType é o EventCenter, a API do
lstrecordaccessHistory
retorna o histórico de acesso da exibição de gravação do Webex Events (clássico).
A API: lstrecordaccessDetailHistory
é capaz de retornar detalhes por recordID
de Webex Meetings, Webex Events (novo), Webex Events (clássico) e Webex Trainings.
Exemplo de resposta e solicitação API
lstrecordaccessHistory
Solicitação e resposta da API
<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<cabeçalho>
<securityContext>
<webExID>{userName}</webExID>
<password>{password}</password>
<siteName>{siteName}</siteName>
</securityContext>
</cabeçalho>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.history.LstrecordaccessHistory">
<viewTimeScope>
<viewTimeStart>20/09/2021 00:00:00</viewTimeStart>
<viewTimeEnd>28/09/2021 23:59:59</viewTimeEnd>
</viewTimeScope>
<listControl>
<startFrom>1</startFrom>
<maximumNum>100</maximumNum>
</listControl>
<orderBy>GRAVADO</orderBy>
<orderAD>ASC</orderAD>
<serviceTypes>
<serviceType>MeetingCenter</serviceType>
<serviceType>TrainingCenter</serviceType>
<serviceType>EventCenter</serviceType>
</serviceTypes>
</bodyContent>
</body>
<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:history="http://www.webex.com/schemas/2002/06/service/history">
<serv:header>
<serv:response>
<serv:result>SUCESSO</serv:result>
<serv:gsbStatus>PRIMÁRIO</serv:gsbStatus>
</serv:resposta>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="history:lstrecordaccessHistoryResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<history:recordAccessHistory>
<history:recordID>1XXXXXXX7</history:recordID>
<history:recordName>LstrecordaccessHistory test TC-20210924 1324-1</history:recordName>
<history:creationTime>24/09/2021 13:28:13</history:creationTime>
<history:registered>0</history:registered>
<history:baixado>2</history:baixado>
<history:viewed>1</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordAccessHistory>
<history:recordAccessHistory>
<history:recordID>1XXXXXXX7</history:recordID>
<history:recordName>TestErollment_001-20210610 1905-1</history:recordName>
<history:creationTime>06/10/2021 19:10:15</history:creationTime>
<history:registered>0</history:registered>
<history:baixado>0</history:baixado>
<history:viewed>3</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordAccessHistory>
<history:recordAccessHistory>
<history:recordID>1XXXXXXX7</history:recordID>
<history:recordName>Testar reprodução instantânea 2-20210705 0709-1</history:recordName>
<history:creationTime>05/07/2021 07:15:06</history:creationTime>
<history:registered>0</history:registered>
<history:baixado>0</history:baixado>
<history:viewed>1</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordAccessHistory>
<history:recordAccessHistory>
<history:recordID>1XXXXXXX7</history:recordID>
<history:recordName>EC2.0_232423-20210922 0447-1</history:recordName>
<history:creationTime>22/09/2021 04:53:05</history:creationTime>
<history:registered>0</history:registered>
<history:baixado>0</history:baixado>
<history:viewed>1</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordAccessHistory>
<history:recordAccessHistory>
<history:recordID>1XXXXXXX7</history:recordID>
<history:recordName>Teste LstrecordaccessHistory EC2.0-20210924 1315-1</history:recordName>
<history:creationTime>24/09/2021 13:19:00</history:creationTime>
<history:registered>0</history:registered>
<history:baixado>1</history:baixado>
<history:viewed>1</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordAccessHistory>
<history:recordAccessHistory>
<history:recordID>1XXXXXXX7</history:recordID>
<history:recordName>LstrecordaccessHistory test MC-20210924 1319-1</history:recordName>
<history:creationTime>24/09/2021 13:25:12</history:creationTime>
<history:registered>0</history:registered>
<history:baixado>1</history:baixado>
<history:viewed>1</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordAccessHistory>
<history:recordAccessHistory>
<history:recordID>1XXXXXXX7</history:recordID>
<history:recordName>LstrecordaccessHistory test EC classic-20210924 1331-1</history:recordName>
<history:creationTime>24/09/2021 13:37:28</history:creationTime>
<history:registered>0</history:registered>
<history:baixado>1</history:baixado>
<history:viewed>1</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordAccessHistory>
<history:matchingRecords>
<serv:total>8</serv:total>
<serv:returned>7</serv:returned>
<serv:startFrom>1</serv:startFrom>
</history:matchingRecords>
</serv:bodyContent>
lstrecordaccessDetailHistory
Solicitação e resposta da API
<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:serv="http://www.webex.com/schemas/2002/06/service">
<cabeçalho>
<securityContext>
<webExID>{userName}</webExID>
<password>{password}</password>
<siteName>{siteName}</siteName>
</securityContext>
</cabeçalho>
<body>
<bodyContent xsi:type=
"java:com.webex.service.binding.history.LstrecordaccessDetailHistory">
<recondID>1XXXXXX7</recondID>
<timeZoneID>20</timeZoneID>
</bodyContent>
<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:history="http://www.webex.com/schemas/2002/06/service/history">
<serv:header>
<serv:response>
<serv:result>SUCESSO</serv:result>
<serv:gsbStatus>PRIMÁRIO</serv:gsbStatus>
</serv:resposta>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="history:lstrecordaccessDetailHistoryResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<history:recordDetail>
<history:viewID>1XXXXXX7</history:viewID>
<history:participantName>Axxxg</history:participantName>
<history:participantEmail>Axxxg@qa.webex.com</history:participantEmail>
<history:accessTime>24/09/2021 13:27:26</history:accessTime>
<history:registered>false</history:registered>
<history:baixado>false</history:baixado>
<history:viewed>true</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordDetail>
<history:recordDetail>
<history:viewID>1XXXXXX7</history:viewID>
<history:participantName>Axxxg</history:participantName>
<history:participantEmail>Axxxg@qa.webex.com</history:participantEmail>
<history:accessTime>24/09/2021 13:27:39</history:accessTime>
<history:registered>false</history:registered>
<history:baixado>true</history:baixado>
<history:viewed>false</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordDetail>
<history:matchingRecords>
<serv:total>2</serv:total>
<serv:returned>2</serv:returned>
<serv:startFrom>1</serv:startFrom>
</history:matchingRecords>
</serv:bodyContent>
Afetar APIs:
-
lstrecordaccessHistory
-
lstrecordaccessDetailHistory
Corrige a lacuna máxima permitida Webex Events tamanho da descrição (clássica) entre XMLAPI e a página Webex.
APIs impactadas
A API XML: CreateEvent and SetEvent's element of description permitirá o máximo de entradas de 10000 caracteres, se inserção de tamanho superior, resultará no novo código de erro e mensagem:
060068 entrada ilegal. Esta descrição não pode exceder 10000 caracteres.
Alterações de esquema
Nenhuma alteração de esquema.
Exemplo de resposta e solicitação API
CriarEvent Solicitação e resposta da API
#Exemplo de solicitação de API:
...
<bodyContent xsi:type="java:com.webex.service.binding.event.CreateEvent"
xmlns: att="http://www.webex.com/schemas/2002/06/service/event" xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service/event http://www.webex.com/schemas/2002/06/service/event/event.xsd">
<accessControl>
<sessionPassword>111111</sessionPassword>
<listing>PRIVADO</listing>
</accessControl>
<metaData>
<sessionName>Teste EC</sessionName>
<description>....... Suponha que você preencha 10000 caracteres na descrição.......</description>
</metaData>
...
------------------------------------ ------------------------------------
#Exemplo de resposta API quando a descrição excede 10000 caracteres:
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:event="http://www.webex.com/schemas/2002/06/service/event">
<serv:result>FALHA</serv:result>
Descrição de entrada ilegal. A descrição não pode exceder 10000 caracteres
<serv:gsbStatus>PRIMARY</serv:gsbStatus>
<serv:exceptionID>060068</serv:exceptionID>
<serv:bodyContent/>
<serv:body>
</serv:message>
Afetar APIs:
-
Createevent
-
Setevent
API de XML: GetUser retorna novo elemento de conta livre
APIs impactadas
GetUser
retorna um novo elemento que identifica freeAccount
a conta de usuário é FreeAccount
ou não.
Alterações de esquema
Exemplo de resposta GetUser
Resposta do GetUser:
<use:inicials>AW</use:inicials>
<use:isUploaded>false</use:isUploaded>
<use:largeEventCapacity>3</use:largeEventCapacity>
<use:freeAccount>false</use:freeAccount>
<serv:body>
</serv:message>
Afetar APIs:
Getuser
Atualizações api 41.10.0
Não há alterações de esquema no esquema XML API 41.10.0.
Atualizações api 41.9.0
Atualizações xml API 41.9.0
Descompactar XML API 10.0.0 para todos os sites T31
A Webex planeja fim da vida útil XML API ver 10.0.0 para todos os sites T31.
Estamos desativando o código XML API 10.0.0 de todas as produções na atualização 41.9.0.
Atualizações api 41.8.0
Atualizações xml API 41.8.0
Descompactar XML API 10.0.0 para todos os sites T31
A Webex planeja fim da vida útil XML API ver 10.0.0 para todos os sites T31.
A Webex encontrou alguns clientes acessando a URL da API XML usando a maneira incorreta como: https://{siteName}.webex.com/WBXService/xml10.0.0/XMLService, a maneira certa de acessar a URL de API XML como: https://{siteName}.webex.com/WBXService/XMLService.
Alternar a API XML de acesso de código usando a maneira certa para evitar o impacto antes de fim da vida útil suporte sobre XML API versão 10.0.0.
Atualizações api 41.7.0
Atualizações xml API 41.7.0
A exclusão e edição de gravação móvel deve ser controlada pela opção de administração do site: Permitir que os hosts reatribuam, editem, desabilitem e excluam gravações
Alterações de APIs e esquema afetados
GetSite
: retornará novos elementos nomeando enableNBRMCModify
, e separarNoRecordingEdit
em ferramentas.
Exemplo de resposta
GetSiteResponse
:
GetSite
<?xml version="1.0" encoding="ISO-8859-1"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:ns1="http://www.webex.com/schemas/2002/06/service/site" xmlns:event="http://www.webex.com/schemas/2002/06/service/event">
<serv:header>
<serv:response>
<serv:result>SUCESSO</serv:result>
<serv:gsbStatus>PRIMÁRIO</serv:gsbStatus>
</serv:resposta>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="ns1:getSiteResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
...
<ns1:tools>
...
<ns1:enableNBRMCModify>false</ns1:enableNBRMCModify>
<ns1:separateNoRecordingEdit>true</ns1:separateNoRecordingEdit>
...
</ns1:tools>
</serv:bodyContent>
Atualizações api 41.6.3
Atualizações XML API 41.6.3
GetSite
Responder novo elemento de supportLargeEvent
Alterações de APIs e esquema afetados
GetSite : retorna novos elementos nomeando supportLargeEvent
sob siteCommonOptions
para informar ao autor da chamada se o site é compatível com o Grande Evento (Webex Event (novo)) ou não.
Alteração do esquema
Exemplo de resposta
GetSiteResponse
:
GetSite
<?xml version="1.0" encoding="ISO-8859-1"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:ns1="http://www.webex.com/schemas/2002/06/service/site" xmlns:event="http://www.webex.com/schemas/2002/06/service/event">
<serv:header>
<serv:response>
<serv:result>SUCESSO</serv:result>
<serv:gsbStatus>PRIMÁRIO</serv:gsbStatus>
</serv:resposta>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="ns1:getSiteResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
...
<ns1:siteCommonOptions>
...
<ns1:enablePreMeetingLobby>false</ns1:enablePreMeetingLobby>
<ns1:supportLargeEvent>true</ns1:supportLargeEvent>
</ns1:siteCommonOptions>
</serv:bodyContent>
Atualizações api 41.6.0
Atualizações XML API 41.6.0
Suporte a XMLAPI Webex Events 2.0 no provisionamento
APIs impactadas
GetUser
: retorna novo elemento nomeando largeEventCapacity
que mostra a capacidade do novo Evento 2.0 (EC 2.0) nesta conta de usuário. Por exemplo, se a conta do usuário tiver a licença CI _ EC3K, o valor de largeEventCapacity
é 3000.
Alterações de esquema
Exemplo de resposta
GetUserResponse:
CreateTime de XMLAPI LstRecording aplica hora de início da gravação
APIs impactadas
LstRecording
: LstRecording
response CreateTime
como o tempo em que o usuário realmente pressiona o botão Gravar.
Detalhes
No passado, a API XML usou o carimbo de data/hora de quando a gravação foi criada no banco de dados como a hora de criação na resposta LstRecording
. Agora é a hora que o usuário realmente começa a fazer a gravação. Essa alteração se aplica a todas as gravações de serviço. Não há nenhuma alteração de esquema.
Atualizações api 41.5.0
Atualizações xml API 41.5.0
XMLAPI tem a habilidade de iniciar reuniões Webex agendadas a PSTN como o anfitrião
APIs impactadas
-
CriarUsuário
: gerahostPIN
independentemente do PMR do usuário estar habilitado ou não quando a função do usuário é organizador ou administradores do site completo ou de somente leitura ou de gerenciamento de usuários. -
SetUser
: definehostPIN
usandophones.hostPIN
quandopersonalMeetingRoom.hostPIN
não está na solicitação XML (pré-condição: alternância de recursosAllowStartScheduledMtgFromPhone
está ativada). -
GetUser
: retornaphones.hostPIN
independentemente de o usuário PMR estar ativado ou não. (pré-condição: alternância de recursosAllowStartScheduledMtgFromPhone
está ativada).
Alterações de esquema
GetUserResponse
:
SetUser
:
Exemplo de resposta
GetUserResponse
:
SetUser
:
XMLAPI GetSite
resposta dois novos elementos para o cliente móvel
APIs impactadas
-
GetSite
:GetSite
agora responderá a dois novos elementos para suportar o cliente móvel tem a lógica de exibir ou não a guia de gravação.-
enableRecordingAccess
: verdadeiro ou falso, os superadministradores Webex podem ativar ou desativar o acesso à gravação pelo botão de alternância (EnableRecordingAccesses
). -
storageEmptyStatus
: verdadeiro ou falso, se ambos os sites não suportam a função NBR e alocaram o espaço de armazenamento NBR como zero, então a resposta de status é verdadeira, caso contrário é falsa.
-
Alterações de esquema
Solicitação de amostra para GetSite
Resposta de amostra para Getsite
Assunto do e-mail que tem caracteres não ASCII será codificado com RFC2047. No caso de um e-mail de caractere ASCII puro, não há codificação
APIs impactadasNão há impactos sobre qualquer solicitação de API, carga de respostas, mas isso altera o comportamento de codificação do assunto do e-mail. Quando o assunto do e-mail que tiver caracteres não ASCII será codificado com RFC2047. No caso de um e-mail de caractere ASCII puro, não há codificação.
Alterações de esquema
Não há alterações de esquema.
Atualizações api 41.4.0
Atualizações xml API 41.4.0
Criar evento agendado Webex Events aproveitar o padrão no nível do site no tom de entrada e saída
XMLAPI se alinha com a nova lógica atual para controlar o tom de entrada e saída. Todos os tons para o Webex Events foram controlados por uma configuração diferente na administração do site. No GetSite, XMLAPI retorna uma entrada de campo
extraExitToneEC
para indicar o valor. Originalmente, quando o administrador do site definir um padrão para o tom, criar Evento não aproveitará essa configuração aplicando XMLAPI padrão.
APIs impactadas
A API XML: GetSite retorna um novo elemento entryExitToneEC
para indicar o valor.
A API XML: CreateEvent, SetEvent, GetEvent lógica de negócios back-end lê o valor de entryExitToneEC
.
Alterações de esquema
API de XML: Amostra de resposta getSite:
true
ANÚNCIO
NOTONE
verdadeiro
NENHUM
true
false
Afetar APIs:
-
GetSite
-
Createevent
-
Setevent
-
Getevent
XMLAPI simplesmente retorna as informações de detalhes do evento grande (Webex Event 2.0)
-
Se a reunião Webex for o grande evento ou webcast, a GetSessionInfo retornará algumas informações detalhadas, incluindo senha de reunião, senha numérica da reunião, senha numérica do palestrante e senha numérica do palestrante (Nenhum esquema será
alterado).
-
XMLAPI não suporta a criação e edição de qualquer grande evento ou recurso de webcast, por isso CreateMeeting e SetMeeting retornam uma nova exceção
(110064, o tipo de sessão de evento e webcast não são suportados.) para grandes eventos ou
casos de webcast.
APIs de impacto
Nome da API |
Descrição |
Observação |
---|---|---|
|
Se a reunião Webex for um evento ou webcast grande, o GetSessionInfo retorna a senha da reunião, a senha numérica da reunião, a senha numérica dos palestrantes e a senha numérica |
Nenhum esquema será alterado. |
|
Se o usuário tentar usar a api CreateMeeting para criar uma reunião Webex com grande tipo de sessão de evento ou ligar para SetMeeting para editar uma reunião Webex que na verdade é um grande evento ou webcast, retorne uma nova exceção |
Comportamento a ser alterado. |
Atualizações api 41.3.0
Atualizações xml API 41.3.0
As novas alterações da API XML suportam Webex Events recurso 2.0
APIs impactadas
Ambos os APIs: GetSessionInfo e GetMeeting elementos de retorno enableEvent
e enableWebniar
também.
Nome do elemento |
Descrição |
---|---|
enableEvent |
Suporta EC 2.0 em uma reunião Webex |
habilitarWebniar |
Suporta webinar em uma reunião Webex |
O suporte XMLAPI retorna acima dos dois elementos para o EC 2.0. A versão atual da API XML não suporta agendar e definir reuniões EC2.0.
Alterações de esquema
GetSessionInfo
retorna elementos enableEvent
e enableWebniar
para EC 2.0.
GetMeeting
retorna elementos enableEvent
e enableWebniar
para EC 2.0.
Exemplo de resposta:
GetSessionInfo
resposta:
<ep:listStatus>PUBLIC</ep:listStatus>
<ep:registration>false</ep:registration>
<ep:passwordReq>true</ep:passwordReq>
<ep:isEnforceAudioPassword>false</ep:isEnforceAudioLogin>
<ep:isEnforceAudioLogin>false</ep:isEnforceAudioLogin>
<ep:enableEvent>false</ep:enableWebniar>
<ep:enablePreMeetingLobby>true</ep:enablePreMeetingLobby>
Resposta do GetMeeting
:
<meet:supportPKI>false</meet:supportPKI>
<meet:HQvideo>true</meet:HQvideo>
<meet:HDvideo>true</meet:HDvideo>
<meet:viewVideoThumbs>true</meet:viewVideoThumbs>
<meet:enableEvent>false</meet:enableWebniar>
<meet:enableWebniar>false</meet:enableWebniar>
<meet:enablePreMeetingLobby>true</meet:enablePreMeetingLobby>
As novas alterações do XMLAPI suportam o recurso de lobby de Pré-reunião
APIs impactadas
A API XML: GetSite
, LstSummarySession
, GetSessionInfo
, e GetMeeting
responderá ao novo elemento enablePreMeetingLobby
para o lobby pré-reunião.
Alterações de esquema
A API XML: GetSite
retorna o elemento enablePreMeetingLobby
para o Lobby pré-reunião.
A API XML: LstSummarySession
retorna o elemento enablePreMeetingLobby
para o lobby pré-reunião.
A API XML: GetSessionInfo
retorna o elemento enablePreMeetingLobby
para o lobby pré-reunião.
A API XML: GetMeeting
retorna o elemento enablePreMeetingLobby
para o Lobby pré-reunião.
Exemplo de resposta:
Resposta do GetSite
:
false
false
false
verdadeiro
true
true
true
false
true
verdadeiro
Resposta LstSummarySession
:
false
true
0
false
false
false
verdadeiro
GetSessionInfo
resposta:
<ep:listStatus>PUBLIC</ep:listStatus>
<ep:registration>false</ep:registration>
<ep:passwordReq>true</ep:passwordReq>
<ep:isEnforceAudioPassword>false</ep:isEnforceAudioLogin>
<ep:isEnforceAudioLogin>false</ep:isEnforceAudioLogin>
<ep:enableEvent>false</ep:enableWebniar>
<ep:enablePreMeetingLobby>true</ep:enablePreMeetingLobby>
Resposta do GetMeeting
:
<meet:supportPKI>false</meet:supportPKI>
<meet:HQvideo>true</meet:HQvideo>
<meet:HDvideo>true</meet:HDvideo>
<meet:viewVideoThumbs>true</meet:viewVideoThumbs>
<meet:enableEvent>false</meet:enableWebniar>
<meet:enableWebniar>false</meet:enableWebniar>
<meet:enablePreMeetingLobby>true</meet:enablePreMeetingLobby>
A alteração do comportamento das Informações de resposta XML API GetSite
divulgada
APIs impactadas
A API XML: GetSite
resposta somente abaixo de elementos para a conta de administrador, que incluem funções: SiteAdmin
, RO _ SiteAdmin
, e UserAdmin
.
....
<ns1:TCActiveUserCount>
<ns1:SCActiveUserCount>...</ns1:SCActiveUserCount>...</ns1:SCActiveUserCount>
Comportamento alterado
Permitir apenas a função de Administrador tem resposta dados de licença de GetSite
. O host ou o participante não receberão esses dados de licença em GetSite
resposta.
Abaixo estão as API: Exemplo de resposta do
GetSite para siteadmin
ou ready-only siteadmin
ou administrador de gerenciamento de usuários:
Atualizações api 41.2.0
Atualizações xml API 41.2.0
XMLAPI deve suportar "CMR híbrida VOIP" se o site suportar telefonia Webex
APIs impactadas
-
GetSite
retorna um novo elementoIsWebexTelephony
na resposta. -
CreateUser
andSetUser
pode atualizar ocmrHybridVoip
elemento seIsWebexTelephony
for verdadeiro junto com outras condições.IsTSPUsingTelephonyAPI
não é mais consequencial.
Alterações de esquema
API de XML: GetSite
resposta retorna um elemento adicional IsWebexTelephony
A resposta do
GetSite inclui este novo elemento:
true
false
Número da conferência pessoal.
Código de acesso do convidado
Código de acesso do organizador
ID do convidado
....
LstSummarySession
suporta EC2.0
APIs XML serão impactadas
LstSummarySession
retornará novos dois elementos para suportar o EC 2.0
Nome do elemento |
Descrição |
---|---|
enableEvent |
Suporta EC 2.0 em uma reunião Webex |
habilitarWebniar |
Suporta webinar em uma reunião Webex |
Alterações de esquema
API de XML: LstSummarySession
: Anexar os elementos < enableEvent
> e < enableWebniar
>
Resposta de XML API: LstSummarySession
Resposta para EC 2.0
<ep:isNextUpcomingInstance>true</ep:isNextUpcomingInstance>
<ep:seriesMeetingKey>0</ep:seriesMeetingKey>
<ep:isScheduledPMR>false</ep:isScheduledPMR>
<ep:enableEvent>true</ep:enableEvent>
<ep:enableWebniar>true</ep:enableWebniar>
< ep:session>
XMLAPI suporta a opção de retornar o usuário do site Webex-voice-assistant
para a integração MCT
API afetada
GetUser
retorna um novo elemento webexAssistantEnabled
(verdadeiro ou falso) na resposta.
Alterações de esquema
getUserResponse
:
Exemplo de resposta
Atualizações api 41.1.0
Não há alterações de esquema no esquema XML API 41.1.