GrooveMessages Web Service

Article
01/20/2015

Applies to: SharePoint Workspace 2010 | Visual Studio 2008

The GrooveMessages service provides access to Groove instant messages and workspace invitations. It provides methods to send and receive messages and defines a set of events that enable your Web services application to monitor when a message has been sent, received, opened, and deleted.

XML Definitions

WSDL

GrooveMessages.wsdl 2.0

with references to:

Core.xsd 2.0
Events.xsd 2.0
Messages.xsd 2.0

SOAP Operation Namespace

http://webservices.groove.net/Groove/2.0/Messages/

HTTP Post URL

http://localhost:port-number/GWS/Groove/2.0/Messages/service-specific-data

Operations, Complex Types, and Events

The following sections describe the GrooveMessages operations, complex types, and events.

Operations

Operation	Description
AcceptInvitation	Accepts the targeted invitation.
ConfirmInvitation	Confirms the targeted invitation response, which enables the user who accepted the invitation to become a member of the workspace.
Create	Creates and sends a Groove instant message.
CreateForward	Creates and forwards a specified instant message to a new set of recipients.
CreateReply	Creates and sends a reply to a specified instant message. The reply may be sent to the original sender or to all recipients. Original content may be included in the message.
DeclineInvitation	Declines the targeted invitation to become a member of a workspace.
Delete	Deletes a specified message from the message store for the account.
DenyInvitation	Denies the targeted invitation response, which prevents the user who accepted the invitation from becoming a member of the workspace.
Read	Returns a list of messages from the message store for the account. The list can be restricted to a particular category of messages. Optionally, returned messages may include content and attachments.
ReadInvitations	Reads the invitation and invitation response messages.
ReadMessage	Returns an individual message from the message store for the account.

Complex Types

Complex type	Description
AttachmentType	Enumeration type used to distinguish a voice memo attachment and other file attachments. Values are Voice, File and Unknown.
Invitation	Message that contains a Groove 2007-compatible workspace invitation or an invitation response.
InvitationMessageState	Enumeration type used to distinguish a new invitation message from a saved invitation message that has already been read. Values are New and Saved.
InvitationMessageType	Enumeration type used to distinguish an invitation message from an invitation response message. For invitation response messages, it provides information about what the user's response was. Values are InvitationReceived, InvitationAccepted, InvitationDeclined, and ConfirmationRequired.
Message	An instant message, including heading, body and attachments.
MessageAttachment	A message attachment. Can be identified by reference using a URI or embedded using Base64 encoding.
MessageCategory	Enumeration type used to classify messages in the message store. Values are New, Opened, Sent, Inbox, All and Unknown.
MessageContact	Identifies senders and recipients in messaging operations. MessageContact contains a URI and a name.
MessageContent	Contains the body of the message.
MessageHeader	Contains the message header, which includes: message URI, sender, and recipients.

Events

Event class URN	Event	Description
urn:groove-net:Messages2Event2	InvitationReceivedEventData	Indicates that an invitation to a workspace was received and was stored in the message store for the account.
	InvitationResponseReceivedEventData	Indicates that a response to an invitation was received and was stored in the message store for the account.
urn:groove-net:Messages2Event	MessageDeletedEventData	Indicates that a message was removed from the message store for the account.
	MessageOpenedEventData	Indicates that the category of an incoming message changed from New to Opened.
	MessageReceivedEventData	Indicates that an incoming message was received and was stored in the message store for the account.
	MessageSentEventData	Indicates that an outgoing message was sent from the account.

Remarks

The GrooveMessages service interacts with the message store for the account—a holding area that contains the instant messages for all identities of the account. This message store is the same one that is used by the Groove UI, so changes made via Web service calls are visible in the UI and vice versa.

Messages can consist of a plain text body, zero or more file attachments and an optional voice memo attachment. They may be sent to one or more contacts.

Messages sent via the GrooveMessages service behave as if they were sent from an identity. Messages received by the account and stored in the message store for the account can be read via the service. The message store contains messages for all identities of an account. Messages in the message store are classified by category. You can query messages based on their categories.

You can use the GrooveMessages events to monitor message activity.

Message size, including attachments and voice memo, is limited to 25 megabytes.

Although messages belong to a Groove account rather than a Groove identity, you must specify an Identity URL and not an Account URL in the GrooveRequestHeader in calls to the GrooveMessages service. For accounts that have more than one identity, you can specify any Identity URL from the account in the GrooveRequestHeader.