Yammer

Yammer

Yammer is a leading social network for businesses to get work done smarter and faster. Connect to Yammer to access conversations in your enterprise network.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds
Frequency of trigger polls 1 15 seconds

Actions

Get all messages

This operation returns all public messages in the logged in user's Yammer network. Corresponds to "All" conversations in the Yammer web interface.

Optional Parameters

Unique identifier of the network.
string
Network ID
Older than
integer
Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example, if you’re currently viewing 20 messages and the oldest is number 2912, you could append “?older_than=2912″ to your request to get the 20 messages prior to those you’re seeing.
Newer than
integer
Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you’re looking at messages, and the most recent message returned is 3516, you can make a request with the parameter “?newer_than=3516″ to ensure that you do not get duplicate copies of messages already on your page.
Limit
integer
Return only the specified number of messages.
Page
integer
Get the page specified. If returned data is greater than the limit, you can use this field to access subsequent pages

Returns

Message List
MessageList

List of one or multiple messages.

Get groups

Gets all groups. If mine = 1, get only groups to which the user belongs

Optional Parameters

Network ID
string
Network ID
mine
integer
Used for getting groups which user is part of
Show All Company Group
integer
Used for showing All Company Group

Returns

array of YammmerEntity

Get my networks

Gets all the networks that the user belongs to.

Optional Parameters

Unique identifier of the network.
string
Network ID
Older than
integer
Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example, if you’re currently viewing 20 messages and the oldest is number 2912, you could append “?older_than=2912″ to your request to get the 20 messages prior to those you’re seeing.
Newer than
integer
Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you’re looking at messages, and the most recent message returned is 3516, you can make a request with the parameter “?newer_than=3516″ to ensure that you do not get duplicate copies of messages already on your page.
Limit
integer
Return only the specified number of messages.
Page
integer
Get the page specified. If returned data is greater than the limit, you can use this field to access subsequent pages

Returns

array of Network

Get user details

This operation returns user profile details.

Required Parameters

User ID
integer
Unique identifier of the user.

Returns

User
User

Properties of Yammer user.

Gets messages in a group

This operation returns the messages posted in a group.

Required Parameters

Group ID
integer
Unique identifier of the group.

Optional Parameters

Network ID
string
Unique identifier of the network.
Older than
integer
Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example, if you’re currently viewing 20 messages and the oldest is number 2912, you could append “?older_than=2912″ to your request to get the 20 messages prior to those you’re seeing.
Newer than
integer
Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you’re looking at messages, and the most recent message returned is 3516, you can make a request with the parameter “?newer_than=3516″ to ensure that you do not get duplicate copies of messages already on your page.
Limit
integer
Return only the specified number of messages.
Page
integer
Get the page specified. If returned data is greater than the limit, you can use this field to access subsequent pages

Returns

Message List
MessageList

List of one or multiple messages.

Gets the messages from my Following feed

This operation returns the messages from Following feed which is conversations involving people, groups and topics that the user is following.

Optional Parameters

Network ID
string
Unique identifier of the network.
Older than
integer
Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example, if you’re currently viewing 20 messages and the oldest is number 2912, you could append “?older_than=2912″ to your request to get the 20 messages prior to those you’re seeing.
Newer than
integer
Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you’re looking at messages, and the most recent message returned is 3516, you can make a request with the parameter “?newer_than=3516″ to ensure that you do not get duplicate copies of messages already on your page.
Limit
integer
Return only the specified number of messages.
Page
integer
Get the page specified. If returned data is greater than the limit, you can use this field to access subsequent pages

Returns

Message List
MessageList

List of one or multiple messages.

Post message

This operation is used to post a Message to a Group or All Company Feed. If group ID is provided, message will be posted to the specified group else it will be posted in All Company Feed.

Required Parameters

Group ID
integer
The group to post a message to (0 = All Company/Network).
Message Text
string
Your message to be posted into your network.

Optional Parameters

Network ID
string
Unique id of the network.
Replied To Id
integer
The message ID this message is in reply to.
Direct To Id
integer
If set, a private message will be sent directly to the user with the indicated ID.
Broadcast
boolean
Post message as an announcement to all users in a group.
Title
string
Title of the message to be posted.
Topic 1
string
Topic to apply to the message.
Topic 2
string
Topic to apply to the message
Topic 3
string
Topic to apply to the message.
Topic 4
string
Topic to apply to the message
Topic 5
string
Topic to apply to the message.
Topic 6
string
Topic to apply to the message.
Topic 7
string
Topic to apply to the message
Topic 8
string
Topic to apply to the message.
Topic 9
string
Topic to apply to the message.
Topic 10
string
Topic to apply to the message.
Topic 11
string
Topic to apply to the message.
Topic 12
string
Topic to apply to the message.
Topic 13
string
Topic to apply to the message.
Topic 14
string
Topic to apply to the message.
Topic 15
string
Topic to apply to the message.
Topic 16
string
Topic to apply to the message.
Topic 17
string
Topic to apply to the message.
Topic 18
string
Topic to apply to the message.
Topic 19
string
Topic to apply to the message.
Topic 20
string
Topic to apply to the message.

Returns

Message List
MessageList

List of one or multiple messages.

Triggers

When there is a new message in a group

This operation triggers when a new message is posted in a group.

Required Parameters

Group Id
integer
Unique identifier of the group.

Optional Parameters

Network Id
string
Unique identifer of the network.

Returns

Message List
MessageList

List of one or multiple messages.

When there is a new message in my followed feed

This operation triggers when there is a new message in a network followed by you.

Optional Parameters

Network ID
string
Pick a network.

Returns

Message List
MessageList

List of one or multiple messages.

Definitions

User

Properties of Yammer user.

Birth date
string
User birth date.
Email
string
User email.
First name
string
User first name.
Full name
string
User full name.
Job title
string
User job title.
Last name
string
User last name.
Location
string
User location.
Profile url
string
User profile url.
Username
string
Username.

Message

Properties of a single Yammer message.

Client Id
string
Type of the client.
Client URL
uri
Web link of the client.
Created At
string
Time at which the message was created.
Direct message
boolean
Flag to specify if the post is a a direct message.
Group ID
integer
Unique ID of group who posted the message.
ID
integer
ID associated with the post.
Is System Message
boolean
Flag to specify if the post is a system generated message or not.
Language
string
Language used in the message.
Message Body
MessageBody
Content associated with a single message.
Network
integer
Id of the network message is associated with.
Privacy
string
Details of the privacy associated with the message.
Replied to
integer
ID of the message to which this message is a reply.
Sender
integer
Unique ID of user who posted the message.
Sender Type
string
Description of the type of sender.
Tagged User
array of integer
Details of users notified.
Text
string
Text Content of the post.
Thread ID
integer
Unique ID of thread.
Type
string
Descripton of the message type.
Url
uri
API url of the post.
Web Url
uri
Web url of the post.
liked_by
LikedBy
Liked By

MessageList

List of one or multiple messages.

Messages
array of Message
messages

MessageBody

Content associated with a single message.

Plain
string
Plain text format.
Rich
string
Rich text format.
Text
string
Parsed text format.

LikedBy

Liked By

Count
integer
Number of distinct likes.
Names
array of string
List of people who liked the post.

Network

Properties of a single network.

ID
integer
Unique identifier of the network.
Link
string
Web link to the network page.
Name
string
Summary of the network.

YammmerEntity

Properties of a single yammer entity.

Description
string
Details of the yammer entity.
Full Name
string
Name of the yammer entity.
Group ID
integer
Unique identifier of the group.