Recently Viewed Packs
The Recently Viewed Packs API gives the list of sticker packs a user has viewed recently. Use this API to help users go back to sticker packs they saw before and make quicker decisions on downloading sticker packs.
Request URL
GET
https://messenger.stipop.io/v1/package/recent/:userId
Best Practices
- 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.
- 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
Required | Type | Description |
---|---|---|
apikey | string | Stipop API Key for your app. Visit developer dashboard for new API Key. |
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
Sample Call: Recently Viewed Packs
cURL
1
curl --location --request GET "https://messenger.stipop.io/v1/package/recent/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
{
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": 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
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) |
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.