Main Sticker Banner

With the Main Sticker Banner API, you can show attractive featured stickers to users. Sticker banners are like banners you see on App Stores with featured apps. Featured stickers for the main banner are curated by the Stipop Content Team. Just by adding the main banner you can drastically increase sticker download rate.

Request URL

GET

https://messenger.stipop.io/v1/curation/type/:type

Best Practices

Use the language and country parameters (strongly recommended) to provide user locale information for best use. Stipop automatically tunes the sticker content so that it matches your users' language preferences, cultures, and local trends. The default values for language and country are en and US.
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 parameter to have optimal sticker banner loading. For example, set limit to '10' to show 10 main banners.
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.
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.

Parameters

Request Headers
Required	Type	Description
apikey	string	Stipop API Key for your app. Visit developer dashboard for new API Key.

Request Path Parameters
Required	Type	Description
type	string	A type is small banner B type is big banner Example: A, B

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.
lang	string	Specify default language for regional stickers. Use a 2-letter ISO 639-1 language code. Example: en
countryCode	string	Specify default country for local stickers. Use a 2-letter ISO 3166-1 country code. Example: US
Optional	Type	Description
limit	int	The maximum number of main banners. Default Value: 5 (max: 10)

Example Request

1
curl --location --request GET "https://messenger.stipop.io/v1/curation/type/A?userId=xxx" --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

{
  "header": {
      "code": "0000",
      "status": "success",
      "message": "success"
  },
  "body": {
      "card": {
          "cardId": 17,
          "title": "Stipop picks",
          "type": "B",
          "imgUrl": null,
          "language": "en",
          "country": "us",
          "packageList": [
              {
                  "packageId": 3651,
                  "packageName": "Tod & Sal",
                  "artistName": "Bare Tree Media",
                  "packageImg": "https://img...LKCyP.gif",
                  "stickerImg": null,
                  "cardImgUrl": "https://img...u6q8C.png",
                  "lightBackgroundCode": "#ffd860",
                  "darkBackgroundCode": "#ffd860",
                  "isDownload": "N",
                  "stickers": null
              }, 
              ........
          ]
      },
      "pageMap": null
  }
}

Response Format

Attributes
Name	Type	Description
cardId	int	Banner card ID
title	string	Banner section title
type	string	Banner type
packageId	int	Sticker package ID
packageName	string	Sticker package name
artistName	string	Name of the artist
packageImg	string	Sticker package image
cardImgUrl	string	URL of banner card image
lightBackgroundCode	string	Light theme background code (customizable)
darkBackgroundCode	string	Dark theme background code (customizable)
isDownload	string	Is sticker downloaded by the user (Y/N)

Error Response

Error	Code	Description
Description	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

Sticker StoreNEW STICKER PACKAGES

Sticker StoreRECENTLY VIEWED PACKS