Operação GetImItemsGetImItems operation

Encontre informações sobre a operação do EWS do GetImItems .Find information about the GetImItems EWS operation.

A operação GetImItems recupera informações sobre grupos de mensagens instantâneas (IM) e pessoas de contato de mensagens instantâneas.The GetImItems operation retrieves information about instant messaging (IM) groups and IM contact personas.

This operation was introduced in Exchange Server 2013.This operation was introduced in Exchange Server 2013.

Usando a operação GetImItemsUsing the GetImItems operation

A operação GetImItems aceita identificadores de item de contato e grupo e retorna um conjunto de informações sobre os grupos e contatos.The GetImItems operation accepts group and contact item identifiers and returns a set of information about the groups and contacts. Os conjuntos de propriedades retornados na resposta são identificados por propriedades estendidas, vários identificadores de contato, identificadores de grupo e definições de propriedades estendidas como argumentos.The property sets returned in the response are identified by extended properties, multiple contact identifiers, group identifiers, and extended property definitions as arguments.

Cabeçalhos SOAP de operação GetImItemsGetImItems operation SOAP headers

A operação GetImItems pode usar os cabeçalhos SOAP listados na tabela a seguir.The GetImItems operation can use the SOAP headers that are listed in the following table.

Nome de cabeçalhoHeader name ElementoElement DescriçãoDescription
RepresentaçãoImpersonation
ExchangeImpersonationExchangeImpersonation
Identifica o usuário que o aplicativo cliente está representando.Identifies the user whom the client application is impersonating. Este cabeçalho é aplicável a uma solicitação.This header is applicable to a request.
MailboxCultureMailboxCulture
MailboxCultureMailboxCulture
Identifica a cultura, conforme definido na RFC 3066, "marcas de identificação de idiomas", a ser usado para acessar a caixa de correio.Identifies the culture, as defined in RFC 3066, "Tags for the Identification of Languages", to be used to access the mailbox. Este cabeçalho é aplicável a uma solicitação.This header is applicable to a request.
RequestVersionRequestVersion
RequestServerVersionRequestServerVersion
Identifica a versão do esquema para a solicitação de operação.Identifies the schema version for the operation request. Este cabeçalho é aplicável a uma solicitação.This header is applicable to a request.
ServerVersionServerVersion
ServerVersionInfoServerVersionInfo
Identifica a versão do servidor que respondeu à solicitação.Identifies the version of the server that responded to the request. Este cabeçalho é aplicável a uma resposta.This header is applicable to a response.

Exemplo de solicitação de operação GetImItems: obter informações detalhadas sobre contatos e grupos de mensagens instantâneasGetImItems operation request example: Get detailed information about IM contacts and groups

O exemplo a seguir de uma solicitação de operação do GetImItems mostra como solicitar informações detalhadas sobre contatos e grupos de mensagens instantâneas.The following example of a GetImItems operation request shows how to request detailed information about IM contacts and groups. Uma operação GetImItems pode solicitar um ou mais detalhes de contato ou grupo.A GetImItems operation can request one or more contact or group details. Você também pode usar propriedades estendidas para obter propriedades personalizadas em grupos e contatos.You can also use extended properties to get custom properties on groups and contacts. Se uma propriedade estendida solicitada não existir em um item, a resposta irá ignorar a propriedade solicitada e retornará a resposta para o conjunto de propriedades padrão.If a requested extended property does not exist on an item, the response will ignore the requested property and return the response for the default property set. Este exemplo mostra como obter o nome de exibição usando propriedades estendidas.This example shows you how to get the display name by using extended properties.

Observação

Todos os identificadores de item e as chaves de alteração deste artigo foram reduzidos para preservar a legibilidade.All item identifiers and change keys in this article have been shortened to preserve readability. Observe que as chaves de alteração são ignoradas pelo serviço para esta operação.Note that change keys are ignored by the service for this operation.

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types"
               xmlns:m="https://schemas.microsoft.com/exchange/services/2006/messages">
   <soap:Header>
      <t:RequestServerVersion Version="Exchange2013" />
      <t:MailboxCulture>en-US</t:MailboxCulture>
   </soap:Header>
   <soap:Body >
      <m:GetImItems>
         <m:ContactIds>
            <t:ItemId Id="AAMkADEzOTExYACABmEhpSAAA=" ChangeKey="EQAAABBmNDjF"/>
         </m:ContactIds>
         <m:GroupIds>
            <t:ItemId Id="AAMkADEzOTExYjJkBY7+0EAAA=" ChangeKey="EgAAAA=="/>
         </m:GroupIds>         
         <m:ExtendedProperties>
            <t:ExtendedProperty PropertyTag="0x3001" PropertyType="String"/>
         </m:ExtendedProperties>
      </m:GetImItems>
   </soap:Body>
</soap:Envelope>

O corpo SOAP de solicitação contém os seguintes elementos:The request SOAP body contains the following elements:

Resposta de operação GetImItems bem-sucedidaSuccessful GetImItems operation response

