AddImContactToGroup operation
Published: July 16, 2012
Find information about the AddImContactToGroup EWS operation.
Applies to: Exchange 2013 | Exchange Online
The AddImContactToGroup Exchange Web Services (EWS) operation adds an existing instant messaging (IM) contact to a group.
This operation was introduced in Exchange Server 2013.
The AddImContactToGroup operation can only accept IM contacts. If you want to add a new IM contact to the Unified Contact Store, use the AddNewImContactToGroup operation.
The AddImContactToGroup operation can use the SOAP headers that are listed in the following table.
|
Header name |
Element |
Description |
|---|---|---|
|
Impersonation |
Identifies the user whom the client application is impersonating. This header is applicable to a request. |
|
|
MailboxCulture |
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 |
Identifies the schema version for the operation request. This header is applicable to a request. |
|
|
ServerVersion |
Identifies the version of the server that responded to the request. This header is applicable to a response. |
The following example of an AddImContactToGroup operation request shows how to add an existing IM contact an IM group.
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages">
<soap:Header>
<t:RequestServerVersion Version="Exchange2013" />
<t:MailboxCulture>en-US</t:MailboxCulture>
</soap:Header>
<soap:Body >
<m:AddImContactToGroup>
<m:ContactId Id="AAMkAGQ1MjJjMTBkLTc4Y2AA="
ChangeKey="EQAAABYAAABtF8oI7i"/>
<m:GroupId Id="AAMkAGQ1MjJjMTBkzzAAAQKAAA="
ChangeKey="EgAAAA=="/>
</m:AddImContactToGroup>
</soap:Body>
</soap:Envelope>
The request SOAP body contains the following elements:
The following example shows a successful response to an AddImContactToGroup operation request.
<?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="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns="http://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">
<AddImContactToGroupResponse ResponseClass="Success"
xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<ResponseCode>NoError</ResponseCode>
</AddImContactToGroupResponse>
</s:Body>
</s:Envelope>
The response SOAP body contains the following elements:
The following example shows an error response to an AddImContactToGroup operation request. The following error response occurs when an attempt is made to add a contact that is not an IM contact.
<?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="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns="http://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">
<AddImContactToGroupResponse ResponseClass="Error"
xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<MessageText>The specified Im Contact Id is invalid.</MessageText>
<ResponseCode>ErrorInvalidImContactId</ResponseCode>
<DescriptiveLinkKey>0</DescriptiveLinkKey>
</AddImContactToGroupResponse>
</s:Body>
</s:Envelope>
The error response SOAP body contains the following elements:
