SetImGroup 操作

[アーティクル]
03/29/2023

SetImGroup EWS 操作に関する情報を検索します。

SetImGroup 操作は、インスタントメッセージング (IM) グループの表示名を変更します。

この操作は Exchange Server 2013 で導入されました。

SetImGroup 操作の使用

SetImGroup 操作は、1 つの表示名引数のみを受け取ります。

SetImGroup 操作 SOAP ヘッダー

SetImGroup 操作では、次の表に示す SOAP ヘッダーを使用できます。

ヘッダー名	要素	説明
偽装	ExchangeImpersonation	クライアントアプリケーションが偽装しているユーザーを識別します。このヘッダーは要求に適用されます。
MailboxCulture	MailboxCulture	RFC 3066 で定義されている "言語の識別用タグ" で定義されているカルチャを識別し、メールボックスにアクセスするために使用します。このヘッダーは要求に適用されます。
RequestVersion	RequestServerVersion	操作要求のスキーマバージョンを識別します。このヘッダーは要求に適用されます。
ServerVersion	ServerVersionInfo	要求に応答したサーバーのバージョンを識別します。このヘッダーは、応答に適用できます。

SetImGroup 操作要求の例

次の SetImGroup 操作要求の例は、IM グループの表示名を "MyNewGroupName" に変更する方法を示しています。

注:

Exchange ストア識別子は、読みやすさを維持するために短縮されました。

<?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:SetImGroup>
         <m:GroupId Id="AAMkAGQ1MjJjMTBkQoTbWAAAAAAQRAAA="
                    ChangeKey="EgAAAA=="/>
         <m:NewDisplayName>MyNewGroupName</m:NewDisplayName>
      </m:SetImGroup>
   </soap:Body>
</soap:Envelope>

要求 SOAP 本文には、次の要素が含まれています。

SetImGroup 操作の応答に成功しました

次の例は、 SetImGroup 操作要求に対する正常な応答を示しています。

<?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="349" 
                           MinorBuildNumber="0" 
                           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">
      <SetImGroupResponse ResponseClass="Success" 
                          xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
         <ResponseCode>NoError</ResponseCode>
         </SetImGroupResponse>
      </s:Body>
</s:Envelope>

応答 SOAP 本文には、次の要素が含まれています。

SetImGroup 操作エラー応答

次の例は、 SetImGroup 操作要求に対するエラー応答を示しています。グループ表示名を既存のグループ表示名に変更しようとすると、次のエラー応答が発生します。

<?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="349"
                           MinorBuildNumber="0"
                           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">
      <SetImGroupResponse ResponseClass="Error" 
                          xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
         <MessageText>An IM group with the specified display name already exists.</MessageText>
         <ResponseCode>ErrorImGroupDisplayNameAlreadyExists</ResponseCode>
         <DescriptiveLinkKey>0</DescriptiveLinkKey>
      </SetImGroupResponse>
   </s:Body>
</s:Envelope>

エラー応答 SOAP 本文には、次の要素が含まれています。

EWS に汎用であり、この操作に固有のその他のエラーコードについては、「 ResponseCode」を参照してください。