groupme-js / GroupMeCommunityDocs

21 stars 8 forks source link

GroupMe Community Docs

GroupMe has a thriving developer community which has created a variety of applications, bots, and tools. However, while the platform has constantly matured, the public documentation has not. In an effort to help other developers understand and utilize the platform better, this is a community-led effort to document everything possible. If you discover something not listed here, or you find an error in what is listed, please bring it up on the discussion page or submit a pull request.

Most of the information is pulled from dev.groupme.com, which is the official GroupMe developers site. However, much of its information is outdated or incomplete, so please help keep this repo up-to-date.

This documentation is not associated with GroupMe or Microsoft

Contents:

Group management - How to create, join, list, update, etc. groups.

Subgroup management - How to work with subgroups within a parent group.

Member management - How to add, remove, and update members.

Group Messages - How to list and send messages in groups

Direct Messages - How to list, read, and send DMs, as well as how to block/unblock users

Likes - How to like/unlike messages, and how to see the leaderboard in groups

Calendar Events - How to list, create, and edit calendar events in a group.

Bots - How to create, index, and use bots.

Account Management - How to access/update information about an account, turning on/off SMS mode, and indexing and destroying tokens

Attachments - Information on how message attachments work, as well as how to upload images to be sent as attachments

Videos - Information on how to upload videos to be sent as attachments

Polls - Information on how to make and view polls

Push - How to connect to the Push service to get real-time interaction with your program

Emoji - How GroupMe's custom emoji system works, as well as how to display and send emoji

Pins - How to use GroupMe's new Pin functionality


Still needs documenting: