Операция GetImItems

Статья
03/29/2023

Найдите сведения об операции GetImItems EWS.

Операция GetImItems извлекает сведения о группах обмена мгновенными сообщениями (IM) и контактных лицах для обмена мгновенными сообщениями.

Эта операция появилась в Exchange Server 2013.

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

Операция GetImItems принимает идентификаторы групп и элементов контактов и возвращает набор сведений о группах и контактах. Наборы свойств, возвращаемые в ответе, определяются расширенными свойствами, несколькими идентификаторами контактов, идентификаторами групп и расширенными определениями свойств в качестве аргументов.

Заголовки SOAP операции GetImItems

Операция GetImItems может использовать заголовки SOAP, перечисленные в следующей таблице.

Имя заголовка	Элемент	Описание
Олицетворения	ExchangeImpersonation	Определяет пользователя, которого олицетворяет клиентское приложение. Этот заголовок применим к запросу.
MailboxCulture	MailboxCulture	Определяет язык и региональные параметры, определенные в RFC 3066 "Теги для идентификации языков", которые будут использоваться для доступа к почтовому ящику. Этот заголовок применим к запросу.
RequestVersion	RequestServerVersion	Определяет версию схемы для запроса операции. Этот заголовок применим к запросу.
ServerVersion	ServerVersionInfo	Определяет версию сервера, который ответил на запрос. Этот заголовок применим к ответу.

Пример запроса на операцию GetImItems: получение подробных сведений о контактах и группах обмена мгновенными сообщениями

В следующем примере запроса на операцию GetImItems показано, как запросить подробные сведения о контактах и группах обмена мгновенными сообщениями. Операция GetImItems может запрашивать сведения об одном или нескольких контактах или группах. Вы также можете использовать расширенные свойства для получения пользовательских свойств для групп и контактов. Если запрошенное расширенное свойство не существует для элемента, ответ проигнорирует запрошенное свойство и вернет ответ для набора свойств по умолчанию. В этом примере показано, как получить отображаемое имя с помощью расширенных свойств.

Примечание.

Все идентификаторы элементов и ключи изменения в этой статье сокращены для сохранения удобочитаемости. Обратите внимание, что ключи изменения игнорируются службой для этой операции.

<?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 запроса содержит следующие элементы:

Успешный ответ на операцию GetImItems

В следующем примере показан успешный ответ на запрос GetImItems для получения контакта и группы обмена мгновенными сообщениями. Отображаемое имя запрашивается в расширенном свойстве. Контакты для обмена мгновенными сообщениями возвращаются в виде персоны.

<?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 ответа содержит следующие элементы:

Ответ на ошибку операции GetImItems

Операция GetImItems не проверяет идентификаторы и не возвращает ожидаемый ответ об ошибке ErrorInvalidImContactId или ErrorInvalidImGroupId , если службе предоставлен недопустимый идентификатор контакта или группы.