Frequently Sent Stickers

Frequently Sent Stickers API는 사용자가 자주 사용한 스티커를 많이 사용한 순서대로 정렬해서 보여줍니다. 해당 API를 활용하기 위해서는 스티커가 전송될 때 Register Sticker Send를 해주셔야 합니다.

Request URL

GET

https://messenger.stipop.io/v1/package/frequently/:userId

Best Practices

권장: 사용자가 메신저 인터페이스에서 스티커를 사용 할 때 Register Sticker Send API를 사용해 스티커 전송 기록을 저장하세요.저장된 전송 데이터를 통해 향후 사용자들에게 제공되는 스티커가 보다 최적화 될 수 있으며 사용 데이터를 직접 확인 할 수도 있습니다.
userId 파라미터에 다양한 사용자에 대해 같은 userId 값을 사용하지마세요. 해당 값은 지속적으로 모니터링이 되며 중복값이 사용 될 경우 API key가 비활성화 될 수 있습니다. userId 값은 아무 string 형태의 값이면 됩니다.
limit과 pageNumber 파라미터를 사용해 스티커 로딩 속도를 최적화하세요. 예를 들어 limit을 '30'으로 두고 pageNumber 1,2,3...을 적용해 한 페이지 (혹은 한 로딩)에 30개의 스티커를 보여주세요.
스티커 이미지 url에 dimension (d)을 추가해 이미지 사이즈 및 파일 크기를 최적화 할 수 있습니다. 다음과 같이 사용하실 수 있습니다: d=100x100 혹은 d=300x300 (단위: pixel). 권장드리는 기본 스티커 사이즈는 300px 이며 최대 크기는 700px 입니다.

Parameters

Request Headers
Required	Type	Description
apikey	string	발급받은 API 키 값: 스티팝 대시보드에서 새로운 API 키를 발급받을 수 있습니다.

Request Query Parameters
Required	Type	Description
userId	string	앱 사용자에게 부여되는 고유 값. userId는 아무 string 값이면 됩니다. 중요: 여러 사용자에게 동일한 userId를 사용하면 안됩니다.
Optional	Type	Description
limit	int	페이지 당 보여줄 스티커 수 제한. pageNumber를 사용해 스티커 뷰를 최적화하세요. 기본 값: 20 (최대: 50)
pageNumber	int	pageNumber를 사용해 한 페이지 당 limit개수의 스티커를 보여주세요.

Example Request

1
curl --location --request GET "https://messenger.stipop.io/v1/package/frequently/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
{
  "header": {
      "code": "0000",
      "status": "success",
      "message": "success"
  },
  "body": {
  	"stickerList": [
        {
            "stickerId": 3684,						
            "packageId": 347,							
            "stickerImg": "https://img.....l_08.png",				
	          "sendCnt": 3							
        },
        {
            "stickerId": 3683,
            "packageId": 347,
            "stickerImg": "https://img...._07.png",
	          "sendCnt": 1
        }
    ],
    "pageMap": {
      "pageNumber": 1,
      "onePageCountRow": 20,
      "totalCount": 2,
      "pageCount": 1,
      "groupCount": 1,
      "groupNumber": 0,
      "pageGroupCount": 10,
      "startPage": 1,
      "endPage": 1,
      "startRow": 0,
      "endRow": 20,
      "modNum": 1,
      "listStartNumber": 1
    }
  }
}

Response Format

Attributes
Name	Type	Description
packageId	int	스티커 팩 ID
stickerId	int	스티커 ID
stickerImg	string	스티커 이미지 url
sendCnt	int	사용자가 스티커를 전송한 수

Error Response

Error	Code	Description
non exist apikey	9000	사용된 API 키가 존재하지 않습니다.
server error	1000	서버에서 정보를 받을 수 없습니다.

이 페이지가 도움이 되셨나요?

도움이 필요하신가요? 문의주세요.

Back

Sticker SendRECENTLY SENT STICKERS

My StickersMY STICKER PACKS