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

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.
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.
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.
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
Required	Type	Description
apikey	string	Stipop API Key for your app. Visit developer dashboard for new API Key.

Request Query Parameters
Required	Type	Description
userId	string	Unique 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.
Optional	Type	Description
limit	int	The maximum number of stickers per page. Use pageNumber accordingly for optimized sticker view. Default Value: 20 (max: 50)
pageNumber	int	Specify pageNumber to show limit number of stickers per page.

Example Request

1
curl --location --request GET "https://messenger.stipop.io/v1/mysticker/hide/9937?pageNumber=1&limit=20"  --header "apikey:xxxxxxxxx"

Success Response

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
Name	Type	Description
packageId	int	Sticker package ID
packageName	string	Sticker package name
packageImg	string	Main image of sticker package
packageCategory	string	Sticker package category
packageKeywords	string	Sticker package keyword
packageAnimated	string	Is sticker animated (Y/N)
isNew	string	Is sticker new (Y/N)
artistName	string	Name of the artist
language	string	Main language of sticker package
isDownload	string	Is sticker downloaded by the user (Y/N)
isWish	string	Is sticker in wish list (Y/N)
isView	string	Is sticker viewed by the user (Y/N)
order	int	Shows the order of sticker package in My Stickers List

Error Response

Error	Code	Description
non exist apikey	9000	The API key used does not exist
server error	1000	Unable to receive data from the server

Was this page helpful?

We’re here to help. Contact us.

Back

My StickersHIDE/RECOVER MY PACK

My StickersMY WISH LIST