O exemplo a seguir mostra uma resposta bem-sucedida a uma solicitação do GetImItems para obter um contato de mensagens instantâneas e um grupo.The following example shows a successful response to a GetImItems request to get an IM contact and group. O nome para exibição é solicitado em uma propriedade estendida.The display name is requested in an extended property. Os contatos de mensagens instantâneas são retornados no formato de uma pessoa.IM contacts are returned in the form of a persona.

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <h:ServerVersionInfo MajorVersion="15" 
                           MinorVersion="0" 
                           MajorBuildNumber="556" 
                           MinorBuildNumber="8" 
                           Version="Exchange2013" 
                           xmlns:h="https://schemas.microsoft.com/exchange/services/2006/types" 
                           xmlns="https://schemas.microsoft.com/exchange/services/2006/types" 
                           xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
                           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
   </s:Header>
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
           xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <GetImItemsResponse ResponseClass="Success" 
                          xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
         <ResponseCode>NoError</ResponseCode>
         <ImItemList>
            <Groups xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
               <ImGroup>
                  <DisplayName>Exchange SDK Team</DisplayName>
                  <GroupType>IPM.DistList.MOC.UserGroup</GroupType>
                  <ExchangeStoreId Id="AAMkADEzQrAABY7+0EAAA=" ChangeKey="EgAAAA=="/>
                  <MemberCorrelationKey>
                     <ItemId Id="AAMkADEzOTExYjeGgGqm4QrAABmEhpSAAA=" ChangeKey="EQAAAA=="/>
                  </MemberCorrelationKey>
                  <ExtendedProperties>
                     <ExtendedProperty>
                        <ExtendedFieldURI PropertyTag="0x3001" PropertyType="String"/>
                        <Value>Exchange SDK Team</Value>
                     </ExtendedProperty>
                  </ExtendedProperties>
               </ImGroup>
            </Groups>
            <Personas xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
               <Persona>
                  <PersonaId Id="AAQkADEzOTBZImBzN5J/uHXc="/>
                  <PersonaType>Person</PersonaType>
                  <CreationTime>2012-11-07T00:10:35Z</CreationTime>
                  <DisplayName>Tony Smith</DisplayName>
                  <DisplayNameFirstLast>Tony Smith</DisplayNameFirstLast>
                  <DisplayNameLastFirst>Tony Smith</DisplayNameLastFirst>
                  <FileAs/>
                  <FileAsId>None</FileAsId>
                  <ImAddress>tsmith@contoso.com</ImAddress>
                  <RelevanceScore>2147483647</RelevanceScore>
                  <Attributions>
                     <Attribution>
                        <Id>0</Id>
                        <SourceId Id="AAMkADEzhQaoeGgGqm4QrAABmEhpSAAA=" ChangeKey="EQArAABmNDjF"/>
                        <DisplayName>Lync Contacts</DisplayName>
                        <IsWritable>false</IsWritable>
                        <IsQuickContact>true</IsQuickContact>
                        <IsHidden>false</IsHidden>
                     </Attribution>
                  </Attributions>
                  <DisplayNames>
                     <StringAttributedValue>
                        <Value>Tony Smith</Value>
                        <Attributions>
                           <Attribution>0</Attribution>
                        </Attributions>
                     </StringAttributedValue>
                  </DisplayNames>
                  <FileAsIds>
                     <StringAttributedValue>
                        <Value>None</Value>
                        <Attributions>
                           <Attribution>0</Attribution>
                        </Attributions>
                     </StringAttributedValue>
                  </FileAsIds>
                  <ImAddresses>
                     <StringAttributedValue>
                        <Value>tsmith@contoso.com</Value>
                        <Attributions>
                           <Attribution>0</Attribution>
                        </Attributions>
                     </StringAttributedValue>
                  </ImAddresses>
                  <ExtendedProperties>
                     <ExtendedPropertyAttributedValue>
                        <Value>
                           <ExtendedFieldURI PropertyTag="0x3001" PropertyType="String"/>
                           <Value>Tony Smith</Value>
                        </Value>
                        <Attributions>
                           <Attribution>0</Attribution>
                        </Attributions>
                     </ExtendedPropertyAttributedValue>
                  </ExtendedProperties>
               </Persona>
            </Personas>
         </ImItemList>
      </GetImItemsResponse>
   </s:Body>
</s:Envelope>

O corpo SOAP de resposta contém os seguintes elementos:The response SOAP body contains the following elements:

Resposta de erro de operação GetImItemsGetImItems operation error response

A operação GetImItems não valida identificadores e não retornará a resposta de erro ErrorInvalidImContactId ou ErrorInvalidImGroupId esperada se um identificador de contato ou de grupo inválido for fornecido ao serviço.The GetImItems operation does not validate identifiers and will not return the expected ErrorInvalidImContactId or ErrorInvalidImGroupId error response if an invalid contact or group identifier is provided to the service.

Confira tambémSee also