Confirm Gift Pack
Add the Confirm Gift Pack API along with Send Gift Pack API. Once these are added you can also add a list of sent/received sticker packs so the users can see a list of gifted sticker packages.
Request URL
PUT
https://messenger.stipop.io/v1/gift/:packageId/:sendUserId/:receiveUserId
Best Practices
- We highly recommend you utilizing the Confirm Gift Pack API along with Sent Gift Pack List API and Received Gift Pack List.
- For the sendUserId and receiveUserId 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
| Required | Type | Description |
|---|---|---|
| apikey | string | Stipop API Key for your app. Visit developer dashboard for new API Key. |
| Required | Type | Description |
|---|---|---|
| packId | string | The [packId] of a sticker pack, NOT stickerId. Example: 6363, 5636, 5859 |
| sendUserId | string | The userId of a user who's sending gift pack. The userId can be in any string format. Important: Using same userId for multiple users is not allowed. |
| receiveUserId | string | The userId of a user who's receiving gift pack. The userId can be in any string format. Important: Using same userId for multiple users is not allowed. |
Example Request
Sample Call: Confirm Gift Pack
cURL
1
curl --location --request PUT "https://messenger.stipop.io/v1/gift/118/9937/8805" --header "apikey:xxxxxxxxx"Success Response
Success Response code 200
1
2
3
4
5
6
7
8
{
"header": {
"code": "0000",
"status": "success",
"message": "success"
},
"body": []
}
Response Format
| 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