Operación GetImItemsGetImItems operation

Buscar información sobre la operación de EWS de GetImItems .Find information about the GetImItems EWS operation.

La operación GetImItems recupera información sobre los grupos de mensajería instantánea (mi) y los roles de contactos de mensajería instantánea.The GetImItems operation retrieves information about instant messaging (IM) groups and IM contact personas.

Esta operación se introdujo en Exchange Server 2013.This operation was introduced in Exchange Server 2013.

Uso de la operación GetImItemsUsing the GetImItems operation

La operación GetImItems acepta los identificadores de elemento de contacto y grupo y devuelve un conjunto de información acerca de los grupos y los contactos.The GetImItems operation accepts group and contact item identifiers and returns a set of information about the groups and contacts. Los conjuntos de propiedades devueltos en la respuesta se identifican por las propiedades extendidas, los identificadores de contacto múltiples, los identificadores de grupo y las definiciones de propiedades extendidas 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.

Encabezados SOAP de operación GetImItemsGetImItems operation SOAP headers

La operación GetImItems puede usar los encabezados SOAP que se enumeran en la tabla siguiente.The GetImItems operation can use the SOAP headers that are listed in the following table.

Nombre de encabezadoHeader name ElementoElement DescripciónDescription
SuplantaciónImpersonation
ExchangeImpersonationExchangeImpersonation
Identifica al usuario que está suplantando la aplicación cliente.Identifies the user whom the client application is impersonating. Este encabezado se aplica a una solicitud.This header is applicable to a request.
MailboxCultureMailboxCulture
MailboxCultureMailboxCulture
Identifica la referencia cultural, tal y como se define en RFC 3066, "etiquetas para la identificación de idiomas", que se va a usar para obtener acceso al buzón.Identifies the culture, as defined in RFC 3066, "Tags for the Identification of Languages", to be used to access the mailbox. Este encabezado se aplica a una solicitud.This header is applicable to a request.
RequestVersionRequestVersion
RequestServerVersionRequestServerVersion
Identifica la versión del esquema para la solicitud de operación.Identifies the schema version for the operation request. Este encabezado se aplica a una solicitud.This header is applicable to a request.
ServerVersionServerVersion
ServerVersionInfoServerVersionInfo
Identifica la versión del servidor que respondió a la solicitud.Identifies the version of the server that responded to the request. Este encabezado se aplica a una respuesta.This header is applicable to a response.

Ejemplo de solicitud de operación GetImItems: obtener información detallada sobre los grupos y contactos de mensajería instantáneaGetImItems operation request example: Get detailed information about IM contacts and groups

El siguiente ejemplo de una solicitud de operación de GetImItems muestra cómo solicitar información detallada sobre los grupos y los contactos de mensajería instantánea.The following example of a GetImItems operation request shows how to request detailed information about IM contacts and groups. Una operación de GetImItems puede solicitar uno o más detalles de contacto o de grupo.A GetImItems operation can request one or more contact or group details. También puede usar las propiedades extendidas para obtener propiedades personalizadas en grupos y contactos.You can also use extended properties to get custom properties on groups and contacts. Si una propiedad extendida solicitada no existe en un elemento, la respuesta omitirá la propiedad solicitada y devolverá la respuesta para el conjunto de propiedades predeterminado.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. En este ejemplo se muestra cómo obtener el nombre para mostrar mediante las propiedades extendidas.This example shows you how to get the display name by using extended properties.

Nota

Todos los identificadores de elemento y las claves de cambio de este artículo se han reducido para preservar la legibilidad.All item identifiers and change keys in this article have been shortened to preserve readability. Tenga en cuenta que el servicio ignora las claves de cambio para esta operación.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>

El cuerpo SOAP de la solicitud contiene los siguientes elementos:The request SOAP body contains the following elements:

Respuesta de operación GetImItems correctaSuccessful GetImItems operation response

En el ejemplo siguiente se muestra una respuesta correcta a una solicitud de GetImItems para obtener un contacto y un grupo de mensajería instantánea.The following example shows a successful response to a GetImItems request to get an IM contact and group. El nombre para mostrar se solicita en una propiedad extendida.The display name is requested in an extended property. Los contactos de mensajería instantánea se devuelven en forma de rol.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>

El cuerpo SOAP de respuesta contiene los siguientes elementos:The response SOAP body contains the following elements:

Respuesta de error de operación de GetImItemsGetImItems operation error response

La operación GetImItems no valida identificadores y no devolverá la respuesta de error ErrorInvalidImContactId o ErrorInvalidImGroupId esperada si se proporciona al servicio un identificador de contacto o de grupo no válido.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.

Vea tambiénSee also