Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
maxLevel3
typeflat

...

Overview

The following operations allow you to work with messages. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with messages, see Sample configuration

Operation details

This section provides further details on the operations related to messages.

Anchor
deleteMessage
deleteMessage
Deleting a message

The deleteMessage operation deletes a message.

Code Block
languagexml
titledeleteMessage
<yammer.deleteMessage>
	<messageId>{$ctx:messageId}</messageId>
</yammer.deleteMessage>
Properties
  • messageId: The ID of the message.
Anchor
request
request
Sample request

Following is a sample REST/JSON request that can be handled by the deleteMessage operation.

Code Block
languagexml
titleSample Request for deleteMessage
{
	"apiUrl":"https://www.yammer.com",
	"apiToken":"CQ9uJaP0fPPoyaPg9lAcw",
	"responseType":"json",
	"messageId":"467053911"
}
Related Yammer documentation
https://developer.yammer.com/restapi/#rest-messages

Anchor
getAlgorithmicFeed
getAlgorithmicFeed
Retrieving the algorithmic feed 

The getAlgorithmicFeed operation retrieves the algorithmic feed for the user.

Code Block
languagexml
titlegetAlgorithmicFeed
<yammer.getAlgorithmicFeed>
    <olderThan>{$ctx:olderThan}</olderThan>
    <newerThan>{$ctx:newerThan}</newerThan>
    <threaded>{$ctx:threaded}</threaded>
	<limit>{$ctx:limit}</limit>
</yammer.getAlgorithmicFeed>
Properties
  • olderThan: The message ID for which the resulting messages should be older than.
  • newerThan: The message ID for which the resulting messages should be newer than.
  • threaded: The boolean flag to request only the first message in each thread.
  • limit: The number of messages to be retrieved in the response.
Anchor
request
request
Sample request

Following is a sample REST/JSON request that can be handled by the getAlgorithmicFeed operation.

Code Block
languagexml
titleSample Request for getAlgorithmicFeed
{
	"apiUrl":"https://www.yammer.com",
	"apiToken":"uewmZGcC18LOvwYfCRSbPA",
	"responseType":"json",
	"olderThan":"",
	"newerThan":"467703777",
	"threaded":"",
	"limit":""
}
Related Yammer documentation
https://developer.yammer.com/restapi/#rest-messages

Anchor
getFollowing
getFollowing
Retrieving the followings of the user

The getFollowing operation retrieves the followings of the user.

Code Block
languagexml
titlegetFollowing
<yammer.getFollowing>
    <olderThan>{$ctx:olderThan}</olderThan>
    <newerThan>{$ctx:newerThan}</newerThan>
    <threaded>{$ctx:threaded}</threaded>
	<limit>{$ctx:limit}</limit>
</yammer.getFollowing>
Properties
  • OlderThan: The message ID for which the resulting messages should be older than.
  • newerThan: The message ID for which the resulting messages should be newer than.
  • threaded: The boolean flag to request only the first message in each thread.
  • limit: The number of messages to be retrieved in the response.
Anchor
request
request
Sample request

Following is a sample REST/JSON request that can be handled by the getFollowing operation.

Code Block
languagexml
titleSample Request for getFollowing
{
	"apiUrl":"https://www.yammer.com",
	"apiToken":"uewmZGcC18LOvwYfCRSbPA",
	"responseType":"json",
	"olderThan":"6388797",
	"newerThan":"",
	"threaded":"",
	"limit":""
}
Related Yammer documentation
https://developer.yammer.com/restapi/#rest-messages

Anchor
getMessages
getMessages
Retrieving all messages

The getMessages operation retrieves all messages.

Code Block
languagexml
titlegetMessages
 <yammer.getMessages>
    <olderThan>{$ctx:olderThan}</olderThan>
    <newerThan>{$ctx:newerThan}</newerThan>
    <threaded>{$ctx:threaded}</threaded>
 	<limit>{$ctx:limit}</limit>
 </yammer.getMessages>
Properties
  • OlderThan: The message ID for which the resulting messages should be older than.
  • newerThan: The message ID for which the resulting messages should be newer than.
  • threaded: The boolean flag to request only the first message in each thread.
  • limit: The number of messages to be retrieved in the response.
Anchor
request
request
Sample request

Following is a sample REST/JSON request that can be handled by the getMessages operation.

