Операция GetImItemsGetImItems operation

Поиск сведений о GetImItemsной операции EWS.Find information about the GetImItems EWS operation.

Операция GetImItems получает сведения о группах обмена мгновенными сообщениями и пользователях контактов для обмена мгновенными сообщениями.The GetImItems operation retrieves information about instant messaging (IM) groups and IM contact personas.

Эта операция появилась в Exchange Server 2013.This operation was introduced in Exchange Server 2013.

Использование операции GetImItemsUsing the GetImItems operation

Операция GetImItems принимает идентификаторы элементов Group и Contact и возвращает набор сведений о группах и контактах.The GetImItems operation accepts group and contact item identifiers and returns a set of information about the groups and contacts. Наборы свойств, возвращаемые в ответе, идентифицируются с помощью расширенных свойств, нескольких идентификаторов контакта, идентификаторов групп и определений расширенных свойств в качестве аргументов.The property sets returned in the response are identified by extended properties, multiple contact identifiers, group identifiers, and extended property definitions as arguments.

Заголовки SOAP операции GetImItemsGetImItems operation SOAP headers

Операция GetImItems может использовать заголовки SOAP, указанные в приведенной ниже таблице.The GetImItems operation can use the SOAP headers that are listed in the following table.

Имя заголовкаHeader name ЭлементElement ОписаниеDescription
ОлицетворениеImpersonation
ексчанжеимперсонатионExchangeImpersonation
Идентифицирует пользователя, который олицетворяет клиентское приложение.Identifies the user whom the client application is impersonating. Этот заголовок является применимым для запроса.This header is applicable to a request.
маилбокскултуреMailboxCulture
маилбокскултуреMailboxCulture
Определяет язык и региональные параметры, определенные в документе RFC 3066 "Теги для идентификации языков", которые будут использоваться для доступа к почтовому ящику.Identifies the culture, as defined in RFC 3066, "Tags for the Identification of Languages", to be used to access the mailbox. Этот заголовок является применимым для запроса.This header is applicable to a request.
рекуестверсионRequestVersion
рекуестсерверверсионRequestServerVersion
Определяет версию схемы для запроса операции.Identifies the schema version for the operation request. Этот заголовок является применимым для запроса.This header is applicable to a request.
серверверсионServerVersion
серверверсионинфоServerVersionInfo
Определяет версию сервера, который ответил на запрос.Identifies the version of the server that responded to the request. Этот заголовок является применимым для отклика.This header is applicable to a response.

Пример запроса операции GetImItems: получение подробных сведений о контактах и группах для обмена мгновенными сообщениямиGetImItems operation request example: Get detailed information about IM contacts and groups

В следующем примере запроса операции GetImItems показано, как запросить подробные сведения о контактах и группах для обмена мгновенными сообщениями.The following example of a GetImItems operation request shows how to request detailed information about IM contacts and groups. Операция GetImItems может запросить один или несколько сведений о контакте или группе.A GetImItems operation can request one or more contact or group details. Вы также можете использовать расширенные свойства для получения настраиваемых свойств для групп и контактов.You can also use extended properties to get custom properties on groups and contacts. Если запрошенное расширенное свойство не существует для элемента, то ответ будет игнорировать запрошенное свойство и возвращать ответ для набора свойств по умолчанию.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. В этом примере показано, как получить отображаемое имя с помощью расширенных свойств.This example shows you how to get the display name by using extended properties.

Примечание

Все идентификаторы элементов и изменения ключей в этой статье были сокращены, чтобы сохранить удобочитаемость.All item identifiers and change keys in this article have been shortened to preserve readability. Обратите внимание, что для этой операции в службе игнорируются ключи изменений.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>

Текст SOAP Request содержит следующие элементы:The request SOAP body contains the following elements:

Успешный отклик операции GetImItemsSuccessful GetImItems operation response

В следующем примере показан успешный ответ на запрос GetImItems для получения контакта и группы для обмена мгновенными сообщениями.The following example shows a successful response to a GetImItems request to get an IM contact and group. Отображаемое имя запрашивается в расширенном свойстве.The display name is requested in an extended property. Контакты для обмена мгновенными сообщениями возвращаются в виде пользователя.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>

Тело SOAP отклика содержит следующие элементы:The response SOAP body contains the following elements:

Ответ об ошибке операции GetImItemsGetImItems operation error response

Операция GetImItems не проверяет идентификаторы и не возвращает ожидаемый ответ об ошибке ерроринвалидимконтактид или ерроринвалидимграупид , если службе предоставлен недопустимый идентификатор контакта или группы.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.

См. такжеSee also