Referências do desenvolvedor

Tópico modificado em: 2009-05-14

O grupo do Office Communications oferece os seguintes SDKs (Software Development Kit) e conjuntos de APIs (Interface de programação de aplicativo):

  • Office Communications Server 2007 R2 Server SDK
  • Unified Communications Managed API 2.0 Core SDK
  • Unified Communications Managed API 2.0 Speech SDK
  • Atividades de Fluxo de Trabalho do Windows para o Unified Communications Managed API 2.0
  • Office Communicator 2007 Automation API SDK
  • Unified Communications Client 1.0 SDK
  • Unified Communications AJAX 2007 SDK
  • Office Live Meeting Service API
  • Office Live Meeting Service Portal API

As seções a seguir fornecem uma visão geral de cada SDK e conjunto de APIs. Você encontrará links para a documentação do MSDN de cada SDK e conjunto de APIs na seção Consulte também no final deste tópico.

Office Communications Server 2007 R2 Server SDK

O Microsoft () contém dois conjuntos de APIs:

  • API de Aplicativo do
  • API de Gerenciamento do

API de Aplicativo do Communications Server

Um desenvolvedor pode usar a API de Aplicativo do para criar aplicativos que ampliem e aprimorem a funcionalidade baseada em SIP do . Desde o desenvolvimento de filtros de mensagens personalizados e o roteamento de aplicativos até os modelos transacionais de vários threads e a funcionalidade de log seguro, esse conjunto de APIs se destina aos desenvolvedores que desejam implementar comportamentos personalizados para o . Essas APIs podem monitorar e alterar mensagens SIP à medida que elas fluem pelo . Elas não podem ser usadas para criar mensagens SIP no servidor. Por exemplo, você não pode escrever aplicativos que criam mensagens instantâneas com essas APIs.

A API de Aplicativo do fornece um conjunto de ferramentas para implementar filtros de mensagens SIP personalizados e expedir mensagens para aplicativos registrados com o Office Communications Server. As três ferramentas principais são:

  • Manifestos de aplicativos, que definem comportamentos básicos de filtragem de mensagens e proxy.
  • A Microsoft SIP Processing Language (MSPL), que oferece um controle mais completo sobre os comportamentos de filtragem e proxy, bem como um recurso para expedir mensagens específicas para aplicativos SIP baseados em transações.
  • O namespace Microsoft.Rtc.Sip, que permite aos aplicativos acessar recursos fora do enquanto executam o roteamento e a filtragem.

Aplicativos que fornecem roteamento e filtragem usando apenas os recursos (por exemplo, presença) fornecidos pelo podem ser criados com a MSPL. Um aplicativo que bloqueie todas as mensagens instantâneas contendo referências HTTP pode ser escrito totalmente em MSPL.

No caso dos aplicativos que precisam de recursos externos ao , como informações sobre domínios ou acesso a bancos de dados, o respectivo código MSPL precisa expedir mensagens SIP para um processo separado que use o namespace Microsoft.Rtc.Sip. Um aplicativo que permite mensagens instantâneas com referências HTTP a sites corporativos confiáveis, mas bloqueia mensagens que fazem referência a sites não-confiáveis ou sites externos, requer um aplicativo separado, além de MSPL.

Para obter informações sobre as ferramentas listadas anteriormente, consulte as seguintes seções nesta documentação:

  • "Manifestos de aplicativos SIP", que são documentos XML que descrevem um aplicativo SIP para o computador em que o aplicativo é executado.
  • "Usando o SIP Managed Application API", que contém informações sobre a criação dos aplicativos SIP baseados em transações que são executados em .
  • "Referência do SIP Managed Application API", que contém documentação de referência do namespace Microsoft.Rtc.Sip e de outros recursos específicos de SIP.

API de Gerenciamento do Communications Server

