Stipop Docs | Documentation for SDK and API

Received Gift Pack List

Received Gift Package List API는 사용자가 선물 받은 스티커 팩 목록을 제공합니다.

Request URL

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

Best Practices

  1. 선물 받은 스티커 팩 목록을 사용자의 마이페이지에 적용하세요. 사용자는 본인이 받은 선물 리스트를 확인할 수 있어야합니다.
  2. API를 적용한 뒤에는 대시보드 Analytics 페이지에서 스티커 팩 선물하기 기능이 어떻게 사용되고 있는지 확인해보세요.

Parameters

Request Headers
RequiredTypeDescription
apikeystring발급받은 API 키 값:
스티팝 대시보드에서 새로운 API 키를 발급받을 수 있습니다.
Request Path Parameters
RequiredTypeDescription
userIdstring앱 사용자에게 부여되는 고유 값.
userId는 아무 string 값이면 됩니다.
중요: 여러 사용자에게 동일한 userId를 사용하면 안됩니다.
OptionalTypeDescription
limitint페이지 당 보여줄 스티커 수 제한.
pageNumber를 사용해 스티커 뷰를 최적화하세요.
기본 값: 20 (최대: 50)
pageNumberintpageNumber를 사용해 한 페이지 당 limit개수의 스티커를 보여주세요.

Example Request

샘플 요청: 선물 받은 스티커 팩 리스트
1
curl --location --request GET "https://messenger.stipop.io/v1/gift/receive/9937  --header "apikey:xxxxxxxxx"

Success Response

성공 응답: 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
{
  "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"
        }
    ]
  }
}

Response Format

Attributes
NameTypeDescription
packageIdint스티커 팩 ID
packageNamestring스티커 팩 이름
packageImgstring스티커 팩의 메인 이미지
packageCategorystring스티커 팩의 카테고리
packageKeywordsstring스티커 팩의 키워드
packageAnimatedstring움직이는 스티커 여부 (Y/N)
isNewstring새로운 스티커 여부 (Y/N)
artistNamestring스티커 작가 이름
languagestring스티커 팩의 메인 언어
isDownloadstring사용자의 스티커 다운로드 여부 (Y/N)
isWishstring스티커 위시리스트 여부 (Y/N)
isReceivestring사용자의 받은 스티커 선물 팩 승인 여부 (Y/N)
sendUserIdstring스티커 팩을 선물하는 개별 사용자마다 부여되는 고유 userId 값
sendUserIdstring스티커 팩을 선물하는 개별 사용자마다 부여되는 고유 userId 값
sendDatedate스티커 팩가 선물된 날짜
receiveDatedate스티커 선물 팩을 받은 날짜

Error Response

ErrorCodeDescription
non exist apikey9000사용된 API 키가 존재하지 않습니다.
server error1000서버에서 정보를 받을 수 없습니다.
도움이 필요하신가요? 문의주세요.