Code Block
languagexml
titleSample Request for getMessages
{
	"apiUrl":"https://www.yammer.com",
	"apiToken":"uewmZGcC18LOvwYfCRSbPA",
	"responseType":"json",
	"olderThan":"",
	"newerThan":"",
	"threaded":"true",
	"limit":"1"
}
Related Yammer documentation
https://developer.yammer.com/restapi/#rest-messages

Anchor
getMyFeed
getMyFeed
Retrieving the user's feeds

The getMyFeed operation retrieves the current user's feeds.

Code Block
languagexml
titlegetMyFeed
<yammer.getMyFeed>
    <olderThan>{$ctx:olderThan}</olderThan>
    <newerThan>{$ctx:newerThan}</newerThan>
    <threaded>{$ctx:threaded}</threaded>
	<limit>{$ctx:limit}</limit>
</yammer.getMyFeed>
Properties
  • OlderThan: The message ID for which the resulting messages should be older than.
  • newerThan: The message ID for which the resulting messages should be newer than.
  • threaded: The boolean flag to request only the first message in each thread.
  • limit: The number of messages to be retrieved in the response.
Anchor
request
request
Sample request

Following is a sample REST/JSON request that can be handled by the getMyFeed operation.

Code Block
languagexml
titleSample Request for getMyFeed
{
	"apiUrl":"https://www.yammer.com",
	"apiToken":"uewmZGcC18LOvwYfCRSbPA",
	"responseType":"json",
	"olderThan":"",
	"newerThan":"",
	"threaded":"",
	"limit":"2"
}
Related Yammer documentation
https://developer.yammer.com/restapi/#rest-messages

Anchor
getPrivateMessages
getPrivateMessages
Retrieving private messages

The getPrivateMessages operation retrieves private messages.

Code Block
languagexml
titlegetPrivateMessages
<yammer.getPrivateMessages>
	<olderThan>{$ctx:olderThan}</olderThan>
    <newerThan>{$ctx:newerThan}</newerThan>
    <threaded>{$ctx:threaded}</threaded>
    <limit>{$ctx:limit}</limit>
</yammer.getPrivateMessages>
Properties
  • OlderThan: The message ID for which the resulting messages should be older than.
  • newerThan: The message ID for which the resulting messages should be newer than.
  • threaded: The boolean flag to request only the first message in each thread.
  • limit: The number of messages to be retrieved in the response.
Anchor
request
request
Sample request

Following is a sample REST/JSON request that can be handled by the getPrivateMessages operation.

Code Block
languagexml
titleSample Request for getPrivateMessages
{
	"apiUrl":"https://www.yammer.com",
	"apiToken":"uewmZGcC18LOvwYfCRSbPA",
	"responseType":"json",
	"olderThan":"",
	"newerThan":"",
	"threaded":"",
	"limit":""
}
Related Yammer documentation
https://developer.yammer.com/restapi/#rest-messages

Anchor
getReceivedMessages
getReceivedMessages
Retrieving received messages

The getReceivedMessages operation retrieves received messages.

Code Block
languagexml
titlegetReceivedMessages
<yammer.getReceivedMessages>
	<olderThan>{$ctx:olderThan}</olderThan>
    <newerThan>{$ctx:newerThan}</newerThan>
    <threaded>{$ctx:threaded}</threaded>
    <limit>{$ctx:limit}</limit>
</yammer.getReceivedMessages>
Properties
  • OlderThan: The message ID for which the resulting messages should be older than.
  • newerThan: The message ID for which the resulting messages should be newer than.
  • threaded: The boolean flag to request only the first message in each thread.
  • limit: The number of messages to be retrieved in the response.
Anchor
request
request
Sample request

Following is a sample REST/JSON request that can be handled by the getReceivedMessages operation.

Code Block
languagexml
titleSample Request for getReceivedMessages
{
	"apiUrl":"https://www.yammer.com",
	"apiToken":"uewmZGcC18LOvwYfCRSbPA",
	"responseType":"json",
	"olderThan":"",
	"newerThan":"",
	"threaded":"",
	"limit":""
}
Related Yammer documentation
https://developer.yammer.com/restapi/#rest-messages

Anchor
getSentMessages
getSentMessages
Retrieving sent messages

The getSentMessages operation retrieves sent messages.

Code Block
languagexml
titlegetSentMessages
<yammer.getSentMessages>
	<olderThan>{$ctx:olderThan}</olderThan>
    <newerThan>{$ctx:newerThan}</newerThan>
    <threaded>{$ctx:threaded}</threaded>
    <limit>{$ctx:limit}</limit>
