Stipop Docs | Documentation for SDK and API

Sent Gift Pack List

The Sent 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/send/:userId

Best Practices

  1. Try placing the sent gift package list in user’s my page. The user should be able to view the history of sticker packages the user sent.
  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. 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
RequiredTypeDescription
apikeystringStipop API Key for your app.
Visit developer dashboard for new API Key.
Request Path 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: Sent Gift Pack List
1
curl --location --request GET "https://messenger.stipop.io/v1/gift/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
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
NameTypeDescription
packageIdstringSticker package ID
packageNameintSticker package name
packageImgstringMain image of sticker package
packageCategoryintSticker package category
packageKeywordsstringSticker package keyword
packageAnimatedintIs sticker animated (Y/N)
isNewstringIs sticker new (Y/N)
artistNameintName of the artist
languagestringMain language of sticker package
isDownloadstringIs sticker downloaded by the user (Y/N)
isWishstringIs sticker in wish list (Y/N)
isReceivestringIs sticker received by the user (Y/N)
sendUserIdstringUser ID of the user who sent the gift sticker package
receiveUserIdstringUser ID of the user who received the gift sticker package
sendDatedateDate when gift sticker package was sent
receiveDatedateDate when gift sticker package was received

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.