Stipop Docs | Documentation for SDK and API

Hidden Sticker Packs

The Hidden Sticker Packs API gives the list of sticker packs which a user has hidden (or deleted in case of free sticker packs) from the user’s my stickers list using the Hide/Recover My Pack API. You can use this API to show a list of hidden (deleted) stickers in the My Page UI. It is an essential feature to the users. In general, once users have more than 10 stickers they decide to hide some of their stickers so they can use what they prefer much easily.

Check the UI Kit to get more understanding of how this API can be used.

Request URL

GET
https://messenger.stipop.io/v1/mysticker/hide/:userId

Best Practices

  1. In order to utilize Hidden Sticker Packs you must also be calling My Sticker Packs API and Hide/Recover My Pack API. After calling the My Sticker Packs, use Hide/Recover My Pack to let users hide sticker packs they downloaded, and then call Hidden Sticker Packs to show a list of hidden sticker packs to the users.
  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 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.
  4. 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.
OptionalTypeDescription
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.

Example Request

Sample Call: Hidden Sticker Packs
1
curl --location --request GET "https://messenger.stipop.io/v1/mysticker/hide/9937?pageNumber=1&limit=20"  --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
55
56
{
  header: {
    code: '0000',
    status: 'success',
    message: 'success',
  },
  body: {
    packageList: [
      {
        packageId: 118,
        packageName: 'Stuart',
        packageImg: 'https://img....7.png',
        packageCategory: 'Animation/Cartoon',
        packageKeywords: 'Stuart,Sticker',
        packageAnimated: 'N',
        isView: 'Y',
        order: 1,
        isNew: 'N',
        artistName: 'MightyCat',
        language: 'English',
        isDownload: 'Y',
        isWish: 'Y',
      },
      {
        packageId: 119,
        packageName: 'The Boy',
        packageImg: 'https://img...png',
        packageCategory: 'Animation/Cartoon',
        packageKeywords: 'Boy,Sticker',
        packageAnimated: 'N',
        isView: 'Y',
        order: 2,
        isNew: 'N',
        artistName: 'blueman_print',
        language: 'English',
        isDownload: 'Y',
        isWish: 'N',
      },
    ],
    "pageMap": {
      "pageNumber": 1,
      "onePageCountRow": 20,
      "totalCount": 2,
      "pageCount": 1,
      "groupCount": 1,
      "groupNumber": 0,
      "pageGroupCount": 10,
      "startPage": 1,
      "endPage": 1,
      "startRow": 0,
      "endRow": 20,
      "modNum": 2,
      "listStartNumber": 2
    }
  },
}

Response Format

Attributes
NameTypeDescription
packageIdstringSticker package ID
packageNameintSticker package name
packageImgstringMain image of sticker package
packageCategoryintSticker package category
packageKeywordsstringSticker package keyword
packageAnimatedintIs sticker animated (Y/N)
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)
isViewstringIs sticker viewed by the user (Y/N)
orderstringShows the order of sticker package in My Stickers List

Error Response

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