</yammer.getSentMessages>
Properties
  • OlderThan: The message ID for which the resulting messages should be older than.
  • newerThan: The message ID for which the resulting messages should be newer than.
  • threaded: The boolean flag to request only the first message in each thread.
  • limit: The number of messages to be retrieved in the response.
Anchor
request
request
Sample request

Following is a sample REST/JSON request that can be handled by the getSentMessages operation.

Code Block
languagexml
titleSample Request for getSentMessages
{
	"apiUrl":"https://www.yammer.com",
	"apiToken":"uewmZGcC18LOvwYfCRSbPA",
	"responseType":"json",
	"olderThan":"",
	"newerThan":"",
	"threaded":"",
	"limit":""
}
Related Yammer documentation
https://developer.yammer.com/restapi/#rest-messages

Anchor
postLike
postLike
Liking a post

The postLike operation sets a like to a post.

Code Block
languagexml
titlepostLike
<yammer.postLike>
	<messageId>{$ctx:messageId}</messageId>
</yammer.postLike>
Properties
  • messageId: The ID of the message.
Anchor
request
request
Sample request

Following is a sample REST/JSON request that can be handled by the postLike operation.

Code Block
languagexml
titleSample Request for postLike
{
	"apiUrl":"https://www.yammer.com",
	"apiToken":"CQ9uJaP0fPPoyaPg9lAcw",
	"responseType":"json",
	"messageId":"467703777"
}
Related Yammer documentation
https://developer.yammer.com/restapi/#rest-messages

Anchor
postNewMessage
postNewMessage
Posting a new message

 The postNewMessage operation posts a new message. This operation does not require init to be passed in.

Code Block
languagexml
titlepostNewMessage
<yammer.postNewMessage>
    <apiUrl>{$url:apiUrl}</apiUrl>
    <apiToken>{$url:apiToken}</apiToken>
	<responseType>{$url:responseType}</responseType>
</yammer.postNewMessage>
Properties
  • apiUrl: The URL to access the Yammer API. 
  • apiToken: The API token of the account.
  • responseType: The response type of the method call.
Anchor
request
request
Sample request

Following is a sample request that can be handled by the postNewMessage operation. The Content-Type is 'multipart/form-data'.

Code Block
languagexml
titleSample Request for postNewMessage
http://localhost:8280/services/yammer_postNewMessage?apiToken=CQ9uJaP0fPPoyaPg9lAcw&responseType=json&apiUrl=https://www.yammer.com
Related Yammer documentation
https://developer.yammer.com/restapi/#rest-messages

Anchor
removeLike
removeLike
Removing a like

The removeLike operation removes a like already set to a post.

Code Block
languagexml
titleremoveLike
<yammer.removeLike>
	<messageId>{$ctx:messageId}</messageId>
</yammer.removeLike>
Properties
  • messageId: The ID of the message.
Anchor
request
request
Sample request

Following is a sample REST/JSON request that can be handled by the removeLike operation.

Code Block
languagexml
titleSample Request for removeLike
{
	"apiUrl":"https://www.yammer.com",
	"apiToken":"CQ9uJaP0fPPoyaPg9lAcw",
	"responseType":"json",
	"messageId":"467702501"
}
Related Yammer documentation
https://developer.yammer.com/restapi/#rest-messages

Anchor
sendMessageToEmail
sendMessageToEmail
Sending the message to the e-mail address

The sendMessageToEmail operation sends the message to the e-mail address.

Code Block
languagexml
titlesendMessageToEmail
<yammer.postLike>
	<messageId>{$ctx:messageId}</messageId>
</yammer.postLike>
Properties
  • messageId: The ID of the message.
Anchor
request
request
Sample request

Following is a sample REST/JSON request that can be handled by the sendMessagetoEmail operation.

Code Block
languagexml
titleSample Request for sendMessagetoEmail
{
	"apiUrl":"https://www.yammer.com",
	"apiToken":"y8RKAv09VSVQYFrvDBozQ",
	"responseType":"json",
	"messageId":"467060053"
}
Related Yammer documentation
https://developer.yammer.com/restapi/#rest-messages

Anchor
sampleconfiguration
sampleconfiguration
Sample configuration

Following is a sample proxy service that illustrates how to connect to Yammer with the init operation and use the deleteMessage operation. The sample request for this proxy can be found in the deleteMessage sample request. You can use this sample as a template for using other operations in this category.

...