GetImItemList 操作
GetImItemList EWS 操作に関する情報を検索します。
GetImItemList 操作の使用
GetImItemList 操作は、メールボックス内のインスタント メッセージング (IM) グループと IM 連絡先ペルソナの一覧を取得します。 GetImItemList 操作は引数を受け取りません。
この操作は Exchange Server 2013 で導入されました。
GetImItemList 操作 SOAP ヘッダー
GetImItemList 操作では、次の表に示す SOAP ヘッダーを使用できます。
| ヘッダー名 | 要素 | 説明 |
|---|---|---|
| 偽装 |
ExchangeImpersonation |
クライアント アプリケーションが偽装しているユーザーを識別します。 このヘッダーは要求に適用されます。 |
| MailboxCulture |
MailboxCulture |
RFC 3066 で定義されている "言語の識別用タグ" で定義されているカルチャを識別し、メールボックスにアクセスするために使用します。 このヘッダーは要求に適用されます。 |
| RequestVersion |
RequestServerVersion |
操作要求のスキーマ バージョンを識別します。 このヘッダーは要求に適用されます。 |
| ServerVersion |
ServerVersionInfo |
要求に応答したサーバーのバージョンを識別します。 このヘッダーは、応答に適用できます。 |
GetImItemList 操作要求の例: IM アイテムの一覧を要求する
GetImItemList 操作要求の次の例は、メールボックス内の IM グループと IM 連絡先ペルソナの一覧を要求する方法を示しています。 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 操作要求に対する正常な応答を示しています。 応答には、4 つの IM グループが含まれています。 3 つの IM グループ (他の連絡先、タグ付き、お気に入り) は、Exchange ストアの既定のグループです。 MyCustomGroup2 グループは、ユーザーが作成したカスタム グループです。 [その他の連絡先] グループと [タグ付けされたグループ] にはメンバーがありません。 [お気に入り] グループには、連絡先メンバーが 1 人います。 MyCustomGroup2 には、2 つのメンバー連絡先があります。 アイテム識別子は、後続の GetItem 要求を実行して IM 連絡先に関する詳細情報を取得できるように提供されます。
この例では、2 つのペルソナを返します。 最初のペルソナは、アンソニー・スミスとトニー・スミスの 2 つの連絡先アイテムを表します。 結合された連絡先情報は、 Persona オブジェクトで返されます。 2 番目のペルソナは、Terence Adams の表示名を持つ 1 つの連絡先を表します。
注:
Exchange ストア識別子、アイテム識別子、ソース識別子、フォルダー識別子、ペルソナ識別子は、読みやすくするために短縮されました。
<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>
関連項目
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示