GrooveMessages.Create Operation
The Create operation creates and sends a new instant message. The instant message may include a body, voice memo, and zero or more attachments. Attachments may be embedded directly using Base64 encoding. Alternatively, they can be included by reference, using a URI identifying a file.
HTTP Post URL
The HTTP Post URL targets the service for the account. This URI is returned by the GrooveAccounts.Read2 operation in the Messages element.
Input Message Header
GrooveRequestHeader specifies information common to all Groove Web Services, including the Groove Identity URL and the Groove Request key.
Input Message Parameters
<MessageHeader />
<MessageContent />
| Element | Data type | Description |
|---|---|---|
MessageHeader |
Provides the metadata for the message. |
|
MessageContent |
Provides the content for the message. |
Output Message Header
GrooveResponseHeader specifies the Response key.
Return Value
<CreateResult />
| Element | Data type | Description |
|---|---|---|
CreateResult |
|
A URI which can be used to reference the message. It can be used as the HTTP Post URL to retrieve the message using ReadMessage or to forward or reply to the message using CreateForward or CreateReply. |
Remarks
To send a message to a contact, you specify the Groove Identity URL of the contact in a MessageContact in the Recipients element of the MessageHeader.
You can send messages only to contacts that are accessible to the account. The following kinds of contacts are accessible:
Contacts in the account Contact list.
Members of workspaces that the account belongs to.
Contacts who have been the sender or a recipient of a message in the account message history.
If a call to the Create, CreateForward, or CreateReply operation specifies a recipient that is not accessible to the account, a SOAP fault will be returned and the entire operation will fail. The SOAP exception does not provide any information on which contact caused the operation to fail.
See Also
Reference
GrooveMessages Web Service
GrooveMessages.CreateForward Operation
GrooveMessages.CreateReply Operation