Stipop Docs | Documentation for SDK and API

Frequently Used Stickers

The Frequently Used Stickers API gives the list of stickers which a user has used the most. You can use this API to show a list of frequently used stickers and drastically enhance user experience for users as showing a group of recently used stickers to users makes it a lot easier to them when sending stickers.

Request URL

GET
https://camera.stipop.io/v1/sticker/frequently

Best Practices

  1. Check all the components that can be put into building this from our UI Kit. It will help you build the sticker feature much quicker and easier.
  2. We recommend you using this along with Recently Used Stickers to provide the best user experience to the users.

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.

Example Request

Sample call to get frequently used stickers
1
curl --location --request GET "https://camera.stipop.io/v1/sticker/frequently?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
18
19
20

{
  "header": {
    "code": "0000",
    "status": "success",
    "message": "success"
  },
  "body": {
    "stickerList": [
      {
        "stickerId": 60425,
        "stickerImg": "https://img.......590696173_9.png"
      },
      {
        "stickerId": 60423,
        "stickerImg": "https://img.......695828_7.png"
      }
    ]
  }
}

Response Format

Attributes
NameTypeDescription
stickerIdstringUnique value for a single sticker
stickerImgstringSticker image url

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.