A API de Gerenciamento do consiste em um conjunto de classes de WMI (Instrumentação de Gerenciamento do Windows) usadas para gerenciar componentes do . O WMI usa o modelo CIM padrão do setor para representar sistemas, aplicativos, redes, dispositivos e outros componentes gerenciados. A maioria das propriedades de classe é exposta no console de gerenciamento do . Todas as propriedades podem ser acessadas por meio de uma linguagem de script que dê suporte à hospedagem de scripts do ActiveX®, como o Microsoft Visual Basic Scripting Edition (VBScript).

Você pode usar scripts WMI para automatizar tarefas administrativas na implantação do . O WMI também pode ser usado para ler ou alterar remotamente propriedades WMI, mas o computador que executa o script deve ser um computador ou ter as Ferramentas do Administrador do instaladas.

Para obter mais informações sobre WMI, consulte Windows Management Instrumentation (WMI) no MSDN.

Unified Communications Managed API 2.0 Core SDK

O Microsoft Unified Communications Managed API 2.0 Core SDK é uma plataforma de código gerenciado que oferece acesso a mensagens instantâneas, telefonia, conferência de áudio/vídeo e presença, além do controle desses recursos. Ele se destina a dar suporte ao desenvolvimento de aplicativos de camada intermediária, tendo como objetivo o Microsoft Office Communicator e o Microsoft Office Communications Server 2007 R2.

O UCMA 2.0 Core SDK abstrai a maioria dos protocolos do Office Communications Server oferecendo uma API que expõe quase todos os recursos do protocolo, ainda mais simples de entender e usar. Por exemplo, os contatos e os grupos de um usuário podem ser consumidos com a classe ContactGroupServices. Uma conferência pode ser agendada com a classe ConferenceServices. Um usuário ou aplicativo pode iniciar uma conversa com outros usuários ou aplicativos por meio da classe Conversation. Um aplicativo pode assinar a presença de outros usuários ou aplicativos por meio das classes LocalOwnerPresence e RemotePresence.

Unified Communications Managed API 2.0 Speech SDK

O Microsoft Unified Communications Managed API 2.0 Speech SDK permite que os desenvolvedores criem aplicativos do Office Communications Server que utilizem os recursos de reconhecimento de fala e conversão de texto em fala.

Atividades de Fluxo de Trabalho do Windows para o Unified Communications Managed API 2.0

As Atividades de Fluxo de Trabalho do Windows para o UCMA 2.0 podem ser usadas para a criação rápida de aplicativos de fala e mensagens instantâneas habilitados para fluxo de trabalho no OCS. As Atividades de Fluxo de Trabalho do Windows para o UCMA 2.0 podem ser usadas para oferecer soluções para cenários simples, como o roteamento de chamadas, ou para cenários complexos encontrados por grandes empresas, como a integração de fluxo de trabalho de processo empresarial e colaboração de áudio.

Office Communicator 2007 Automation API SDK

O Microsoft () contém uma série de interfaces COM, objetos, eventos, tipos enumerados e outras entidades de programação relacionadas. Com o , é possível programar uma instância do () em um aplicativo de terceiros e escrever aplicativos que forneçam experiências do usuário estendidas e personalizadas com o .

Por exemplo, você pode entrar no chamando o método IMessenger::Signin. Esse procedimento é semelhante à entrada em uma instância do em execução clicando em Entrar no menu Conectar. Além disso, os recursos do podem ser integrados a outros aplicativos e estendidos ou personalizados para requisitos de aplicativos especiais. Um aplicativo de agendamento pode usar o para aproveitar os recursos de consulta e gerenciamento de contatos, para que os usuários possam organizar, exibir ou consultar seus contatos.

Como uma automação de suporte a APIs baseadas em COM, o pode ser chamado nos aplicativos escritos em Microsoft Visual Basic®, C/C++, VBScript e em várias outras linguagens de script. Por motivos de segurança, algumas chamadas de API são desabilitadas para linguagens de script. Para obter uma descrição completa dessas restrições, consulte a Referência do .

