Stipop Docs | Documentation for SDK and API

Recently Sent Stickers

The Recently Sent Stickers API gives the list of stickers which a user has sent in recent order. You must Register Sticker Send when a sticker is sent in order to utizlize this feature and also gather essential sticker send data. It will 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://messenger.stipop.io/v1/package/send/:userId

Best Practices

  1. 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.
  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: Recently Sent Stickers
1
curl --location --request GET "https://messenger.stipop.io/v1/package/send/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
{
  "header": {
      "code": "0000",
      "status": "success",
      "message": "success"
  },
  "body": {
  	"stickerList": [
        {
            "stickerId": 3684,					
            "packageId": 347,						
            "stickerImg": "https://img.....l_08.png"	
        },
        {
            "stickerId": 3683,
            "packageId": 347,
            "stickerImg": "https://img...._07.png"
        }
    ],
    "pageMap": {
      "pageNumber": 1,
      "onePageCountRow": 20,
      "totalCount": 2,
      "pageCount": 1,
      "groupCount": 1,
      "groupNumber": 0,
      "pageGroupCount": 10,
      "startPage": 1,
      "endPage": 1,
      "startRow": 0,
      "endRow": 20,
      "modNum": 1,
      "listStartNumber": 1
    }
  }
}

Response Format

Attributes
NameTypeDescription
packageIdstringSticker package ID
stickerIdstringSticker ID
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.