Connectors Reference

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.

 

Status: Production

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

GetNetworks ()

Get my networks

GetGroups ([Optional]string network_id, [Optional]integer mine, [Optional]integer showAllCompanyGroup)

Get groups

GetAllMessages ([Optional]string network_id, [Optional]integer older_than, [Optional]integer newer_than, [Optional]integer limit, [advanced][Optional]integer page)

Get all messages

PostMessage ([Optional]string network_id, PostOperationRequest input)

Post message

GetMessagesFollowing ([Optional]string network_id, [Optional]integer older_than, [Optional]integer newer_than, [Optional]integer limit, [advanced][Optional]integer page)

Gets the messages from my Following feed

GetMessagesInGroup ([Optional]string network_id, integer group_id, [Optional]integer older_than, [Optional]integer newer_than, [Optional]integer limit, [advanced][Optional]integer page)

Gets messages in a group

GetUserDetailsById (integer user_id)

Get user details

TestConnection ()

Tests the connection

 

Triggers:

Name

Summary

OnNewMessagesFollowing ([Optional]string network_id, [internal][Optional]integer triggerstate)

When there is a new message in my followed feed

OnNewMessagesInGroup ([Optional]string network_id, integer group_id, [internal][Optional]integer triggerstate)

When there is a new message in a group

 

Objects:

Name

Summary

LikedBy

 

Message

Message

MessageBody

Message Body

MessageList

Message List

Network

Network

PostOperationRequest

 

User

User

YammmerEntity

Yammer Entity

 

Actions:

GetNetworks

Summary: Get my networks

Description: Gets all the networks that the user belongs to.

 

Syntax:

Yammer.GetNetworks ()

 

Returns:

          Type:array of (Network)

 

GetGroups

Summary: Get groups

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

 

Syntax:

Yammer.GetGroups ([Optional]string network_id, [Optional]integer mine, [Optional]integer showAllCompanyGroup)

 

Parameters:

Name

Type

Summary

Required

Related Action

network_id

string

(Network ID)

Network ID

False

GetNetworks

mine

integer(int32)

(mine)

Used for getting groups which user is part of

False

showAllCompanyGroup

integer(int32)

(Show All Company Group)

Used for showing All Company Group

False

 

Returns:

          Type:array of (YammmerEntity)

 

GetAllMessages

Summary: Get all messages

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

 

Syntax:

Yammer.GetAllMessages ([Optional]string network_id, [Optional]integer older_than, [Optional]integer newer_than, [Optional]integer limit, [advanced][Optional]integer page)

 

Parameters:

Name

Type

Summary

Required

Related Action

network_id

string

(Unique identifier of the network.)

Network ID

False

GetNetworks

older_than

integer(int64)

(Older than)

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.

False

newer_than

integer(int64)

(Newer than)

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.

False

limit

integer(int32)

(Limit)

Return only the specified number of messages.

False

page

integer(int32)

(Page)

Get the page specified. If returned data is greater than the limit, you can use this field to access subsequent pages

False

 

Returns:

          Type:MessageList

          Summary: Message List

          Description: List of one or multiple messages.

 

PostMessage

Summary: Post message

Description: 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.

 

Syntax:

Yammer.PostMessage ([Optional]string network_id, PostOperationRequest input)

 

Parameters:

Name

Type

Summary

Required

Related Action

network_id

string

(Network ID)

Unique id of the network.

False

GetNetworks

input

PostOperationRequest

 

Represents a post request for Yammer Connector to post to yammer.

True

 

Returns:

          Type:MessageList

          Summary: Message List

          Description: List of one or multiple messages.

 

GetMessagesFollowing

Summary: Gets the messages from my Following feed

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

 

Syntax:

Yammer.GetMessagesFollowing ([Optional]string network_id, [Optional]integer older_than, [Optional]integer newer_than, [Optional]integer limit, [advanced][Optional]integer page)

 

Parameters:

Name

Type

Summary

Required

Related Action

network_id

string