Com a ajuda do namespace System.Runtime.Interop no .NET Framework, a API também pode ser chamada nos aplicativos escritos em qualquer linguagem de programação baseada em .NET, incluindo a ferramenta de desenvolvimento Microsoft Visual C#®, o Visual Basic .NET, o Visual J#® e outros.

Unified Communications Client 1.0 SDK

Um desenvolvedor de aplicativos pode criar os seguintes tipos de aplicativos API para colaboração e comunicação em tempo real:

  • Um cliente de comunicação abrangente como o Microsoft (). Na verdade, o é criado no API. Esse tipo de aplicativo pode dar suporte aos recursos de mensagens instantâneas, conferência, VoIP ou vídeo por IP e integração de telefonia. Ele também pode ser usado para rastrear a presença dos contatos do usuário e de outros dados específicos a aplicativos, devido ao suporte de plataforma de uma estrutura geral de publicação e assinatura.
  • Um aplicativo orientado a recursos que interopera com o e oferece mais funcionalidades ou serviços personalizados. Esse tipo de aplicativo permite que um provedor de serviços tire proveito de uma base de instalação do existente em uma empresa. No entanto, esses aplicativos devem ter o cuidado de evitar a publicação dos dados e a criação ou aceitação de sessões de uma forma que interfira no .
  • Um aplicativo LOB (linha de negócios) integrado que incorpora os recursos de presença e comunicação nos aplicativos LOB existentes. Por exemplo, um aplicativo CRM (gerenciamento de relacionamento com o cliente) pode integrar o rastreamento de presença para decidir como as solicitações personalizadas serão expedidas para os representantes de serviço mais adequados.

Um desenvolvedor pode usar o API para criar um aplicativo que permita a comunicação integrada multimodal em tempo real dentro e fora dos limites da rede. O aplicativo resultante pode ajudar a tornar o computador o centro da comunicação comercial em tempo real. As chamadas de áudio e vídeo, bem como as mensagens instantâneas e a colaboração, são integradas em uma única sessão de usuário no computador. Além das sessões de comunicação de um computador para outro, o usuário também pode criar chamadas de um computador para um telefone, chamadas de um telefone para outro ou sessões de mensagens instantâneas somente texto.

As informações de presença permitem que um usuário saiba a disponibilidade dos seus contatos em tempo real, com a ajuda de um servidor registrador. Um usuário pode, portanto, utilizar esse aplicativo para chamar os contatos sem precisar descobrir o local exato de um contato ou escolher o número de telefone certo a ser chamado. Por exemplo, se você discar para um contato em seu local de trabalho e as informações de presença indicarem que ele está disponível em um computador doméstico, a chamada poderá ser redirecionada automaticamente para esse local. Um usuário também pode manter a privacidade impedindo que os chamadores acessem suas informações de presença.

Um exemplo dessa comunicação em tempo real dos aplicativos de negócios é uma experiência de comunicação personalizada dos usuários desses aplicativos; por exemplo, um aplicativo CRM que reúna todas as partes interessadas em uma oportunidade de vendas em uma videoconferência e compartilhe os dados sobre o cliente.

Os serviços de mensagens instantâneas são atualmente usados pela rede Microsoft MSN® de serviços de Internet, pelo Yahoo! e pela AOL, com milhões de usuários no mundo inteiro.

Microsoft Unified Communications AJAX 2007 SDK

