Received Gift Pack List

The Received Gift Pack List API delivers a list of stickers that a user has received from another user as a gift.

Request URL

GET

https://messenger.stipop.io/v1/gift/receive/:userId

Best Practices

Try placing the received gift package list in user’s my page. The user should be able to view the history of sticker packages the user sent.
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.
Once you’ve set the API visit your Dashboard Analytics page and see gift sticker reports. Other clients have seen valuable data such as a data set that can lead to understanding user satisfaction of the product and increasing revenue on a sticker store model.

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
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/gift/receive/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
{
  "header": {
      "code": "0000",
      "status": "success",
      "message": "success"
  },
  "body": {
  	"packageList": [
        {
            "packageId": 118,
            "packageName": "Stuart",
            "packageImg": "https://img..7.png",
            "packageCategory": "Animation/Cartoon",
            "packageKeywords": "Stuart,Sticker",
            "sendUserId": "9937",				
            "receiveUserId": "8805",		
            "isReceive": "Y",
            "sendDate": "2020-07-07T03:09:41.000Z", 	
            "receiveDate": "2020-07-07T03:11:38.000Z",	
            "packageAnimated": "N",
            "isNew": "N",
            "artistName": "MightyCat",
            "language": "English",
            "isDownload": "Y",
            "isWish": "Y"
        }
    ],
    "pageMap": {
      "pageNumber": 1,
      "onePageCountRow": 20,
      "totalCount": 1,
      "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)
isReceive	string	Is sticker received by the user (Y/N)
sendUserId	string	User ID of the user who sent the gift sticker package
receiveUserId	string	User ID of the user who received the gift sticker package
sendDate	date	Date when gift sticker package was sent
receiveDate	date	Date when gift sticker package was received

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

Sticker GiftSENT GIFT PACK LIST

UI KitGETTING STARTED