Stipop Docs | Documentation for SDK and API

Main Sticker Banner

With the Main Sticker Banner API, you can show attractive featured stickers to users. Sticker banners are like banners you see on App Stores with featured apps. Featured stickers for the main banner are curated by the Stipop Content Team. Just by adding the main banner you can drastically increase sticker download rate. Along with the banner, try using the Sticker Curation Cards to build a full sticker store for both free and paid stickers.

Request URL

GET
https://messenger.stipop.io/v1/curation/banner

Best Practices

  1. Use the language and country parameters (strongly recommended) to provide user locale information for best use. Stipop automatically tunes the sticker content so that it matches your users' language preferences, cultures, and local trends. The default values for language and country are en and US.
  2. For the userId parameter, please don't use identical userId for multiple users. This is thoroughly monitored and in case of any misuse, the API key can be blocked from usage. The userId can be in any string format.
  3. Use the limit parameter to have optimal sticker banner loading. For example, set limit to '10' to show 10 main banners.
  4. When a user sends sticker on any chat interface, you should Register Sticker Send. This is strongly recommended so that Stipop can analyze sticker send data to show most opt sticker pack list in the future.
  5. When a user downloads a sticker pack, you need to call the Download/Purchase Sticker API. You'll be needing this information when using APIs like My Sticker Packs, Download/Purchase History, and Recently Viewed Packs which are all essential features.

Parameters

Request Headers
RequiredTypeDescription
apikeystringStipop API Key for your app.
Visit developer dashboard for new API Key.
Request Query Parameters
RequiredTypeDescription
userIdstringUnique value for every user to distinguish unique users.
The userId can be in any string format.
Important: Using same userId for multiple users is not allowed.
Strongly RecommendedTypeDescription
langstringSpecify default language for regional stickers.
Use a 2-letter ISO 639-1 language code.
Default Value: en
countryCodestringSpecify default country for local stickers.
Use a 2-letter ISO 3166-1 country code.
Default Value: US
OptionalTypeDescription
limitintThe maximum number of main banners.
Default Value: 5 (max: 10)

Example Request

Sample Call: Main Sticker Banner
1
curl --location --request GET "https://messenger.stipop.io/v1/curation/banner?userId=xxx" --header "apikey:xxxxxxxxx"

Success Response

Success Response code 200
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

{
  "header": {
    "code": "0000",
    "status": "success",
    "message": "success"
  },
  "body": {
    "bannerList": [
      {
        "bannerId": 1,
        "packageId": 118,
        "bannerImg": "https://img......XgcPc.gif"
      }
    ]
  }
}

Response Format

Attributes
NameTypeDescription
bannerIdstringbanner ID
packageIdstringSticker package ID
bannerImgstringbanner image

Error Response

ErrorCodeDescription
Description9000The API key used does not exist
server error1000Unable to receive data from the server
We’re here to help. Contact us.