O Microsoft® () é composto pelos seguintes componentes:

  • O é uma interface de programação de aplicativos para . A API é composta por métodos e eventos. Um cliente envia um método como uma solicitação a um servidor e o cliente recebe os dados como eventos do servidor. As solicitações e os eventos são especificados como um elemento XML. A comunicação é conduzida basicamente como solicitações HTTP POST com solicitações HTTP GET em cenários individuais. De forma diferente dos aplicativos projetados como Serviços Web, o Server não analisará as mensagens SOAP nem fornecerá um documento WSDL para consumo das ferramentas de desenvolvimento de aplicativos cliente. Essa abordagem oferece duas vantagens. A primeira e mais importante é que ela evita a sobrecarga criada quando o código JavaScript precisa gerar ou analisar documentos SOAP maiores. A segunda é que um conhecimento geral de XML, em vez de um conhecimento específico sobre mensagens SOAP, é suficiente para obter êxito com o .
  • Unified Communications JavaScript Libraries com base no serviço AJAX. São classes JavaScript que encapsulam a funcionalidade mais utilizada e necessária de um cliente Unified Communications JavaScript Libraries. A funcionalidade comum inclui a criação e a manutenção dos canais de comunicação, a entrada em um servidor, a incorporação da exibição da presença de um usuário em uma página da Web, o início de uma conversa por mensagem instantânea etc. Com as bibliotecas, um desenvolvedor de aplicativos pode criar um cliente Unified Communications JavaScript Libraries simplesmente instanciando as bibliotecas, definindo as propriedades adequadas e chamando os métodos desejados.

O Server fornece acesso à funcionalidade de Comunicação Unificada.

Office Live Meeting Service API

O Microsoft () oferece acesso programático à maioria das funcionalidades disponíveis nos clientes Office Live Meeting baseados no Windows e na Web.

A documentação do é composta por duas partes:

  • Um guia geral para apresentar aos novos programadores os conceitos do Live Meeting e a API (interface de programação de aplicativo) com exemplos e tutoriais.
  • Uma referência de API detalhada, incluindo informações sobre as mensagens com suporte público, os elementos XML constituintes, os códigos de erro e outras informações técnicas.

A documentação de API destina-se a engenheiros, desenvolvedores e programadores que criam, implementam e testam soluções de Webconferência baseadas na tecnologia do Live Meeting. Você deve ter conhecimentos básicos de HTTP e XML.

Um desenvolvedor pode usar os serviços do Live Meeting para gerenciar reuniões online. As tarefas incluem o agendamento de uma reunião; o convite para que outras pessoas ingressem na reunião; a inclusão de uma conta de usuário em um centro de conferências do Live Meeting; o carregamento de apresentações e outros recursos; o gerenciamento de registros, preferências de usuário e de um catálogo de endereços; a geração de relatórios sobre a presença em reuniões e outras estatísticas. Muitas dessas tarefas podem ser executadas de modo programático.

Os serviços do Live Meeting podem ser acessados por meio da interface de usuário da Web do Live Meeting ou do processador de API. Um usuário pode utilizar a interface de usuário da Web para realizar todas as atividades relacionadas a reuniões. O processador de API do serviço Live Meeting atua como gateway de acesso programático aos serviços Live Meeting e é utilizado para o gerenciamento de usuários, recursos e reuniões.

Office Live Meeting Service Portal API

O Microsoft () complementa o Service Pack 2.

O (o Portal) é um aplicativo Web dos Serviços de Informações da Internet (IIS) da Microsoft que usa o ASP.NET. O Portal é instalado em um servidor Web do Microsoft Windows®. O Portal se comunica com o serviço Live Meeting através das chamadas à API XML enviadas pela Internet.

Os usuários podem acessar as páginas do Portal nos navegadores da Web para:

  • Criar uma nova conta do Live Meeting.
  • Entrar no serviço Live Meeting.
  • Alterar a senha da conta do Live Meeting.
  • Permitir que os usuários acessem o conteúdo otimizado relacionado ao Live Meeting.

Os programas ou scripts que chamam os métodos Web do Portal podem automatizar o gerenciamento de conta do Live Meeting. Use os métodos Web para:

  • Criar ou excluir uma conta do Live Meeting.
  • Ativar ou desativar uma conta do Live Meeting.
  • Alterar a senha de uma conta do Live Meeting.
  • Obter o status de uma conta do Live Meeting.