{"__v":4,"_id":"570eb81d4a84800e0059a91b","category":{"__v":3,"_id":"56af6d6ecc4cbd0d00ce2c88","pages":["56af6e8460a37a0d00ed87ac","56af71e58be2ea0d00b48887","56af73a08be2ea0d00b48890"],"project":"56abbf55f25f160d00e17f4e","version":"56abbf55f25f160d00e17f51","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-01T14:36:30.275Z","from_sync":false,"order":2,"slug":"concepts","title":"Kongregate APIs & Concepts"},"parentDoc":null,"project":"56abbf55f25f160d00e17f4e","user":"56abbec30b9e0b0d00616274","version":{"__v":12,"_id":"56abbf55f25f160d00e17f51","project":"56abbf55f25f160d00e17f4e","createdAt":"2016-01-29T19:36:53.665Z","releaseDate":"2016-01-29T19:36:53.665Z","categories":["56abbf56f25f160d00e17f52","56abca6bf9757e0d007c6650","56acddfa0ab3c00d00ce3332","56af65da9d32e30d0006d30f","56af66cab34d210d003d9ad0","56af6afcd21e9c0d00b628d1","56af6d6ecc4cbd0d00ce2c88","5705b12221cfed0e00e8c580","570a5676ade45d0e00c1ad33","570d7d25d1e4b82000d9e385","570eac3c3160d10e0041df0e","575709000fd6a3200010dded"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-13T21:20:29.935Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Note\",\n  \"body\": \"This feature is currently reserved for games that are selling in-app purchases. It will not function unless we have enabled it for your game. If you would like to have this feature enabled, please email us at [apps:::at:::kongregate.com](mailto:apps@kongregate.com).\"\n}\n[/block]\n## User Messaging\n\nThe Kongregate API allows you to initiate a variety of messages to players to help increase engagement and social awareness of the game and a player's accomplishments within it. These fall within a few major categories: user-to-feed (self-posts and announcements), user-to-user (invites and gifting), and game-to-user (game updates, re-engagement). All of these messages will be subject to rate limiting, and the exact rates are still being tweaked by Kongregate based on game and user activity levels.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"While this functionality exists, the use of these messages by players is very different than Facebook and other social networks. Player communication happens primarily through chat and forums and in many cases they are playing on Kongregate specifically to get away from \\\"Facebook games\\\". Conservative use of these features is perfectly fine, but we recommend against repeatedly asking players to post, and expectations for virality from these should be limited.\"\n}\n[/block]\n\n\n### User-to-Feed Messages\n\nThese types of posts enable users to put accomplishments on their own feed. You can initiate a feed posting with [showFeedPostBox](doc:client-api-services-showfeedpostbox) to allow user-to-self messages. The [showShoutBox](doc:client-api-services-showshoutbox) function will enable a self-post to the player's \"Shouts\", which is similar to Facebook's wall posts, and can be used for bragging about accomplishments. The primary difference between these functions is that a \"shout\" will appear as being posted by the player, while a \"feed post\" will be posted by the game and can have embedded images.\n\n### User-to-User Messages\n\nTo help raise awareness of your game, you can have players send an invite to other players for the game with [showInvitationBox](doc:client-api-services-showinvitationbox) . The same function can be used for gifting or other click-to-action messages by simply including a URL link with whatever parameters are appropriate. Remember that to be passed into an iframe, parameters need to be prefixed with `kv_`, such as `?kv_foo=bar`.\n\n### Game-to-User Messages\n\nYour game can initiate a private message to the player with the client-side [`privateMessage`](doc:client-api-services-privatemessage) method. Additionally, to let players know about updates, turn information, etc., you can initiate an offline private message server-side with the [private_message](doc:server-api-private-message)  server-side HTTP method.","excerpt":"Communicate with players","slug":"api-feeds-and-user-messaging","type":"basic","title":"Feeds & User Messaging"}

Feeds & User Messaging

Communicate with players

[block:callout] { "type": "warning", "title": "Note", "body": "This feature is currently reserved for games that are selling in-app purchases. It will not function unless we have enabled it for your game. If you would like to have this feature enabled, please email us at [apps@kongregate.com](mailto:apps@kongregate.com)." } [/block] ## User Messaging The Kongregate API allows you to initiate a variety of messages to players to help increase engagement and social awareness of the game and a player's accomplishments within it. These fall within a few major categories: user-to-feed (self-posts and announcements), user-to-user (invites and gifting), and game-to-user (game updates, re-engagement). All of these messages will be subject to rate limiting, and the exact rates are still being tweaked by Kongregate based on game and user activity levels. [block:callout] { "type": "info", "body": "While this functionality exists, the use of these messages by players is very different than Facebook and other social networks. Player communication happens primarily through chat and forums and in many cases they are playing on Kongregate specifically to get away from \"Facebook games\". Conservative use of these features is perfectly fine, but we recommend against repeatedly asking players to post, and expectations for virality from these should be limited." } [/block] ### User-to-Feed Messages These types of posts enable users to put accomplishments on their own feed. You can initiate a feed posting with [showFeedPostBox](doc:client-api-services-showfeedpostbox) to allow user-to-self messages. The [showShoutBox](doc:client-api-services-showshoutbox) function will enable a self-post to the player's "Shouts", which is similar to Facebook's wall posts, and can be used for bragging about accomplishments. The primary difference between these functions is that a "shout" will appear as being posted by the player, while a "feed post" will be posted by the game and can have embedded images. ### User-to-User Messages To help raise awareness of your game, you can have players send an invite to other players for the game with [showInvitationBox](doc:client-api-services-showinvitationbox) . The same function can be used for gifting or other click-to-action messages by simply including a URL link with whatever parameters are appropriate. Remember that to be passed into an iframe, parameters need to be prefixed with `kv_`, such as `?kv_foo=bar`. ### Game-to-User Messages Your game can initiate a private message to the player with the client-side [`privateMessage`](doc:client-api-services-privatemessage) method. Additionally, to let players know about updates, turn information, etc., you can initiate an offline private message server-side with the [private_message](doc:server-api-private-message) server-side HTTP method.