(Network ID)

Unique identifier of the network.

False

GetNetworks

older_than

integer(int64)

(Older than)

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.

False

newer_than

integer(int64)

(Newer than)

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.

False

limit

integer(int32)

(Limit)

Return only the specified number of messages.

False

page

integer(int32)

(Page)

Get the page specified. If returned data is greater than the limit, you can use this field to access subsequent pages

False

 

Returns:

          Type:MessageList

          Summary: Message List

          Description: List of one or multiple messages.

 

GetMessagesInGroup

Summary: Gets messages in a group

Description: This operation returns the messages posted in a group.

 

Syntax:

Yammer.GetMessagesInGroup ([Optional]string network_id, integer group_id, [Optional]integer older_than, [Optional]integer newer_than, [Optional]integer limit, [advanced][Optional]integer page)

 

Parameters:

Name

Type

Summary

Required

Related Action

network_id

string

(Network ID)

Unique identifier of the network.

False

GetNetworks

group_id

integer(int64)

(Group ID)

Unique identifier of the group.

True

GetGroups

older_than

integer(int64)

(Older than)

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.

False

newer_than

integer(int64)

(Newer than)

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.

False

limit

integer(int32)

(Limit)

Return only the specified number of messages.

False

page

integer(int32)

(Page)

Get the page specified. If returned data is greater than the limit, you can use this field to access subsequent pages

False

 

Returns:

          Type:MessageList

          Summary: Message List

          Description: List of one or multiple messages.

 

GetUserDetailsById

Summary: Get user details

Description: This operation returns user profile details.

 

Syntax:

