Операция GetImItemList
Сведения об операции GetImItemList EWS.
Использование операции GetImItemList
Операция GetImItemList извлекает список групп обмена мгновенными сообщениями и контактных лиц обмена мгновенными сообщениями в почтовом ящике. Операция GetImItemList не принимает никаких аргументов.
Эта операция появилась в Exchange Server 2013.
Заготчики операции GetImItemList
В операции GetImItemList можно использовать заглавные таблицы SOAP, перечисленные в следующей таблице.
Имя заголовка | Элемент | Описание |
---|---|---|
Олицетворение |
ExchangeImpersonation |
Определяет пользователя, которого клиентская заявка выдвигает. Этот заглавный заглавник применим к запросу. |
MailboxCulture |
MailboxCulture |
Определяет культуру, определяемую в RFC 3066 , "Теги для идентификации языков", которая будет использоваться для доступа к почтовому ящику. Этот заглавный заглавник применим к запросу. |
RequestVersion |
RequestServerVersion |
Определяет версию схемы для запроса на операцию. Этот заглавный заглавник применим к запросу. |
ServerVersion |
ServerVersionInfo |
Определяет версию сервера, отвечаемого на запрос. Этот заглавный заглавник применим к ответу. |
Пример запроса на операцию GetImItemList: Запрос списка элементов im
В следующем примере запроса на операцию GetImItemList показано, как запрашивать список групп мгновенных сообщений и контактных лиц в почтовом ящике. Элемент GetImItemList является единственным элементом в теле SOAP.
<?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:GetImItemList/>
</soap:Body>
</soap:Envelope>
Тело SOAP запроса содержит следующий элемент:
Успешный ответ на операцию GetImItemList
В следующем примере показан успешный ответ на запрос на операцию GetImItemList. Ответ содержит четыре группы чата. Три группы чата — Другие контакты, теги и избранное — являются группами по умолчанию в Exchange магазине. Группа MyCustomGroup2 — это настраиваемая группа, созданная пользователем. Другие группы "Контакты" и "Теги" не имеют участников. В группе Избранное имеется один контактный член. MyCustomGroup2 имеет два контакта с членами. Идентификаторы элементов предоставляются таким образом, чтобы можно было выполнять последующие запросы GetItem, чтобы получить дополнительные сведения о контактах чата.
В этом примере возвращаются два человека. Первый человек представляет два контактных пункта: Энтони Смит и Тони Смит. Комбинированная контактная информация возвращается в объекте Persona. Второй человек представляет один контакт с отображаемой именем Теренса Адамса.
Примечание
Для сохранения читаемости были сокращены идентификаторы Exchange, идентификаторы элементов, исходные идентификаторы, идентификаторы папок и идентификаторы persona.
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="15"
MinorVersion="0"
MajorBuildNumber="349"
MinorBuildNumber="0"
Version="Exchange2013"
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"
xmlns:h="https://schemas.microsoft.com/exchange/services/2006/types" />
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetImItemListResponse 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>Other Contacts</DisplayName>
<GroupType>IPM.DistList.MOC.OtherContacts</GroupType>
<ExchangeStoreId Id="AAMkAGQ1MjJjMTBkLThQoTbWAAAAAAQUAAA="
ChangeKey="EgAAAA==" />
</ImGroup>
<ImGroup>
<DisplayName>Tagged</DisplayName>
<GroupType>IPM.DistList.MOC.Tagged</GroupType>
<ExchangeStoreId Id="AAMkAGQ1MjJAAQTAAA="
ChangeKey="EgAAAA==" />
</ImGroup>
<ImGroup>
<DisplayName>Favorites</DisplayName>
<GroupType>IPM.DistList.MOC.Favorites</GroupType>
<ExchangeStoreId Id="AAMkAGQ1MjJjMTAAAAAQSAAA="
ChangeKey="EgAAAA==" />
<MemberCorrelationKey>
<ItemId Id="AAMkAGQ1MjJtt/bhQoTbWAAAAAAvcAAA="
ChangeKey="EQAAAA==" />
</MemberCorrelationKey>
</ImGroup>
<ImGroup>
<DisplayName>MyCustomGroup2</DisplayName>
<GroupType>IPM.DistList.MOC.UserGroup</GroupType>
<ExchangeStoreId Id="AAMkAGQ1MjJjKAAA="
ChangeKey="EgAAAA==" />
<MemberCorrelationKey>
<ItemId Id="AAMkAGQ1Matt/bhQoTbWAAAAAAvcAAA="
ChangeKey="EQAAAA==" />
<ItemId Id="AAMkAGQ1MjJjMTBkTbWAAAAAAveAAA="
ChangeKey="EQAAAA==" />
</MemberCorrelationKey>
</ImGroup>
</Groups>
<Personas xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
<Persona>
<PersonaId Id="AAQkAGQ1MjJjMTBkLTc4YkZmRkYQAQAFgxE1nBcqRGgYWWorM9/+s=" />
<PersonaType>Person</PersonaType>
<CreationTime>2012-01-12T22:14:36Z</CreationTime>
<DisplayName>Anthony Smith</DisplayName>
<DisplayNameFirstLast>Anthony Smith</DisplayNameFirstLast>
<DisplayNameLastFirst>Smith Anthony</DisplayNameLastFirst>
<FileAs>Smith, Anthony</FileAs>
<FileAsId>LastCommaFirst</FileAsId>
<GivenName>Anthony</GivenName>
<Surname>Smith</Surname>
<EmailAddress>
<Name>tsmith@contoso.com</Name>
<EmailAddress>tsmith@contoso.com</EmailAddress>
<RoutingType>SMTP</RoutingType>
</EmailAddress>
<EmailAddresses>
<EmailAddress>
<Name>tsmith@contoso.com</Name>
<EmailAddress>tsmith@contoso.com</EmailAddress>
<RoutingType>SMTP</RoutingType>
</EmailAddress>
</EmailAddresses>
<ImAddress>tsmith@contoso.com</ImAddress>
<RelevanceScore>2147483647</RelevanceScore>
<Attributions>
<Attribution>
<Id>0</Id>
<SourceId Id="AQMkAGQ1MjIAYzEwZC03OGNlLTQ5Bq239uFChNtYAAAIvDAAAAA=="
ChangeKey="EQAAABYAAABtF8oI7iVOQatt/bhQoTbWAAAAADB3" />
<DisplayName>Outlook</DisplayName>
<IsWritable>true</IsWritable>
<IsQuickContact>false</IsQuickContact>
<IsHidden>false</IsHidden>
<FolderId Id="AQMkAGQ1MjIAYzEMikE3AQBtF8oI7iVOQatt/bhQoTbWAAADEAAAAA=="
ChangeKey="AQAAAA==" />
</Attribution>
<Attribution>
<Id>1</Id>
<SourceId Id="AAMkAGQ1MjJjMTBkLTc4Y2UtNDA5Ny04/bhQoTbWAAAAAAveAAA="
ChangeKey="EQAAABYAAABtF8oI7iVOQatt/bhQoTbWAAAAAAym" />
<DisplayName>Outlook</DisplayName>
<IsWritable>true</IsWritable>
<IsQuickContact>true</IsQuickContact>
<IsHidden>false</IsHidden>
<FolderId Id="AAMkAGQ1MjJjMTBkLTc4Y2UtNDA5Qatt/bhQoTbWAAAAAAvZAAA="
ChangeKey="AQAAAA==" />
</Attribution>
</Attributions>
<DisplayNames>
<StringAttributedValue>
<Value>Anthony Smith</Value>
<Attributions>
<Attribution>0</Attribution>
</Attributions>
</StringAttributedValue>
<StringAttributedValue>
<Value>Tony Smith</Value>
<Attributions>
<Attribution>1</Attribution>
</Attributions>
</StringAttributedValue>
</DisplayNames>
<FileAses>
<StringAttributedValue>
<Value>Smith, Anthony</Value>
<Attributions>
<Attribution>0</Attribution>
</Attributions>
</StringAttributedValue>
</FileAses>
<FileAsIds>
<StringAttributedValue>
<Value>LastCommaFirst</Value>
<Attributions>
<Attribution>0</Attribution>
</Attributions>
</StringAttributedValue>
<StringAttributedValue>
<Value>None</Value>
<Attributions>
<Attribution>1</Attribution>
</Attributions>
</StringAttributedValue>
</FileAsIds>
<GivenNames>
<StringAttributedValue>
<Value>Anthony</Value>
<Attributions>
<Attribution>0</Attribution>
</Attributions>
</StringAttributedValue>
</GivenNames>
<Surnames>
<StringAttributedValue>
<Value>Smith</Value>
<Attributions>
<Attribution>0</Attribution>
</Attributions>
</StringAttributedValue>
</Surnames>
<HomePhones>
<PhoneNumberAttributedValue>
<Value>
<Number>4255550110</Number>
<Type>Home</Type>
</Value>
<Attributions>
<Attribution>0</Attribution>
</Attributions>
</PhoneNumberAttributedValue>
</HomePhones>
<MobilePhones>
<PhoneNumberAttributedValue>
<Value>
<Number>4255550120</Number>
<Type>Mobile</Type>
</Value>
<Attributions>
<Attribution>0</Attribution>
</Attributions>
</PhoneNumberAttributedValue>
</MobilePhones>
<Emails1>
<EmailAddressAttributedValue>
<Value>
<Name>tsmith@contoso.com</Name>
<EmailAddress>tsmith@contoso.com</EmailAddress>
<RoutingType>SMTP</RoutingType>
</Value>
<Attributions>
<Attribution>0</Attribution>
<Attribution>1</Attribution>
</Attributions>
</EmailAddressAttributedValue>
</Emails1>
<ImAddresses>
<StringAttributedValue>
<Value>tsmith@contoso.com</Value>
<Attributions>
<Attribution>1</Attribution>
</Attributions>
</StringAttributedValue>
</ImAddresses>
</Persona>
<Persona>
<PersonaId Id="AAQkAGQ1MjJjMTBkLkYQAQAJ3EkhEEXN5KufGbSYJanZk=" />
<PersonaType>Person</PersonaType>
<CreationTime>2012-01-05T23:06:58Z</CreationTime>
<DisplayName>Terence Adams</DisplayName>
<DisplayNameFirstLast>Terence Adams</DisplayNameFirstLast>
<DisplayNameLastFirst>Terence Adams</DisplayNameLastFirst>
<FileAsId>None</FileAsId>
<EmailAddress>
<Name>Terence Adams</Name>
<EmailAddress>tadams@contoso.com</EmailAddress>
<RoutingType>SMTP</RoutingType>
</EmailAddress>
<EmailAddresses>
<EmailAddress>
<Name>Terence Adams</Name>
<EmailAddress>tadams@contoso.com</EmailAddress>
<RoutingType>SMTP</RoutingType>
</EmailAddress>
</EmailAddresses>
<ImAddress>tadams@contoso.com</ImAddress>
<RelevanceScore>2147483647</RelevanceScore>
<Attributions>
<Attribution>
<Id>0</Id>
<SourceId Id="AAMkAGQ1MjVOQatt/bhQoTbWAAAA7iVOQatt/bhQoTbWAAAAAAvcAAA="
ChangeKey="EQAAABYAAABtF8oI7iVOQatt/bhQoTbWAAAAAAyg" />
<DisplayName>Outlook</DisplayName>
<IsWritable>true</IsWritable>
<IsQuickContact>true</IsQuickContact>
<IsHidden>false</IsHidden>
<FolderId Id="AAMkAGQ1MjJjMTBkLTc4Y2rBtF8oI7iVOQatt/bhQoTbWAAAAAAvZAAA="
ChangeKey="AQAAAA==" />
</Attribution>
</Attributions>
<DisplayNames>
<StringAttributedValue>
<Value>Terence Adams</Value>
<Attributions>
<Attribution>0</Attribution>
</Attributions>
</StringAttributedValue>
</DisplayNames>
<FileAsIds>
<StringAttributedValue>
<Value>None</Value>
<Attributions>
<Attribution>0</Attribution>
</Attributions>
</StringAttributedValue>
</FileAsIds>
<Emails1>
<EmailAddressAttributedValue>
<Value>
<Name>Terence Adams</Name>
<EmailAddress>tadams@contoso.com</EmailAddress>
<RoutingType>SMTP</RoutingType>
</Value>
<Attributions>
<Attribution>0</Attribution>
</Attributions>
</EmailAddressAttributedValue>
</Emails1>
<ImAddresses>
<StringAttributedValue>
<Value>tadams@contoso.com</Value>
<Attributions>
<Attribution>0</Attribution>
</Attributions>
</StringAttributedValue>
</ImAddresses>
</Persona>
</Personas>
</ImItemList>
</GetImItemListResponse>
</s:Body>
</s:Envelope>
Тело SOAP ответа содержит следующие элементы:
Ответ на ошибку операции GetImItemList
В следующем примере показан ответ на ошибку запроса на операцию GetImItemList. Это ответ на запрос, содержащий неправильную запрашиваемую версию сервера в загонах SOAP. Этот ответ на ошибку является ошибкой SOAP и не представлен в схеме EWS.
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<s:Fault>
<faultcode xmlns:a="https://schemas.microsoft.com/exchange/services/2006/types">a:ErrorIncorrectSchemaVersion</faultcode>
<faultstring xml:lang="en-US">The request is valid but does not specify the correct server version in the RequestServerVersion SOAP header. Ensure that the RequestServerVersion SOAP header is set with the correct RequestServerVersionValue.</faultstring>
<detail>
<e:ResponseCode xmlns:e="https://schemas.microsoft.com/exchange/services/2006/errors">ErrorIncorrectSchemaVersion</e:ResponseCode>
<e:Message xmlns:e="https://schemas.microsoft.com/exchange/services/2006/errors">The request is valid but does not specify the correct server version in the RequestServerVersion SOAP header. Ensure that the RequestServerVersion SOAP header is set with the correct RequestServerVersionValue.</e:Message>
</detail>
</s:Fault>
</s:Body>
</s:Envelope>