Stipop Docs | Documentation for SDK and API

Trending Sticker Packs

The Trending Sticker Packs API delivers a list of top trending sticker packs to your app. The trending pack list automatically adjusts to your app category/subcategory and user locale information (language and country). This is so that your users get the perfect stickers they need and each apps get a unique list of sticker packs.

A sticker pack typically consists of 15-24 stickers with additional information such as the pack name, category, keyword, artist name, and the main language. We recommend you follow the Best Practices listed below for best use of the APIs.

After integrating the API, you can visit Stipop Dashboard to view sticker related analytics and configure sticker filter if you'd like to customize sticker listings for your app and service.

Request URL

GET
https://messenger.stipop.io/v1/package

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. 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.
  3. 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.
  4. 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.
  5. Use the limit and pageNumber parameters to control optimal sticker loading. For example, set limit to '30' and use pageNumber 1,2,3... to show 30 sticker packs per page.
  6. You can add dimension (d) to sticker image url to optimize image size for specific UIs. For example, d=100x100 or d=300x300 (in pixels). The recommended default size is 300px and maximum is 700px.

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
premiumstringY: Look for premium stickers only
N: Look for free stickers only
Empty parameter: Look for all stickers
limitintThe maximum number of stickers per page.
Use pageNumber accordingly for optimized sticker view.
Default Value: 20 (max: 50)
pageNumberintSpecify pageNumber to show limit number of stickers per page.
animatedstringY: Look for animated stickers only
N: Look for static(still) stickers only
Empty parameter: Look for all stickers

Example Request

Sample Call: Trending Sticker Packs
1
curl --location --request GET "https://messenger.stipop.io/v1/package?userId=9937&pageNumber=1&lang=en&countryCode=US&limit=10" --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
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

{
    "header": {
      "code": "0000",
      "status": "success",
      "message": "success"
    },
    "body": {
        "packageList": [
        {
            "packageId": 2309,                          
            "packageName": "cada día",                    
            "packageImg": "https://img....70AAeHBn4N.png", 
            "packageCategory": "Animation/Cartoon,Gag", 
            "packageKeywords": "bonito,mono,bello,adorable,life,cute,lovely", 
            "packageAnimated": "N",                       
            "isNew": "N",                               
            "artistName": "pinono",                     
            "language": "Spanish",                         
            "isDownload": "Y",                             
                "isWish": "N"					
        },
        {
            "packageId": 2473,
            "packageName": "¿Cómo estás?",
            "packageImg": "https://img.....Ggdu7s3J15.gif",
            "packageCategory": "Phrases,Etc.",
            "packageKeywords": "¿Cómoestás?,letra",
            "packageAnimated": "Y",
            "isNew": "N",
            "artistName": "annapig",
            "language": "Spanish",
                "isDownload": "Y",                             
                "isWish": "N"					 
        },
        ......
        ],
        "pageMap": {
          "pageNumber": 1,
          "onePageCountRow": 10,
          "totalCount": 2953,
          "pageCount": 296,
          "groupCount": 30,
          "groupNumber": 0,
          "pageGroupCount": 10,
          "startPage": 1,
          "endPage": 10,
          "startRow": 0,
          "endRow": 10,
          "modNum": 3,
          "listStartNumber": 2953
        }
    }
}

Response Format

Attribute NameTypeDescription
packageIdstringSticker package ID
packageNameintSticker package name
packageImgstringMain image of sticker package
packageCategoryintSticker package category
packageKeywordsstringSticker package keyword
packageAnimatedintIs sticker animated (Y/N)
pricestringPrice of sticker pack: [Free] [$0.99] [$1.99]
isNewstringIs sticker new (Y/N)
artistNameintName of the artist
languagestringMain language of sticker package
isDownloadstringIs sticker downloaded by the user (Y/N)
isWishstringIs sticker in wish list (Y/N)

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.