Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/WhatsApp/stickers

This repository contains the iOS and Android sample apps and API for creating third party sticker packs for WhatsApp.
https://github.com/WhatsApp/stickers

Last synced: 11 days ago
JSON representation

This repository contains the iOS and Android sample apps and API for creating third party sticker packs for WhatsApp.

Awesome Lists containing this project

README

        

# WhatsApp Stickers

![Works with Android](https://img.shields.io/badge/Works_with-Android-green?style=flat-square)
![Works with iOS](https://img.shields.io/badge/Works_with-iOS-blue?style=flat-square)
![GitHub issues](https://img.shields.io/github/issues/whatsapp/stickers?style=flat-square)

> This repository contains the iOS and Android sample apps and API for creating third party sticker packs for WhatsApp.

If you'd like to create your own [stickers for WhatsApp](https://faq.whatsapp.com/en/android/26000227/), you can package them in an Android or iOS app.

For Android users, you can publish your sticker app to the [Google Play Store](https://play.google.com/store) and users who download and install your app will be able to start sending those stickers right away from within WhatsApp.
For iOS developers please read the [IMPORTANT NOTICE ABOUT iOS APPS](#please-read-important-notice-about-ios-apps) section.

**Stickers on WhatsApp must be legal, authorized and acceptable.** Learn more about acceptable uses of our services from our [Terms of Service](https://www.whatsapp.com/legal/#terms-of-service).

## Get started :rocket:

To get started, review the `README` files in the [Android](https://github.com/WhatsApp/stickers/tree/master/Android) or [iOS](https://github.com/WhatsApp/stickers/tree/master/iOS) folders, and refer to the [FAQ](https://faq.whatsapp.com/general/26000226).

## PLEASE READ: IMPORTANT NOTICE ABOUT iOS APPS

With Apple’s strict App Store review policy, we recommend iOS developers to submit apps that contain more functionality than to simply export stickers. This will increase the chances of the app being accepted. As an alternative to creating an iOS app, there are various sticker maker apps that help you create and import stickers into WhatsApp.

The sample iOS app is an example of how to use our API to import stickers into WhatsApp and can serve as a guide on how to get started, but it is not meant to be used as a template for your app because it will not be accepted by Apple.

## Announcements :loudspeaker:
Please check out [Announcements](https://github.com/WhatsApp/stickers/wiki/Animated-Stickers) for recent changes.

## Brand guidelines
When naming your app, it is strongly advised you do not use "WhatsApp" anywhere in the name of your app or in the name field of your app listing. However, when preparing your app for submission in Google Play Store/App Store, you'll have the option to add description associated with your app and it's okay to mention WhatsApp in the description. Make sure you use "WhatsApp" as a brand name, with "W" and "A" capitalized with no space between letters. More information on WhatsApp Brand(https://www.facebook.com/brand/resources/whatsapp/whatsapp-brand).

## Opening Issues :warning:

> Only use the GitHub Issues section if you discovered **issues with the code itself**. Do not mistake the Issues page as a help desk. You can ask for help at [Stack Overflow](https://stackoverflow.com/questions/tagged/whatsapp-stickers).
> For support, please contact .

- Create an [**Android**](https://github.com/WhatsApp/stickers/issues/new?template=android.md) issue
- Create an [**iOS**](https://github.com/WhatsApp/stickers/issues/new?template=ios.md) issue
- Create a [**general issue**](https://github.com/WhatsApp/stickers/issues/new?template=general.md)

_For all three options, fill in all fields that apply._

## Opening Pull Requests

> In order for us to accept pull requests, please complete the Contributor License Agreement by following instructions in [`CONTRIBUTING`](https://github.com/WhatsApp/stickers/blob/master/CONTRIBUTING.md).

1. Please check that a similar pull request doesn't exist already [here](https://github.com/WhatsApp/stickers/pulls?utf8=%E2%9C%93&q=is%3Apr)
2. [Open a new pull request](https://github.com/WhatsApp/stickers/compare)
3. Wait for someone to look at it :watch:

## License

WhatsApp Stickers is BSD licensed, as found in the [`LICENSE`](https://github.com/WhatsApp/stickers/blob/master/LICENSE) file.