Yammer.GetUserDetailsById (integer user_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

user_id

integer(int64)

(User ID)

Unique identifier of the user.

True

 

Returns:

          Type:User

          Summary: User

          Description: Properties of Yammer user.

 

TestConnection

Summary: Tests the connection

Description: Tests the connection

 

Syntax:

Yammer.TestConnection ()

 

Returns:

 

Triggers:

Trigger OnNewMessagesFollowing

Summary: When there is a new message in my followed feed

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

 

Syntax:

Yammer.OnNewMessagesFollowing ([Optional]string network_id, [internal][Optional]integer triggerstate)

 

Parameters:

Name

Type

Summary

Required

Related Action

network_id

string

(Network ID)

Pick a network.

False

GetNetworks

triggerstate

integer(int32)

(Trigger state)

Trigger state

False

 

Returns:

          Type:MessageList

          Summary: Message List

          Description: List of one or multiple messages.

 

Trigger OnNewMessagesInGroup

Summary: When there is a new message in a group

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

 

Syntax:

Yammer.OnNewMessagesInGroup ([Optional]string network_id, integer group_id, [internal][Optional]integer triggerstate)

 

Parameters:

Name

Type

Summary

Required

Related Action

network_id

string

(Network Id)

Unique identifer of the network.

False

GetNetworks

group_id

integer(int64)

(Group Id)

Unique identifier of the group.

True

GetGroups

triggerstate

integer(int32)

(Trigger state)

Trigger state

False

 

Returns:

          Type:MessageList

          Summary: Message List

          Description: List of one or multiple messages.

 


 

LikedBy

Summary:

Description: Liked By

 

          Properties:

Name

Type

Summary

count

integer(int32)

Count

Number of distinct likes.

names

array of (string)

Names

List of people who liked the post.


 

Message

Summary: Message

Description: Properties of a single Yammer message.

 

          Properties:

Name

Type

Summary

id

integer(int64)

ID

ID associated with the post.

content_excerpt

string

Text

Text Content of the post.

sender_id

integer(int64)

Sender

Unique ID of user who posted the message.

replied_to_id

integer(int64)

Replied to

ID of the message to which this message is a reply.

created_at

string

Created At

Time at which the message was created.

network_id

integer(int32)

Network

Id of the network message is associated with.

message_type

string

Type

Descripton of the message type.

sender_type

string

Sender Type

Description of the type of sender.

url

string(uri)

Url

API url of the post.

web_url

string(uri)

Web Url

Web url of the post.

group_id

integer(int64)

Group ID

Unique ID of group who posted the message.

body

MessageBody

Message Body

Content associated with a single message.

thread_id

integer(int64)

Thread ID

Unique ID of thread.

direct_message

boolean

Direct message

Flag to specify if the post is a  a direct message.

client_type

string

Client Id

Type of the client.

client_url

string(uri)

Client URL

Web link of the client.

language

string

Language

Language used in the message.

notified_user_ids

array of (integer(int64))

Tagged User

Details of users notified.

privacy

string

Privacy

Details of the privacy associated with the message.

liked_by

LikedBy

 

Liked By

system_message

boolean

Is System Message

Flag to specify if the post is a system generated message or not.


 

MessageBody

Summary: Message Body

Description: Content associated with a single message.

 

          Properties:

Name

Type

Summary

parsed

string

Text

Parsed text format.

plain

string

Plain

Plain text format.

rich

string

Rich

Rich text format.


 

MessageList

Summary: Message List

Description: List of one or multiple messages.

 

          Properties:

Name

Type

Summary

messages

array of (Message)

Messages

messages


 

Network

Summary: Network

Description: Properties of a single network.

 

          Properties:

Name

Type

Summary

id

integer(int64)

ID

Unique identifier of the network.

name

string

Name

Summary of the network.

permalink

string

Link

Web link to the network page.


 

PostOperationRequest

Summary:

Description: Represents a post request for Yammer Connector to post to yammer.

 

          Properties:

Name

Type

Summary

group_id

integer(int64)

Group ID

The group to post a message to (0 = All Company/Network).

body

string

Message Text

Your message to be posted into your network.

replied_to_id

integer(int64)

Replied To Id

The message ID this message is in reply to.

direct_to_id

integer(int64)

Direct To Id

If set, a private message will be sent directly to the user with the indicated ID.

broadcast

boolean

Broadcast

Post message as an announcement to all users in a group.

title

string

Title

Title of the message to be posted.

topic1

string

Topic 1

Topic to apply to the message.

topic2

string

Topic 2

Topic to apply to the message

topic3

string

Topic 3

Topic to apply to the message.

topic4

string

Topic 4

Topic to apply to the message

topic5

string

Topic 5

Topic to apply to the message.

topic6

string

Topic 6

Topic to apply to the message.

topic7

string

Topic 7

Topic to apply to the message

topic8

string

Topic 8

Topic to apply to the message.

topic9

string

Topic 9

Topic to apply to the message.

topic10

string

Topic 10

Topic to apply to the message.

topic11

string

Topic 11

Topic to apply to the message.

topic12

string

Topic 12

Topic to apply to the message.

topic13

string

Topic 13

Topic to apply to the message.

topic14

string

Topic 14

Topic to apply to the message.

topic15

string

Topic 15

Topic to apply to the message.

topic16

string

Topic 16

Topic to apply to the message.

topic17

string

Topic 17

Topic to apply to the message.

topic18

string

Topic 18

Topic to apply to the message.

topic19

string

Topic 19

Topic to apply to the message.

topic20

string

Topic 20

Topic to apply to the message.


 

User

Summary: User

Description: Properties of Yammer user.

 

          Properties:

Name

Type

Summary

name

string

Username

Username.

job_title

string

Job title

User job title.

location

string

Location

User location.

full_name

string

Full name

User full name.

first_name

string

First name

User first name.

last_name

string

Last name

User last name.

web_url

string

Profile url

User profile url.

email

string

Email

User email.

birth_date

string

Birth date

User birth date.


 

YammmerEntity

Summary: Yammer Entity

Description: Properties of a single yammer entity.

 

          Properties:

Name

Type

Summary

type

string

Description

Details of the yammer entity.

id

integer(int64)

Group ID

Unique identifier of the group.

full_name

string

Full Name

Name of the yammer entity.