개발가이드
- MAU ModelSticker API
개발 가이드
- Basic Guide
- MAU Model
- Sticker API
- Image API
- share Model
- Sticker API
- Image API
- Payment API
- Customer Purchases API
- Refund API
과금 모델 STICKER API
Sticker Search
Sticker Search API is an API that allows you to search sticker content provided by OGQ. Content can be searched with the given keyword.
GET
/v1/stickers
[request]
| 요청타입 | Parameter | Description | Required |
|---|---|---|---|
| Query Param | userId | A unique value that can identify a user within the service. | 0 |
| Query Param | pageSize | The number of sticker elements to be received in one request. The default number is 40, and the maximum number is 100. | X |
| Query Param | page | Page number Page number starts from 0. | X |
| Query Param | keyword | Keyword to use for sticker search If there is no keyword value, a list of popular stickers will be shown as a response. | X |
[Request example]
GET
`https://oapi.ogq.me/v1/stickers`
[ Response Body (data)]
요청이 성공하면 응답 바디에 JSON 객체로 아래 값을 포함합니다.
| 파라미터명 | 타입 | 설명 |
|---|---|---|
| hasNext | boolean | A field to check if there is more content to be searched. If there is more data with the search condition, hasNext returns a value of "true". |
| elements | object | The list of searched sticker elements |
elements
| 파라미터명 | 타입 | 설명 |
|---|---|---|
| contentId | String | Unique ID value of the sticker content |
| title | String | The name of the sticker content |
| description | String | Detailed description of the sticker content |
| mainImageUrl | String | Sticker content representative image URL Sticker content consists of multiple sticker images. The image representing this is the mainImage. |
| tabImageUrl | String | image URL for tabs This image can be used to display a list of sticker elements on a small screen. It can be used in tab lists such as chat input windows. |
| animated | boolean | identification of animated stickers Indicates whether the sticker content is animated content. If true, it is an animated sticker. Animated stickers are in gif format, and regular stickers are in png image format. |
| creator | object | It displays the information of the creator who created the sticker content. |
| items | object | A list of detailed stickers |
creator
| 파라미터명 | 타입 | 설명 |
|---|---|---|
| name | String | Creator's name |
| profileUrl | String | URL of the creator's profile image |
items
| 파라미터명 | 타입 | 설명 |
|---|---|---|
| itemId | number | ID of individual stickers included in the sticker content |
| url | number | URL of individual sticker images |
| feedbacks | object | Object for delivering event information of individual stickers |
feedbacks
| 파라미터명 | 타입 | 설명 |
|---|---|---|
| onUsed | String | URL to call when individual stickers are used |
[Response example]
{
"code": 20000,
"data": {
"hasNext": true,
"elements": [
{
"contentId": "17506ed36343a8a",
"title": "아기자기 솜토끼 아솜",
"description": "새롭게 돌아온 아솜 ! 좀 더 아기자기하고 예뻐졌다 💗 리본색깔이 기분이나 상황에따라 바뀌는 점이 달라졌다",
"mainImageUrl": "https://preview.files.api.ogq.me/STICKER/8a623acd/59ebfdca326a8/main.png?format=o240_240",
"tabImageUrl": "https://preview.files.api.ogq.me/STICKER_TAB/b0a04acd/59ebfdca40a0b/tab.png?format=w97",
"animated": false,
"creator": {
"name": "jrjeon",
"profileUrl": "https://preview.files.api.ogq.me/PROFILE_IMG/854154dc/59605cd451458/OGQ_뉴욕메트로폴리탄박물관_2019-10-29.jpg?format=r240_240"
},
"items": [
{
"itemId": "1",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/d8f439cd/59ebfdc934f8d/1.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=1&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "2",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/758e29cd/59ebfdc92e857/2.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=2&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "3",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/601339cd/59ebfdc933106/3.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=3&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "4",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/1c7239cd/59ebfdc9327c1/4.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=4&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "5",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/e26639cd/59ebfdc93662e/5.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=5&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "6",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/93f879cd/59ebfdc978f39/6.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=6&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "7",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/c24e69cd/59ebfdc96e42c/7.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=7&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "8",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/b0b289cd/59ebfdc982b0b/8.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=8&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "9",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/fb2189cd/59ebfdc9812bf/9.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=9&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "10",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/116379cd/59ebfdc973611/10.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=10&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "11",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/1522c9cd/59ebfdc9c2251/11.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=11&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "12",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/0a24a9cd/59ebfdc9a42a0/12.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=12&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "13",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/1084c9cd/59ebfdc9c4801/13.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=13&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "14",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/3fb7b9cd/59ebfdc9b7bf3/14.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=14&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "15",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/208ec9cd/59ebfdc9ce802/15.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=15&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "16",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/9fdfd9cd/59ebfdc9dfdf9/16.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=16&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "17",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/5dece9cd/59ebfdc9eced5/17.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=17&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "18",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/9f24f9cd/59ebfdc9f42f9/18.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=18&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "19",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/ce04f9cd/59ebfdc9f40ec/19.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=19&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "20",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/2e541acd/59ebfdca145e2/20.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=20&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "21",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/55fe2acd/59ebfdca2ef55/21.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=21&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "22",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/be512acd/59ebfdca215eb/22.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=22&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "23",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/67623acd/59ebfdca32676/23.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=23&userId=12312312&creatorId=572457554cd42"
}
},
{
"itemId": "24",
"url": "https://preview.files.api.ogq.me/STICKER_IMAGE/87c02acd/59ebfdca20c78/24.png?format=o320_320",
"feedbacks": {
"onUsed": "https://oapi.ogq.me/v1/feedbacks?requestId=17684781bbf002a&eventType=featured&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=24&userId=12312312&creatorId=572457554cd42"
}
}
]
}
]
}
}Sticker Search “Favorites”
"Favorites" is a list of stickers that users use frequently. This is an API that helps add the “Favorites”
function and stickers in this list to your service.
GET
/v1/favorite-stickers
[request]
| 요청타입 | Parameter | Description | Required |
|---|---|---|---|
| Query Param | userId | A unique value that can identify a user within the service. | 0 |
| Query Param | pageSize | The number of sticker elements to be received in one request. The default number is 40, and the maximum number is 100. | X |
| Query Param | page | Page number Page number starts from 0. | X |
[Request example]
GET
`https://oapi.ogq.me/v1/favorite-stickers`
[ Response Body (data)]
요청이 성공하면 응답 바디에 JSON 객체로 아래 값을 포함합니다.
| 파라미터명 | 타입 | 설명 |
|---|---|---|
| hasNext | boolean | A field to check if there is more content to be searched. If there is more data with the search condition, hasNext returns a value of "true". |
| elements | object | list of stickers added to "Favorites" |
elements
| 파라미터명 | 타입 | 설명 |
|---|---|---|
| ordering | integer | the display order of sticker content in "Favorites" The higher the number, the higher the priority. |
| sticker | list | stickers you've added to your "Favorites" |
sticker
| 파라미터명 | 타입 | 설명 |
|---|---|---|
| contentId | String | Unique ID value of the sticker content |
| title | String | The name of the sticker content |
| description | String | Detailed description of the sticker content |
| mainImageUrl | String | Sticker content representative image URL Sticker content consists of multiple sticker images. The image representing this is the mainImage. |
| tabImageUrl | String | image URL for tabs This image can be used to display a list of sticker elements on a small screen. It can be used in tab lists such as chat input windows. |
| animated | boolean | identification of animated stickers Indicates whether the sticker content is animated content. If true, it is an animated sticker. Animated stickers are in gif format, and regular stickers are in png image format. |
| creator | object | It displays the information of the creator who created the sticker content. |
| items | object | A list of detailed stickers |
creator
| 파라미터명 | 타입 | 설명 |
|---|---|---|
| name | String | Creator's name |
| profileUrl | String | URL of the creator's profile image |
items
| 파라미터명 | 타입 | 설명 |
|---|---|---|
| itemId | number | ID of individual stickers included in the sticker content |
| url | number | URL of individual sticker images |
| feedbacks | object | Object for delivering event information of individual stickers |
[Response example]
{
"code": 20000,
"data": {
"hasNext": true,
"elements": [
{
"ordering": 0,
"sticker": {
"contentId": "17506ed36343a8a",
"title": "아기자기 솜토끼 아솜",
"description": "새롭게 돌아온 아솜 ! 좀 더 아기자기하고 예뻐졌다 💗 리본색깔이 기분이나 상황에따라 바뀌는 점이 달라졌다",
"mainImageUrl": "https://preview.files.stg.api.ogq.me/STICKER/8a623acd/59ebfdca326a8/main.png?format=o240_240",
"tabImageUrl": "https://preview.files.stg.api.ogq.me/STICKER_TAB/b0a04acd/59ebfdca40a0b/tab.png?format=w97",
"animated": false,
"creator": {
"name": "jrjeon",
"profileUrl": "https://preview.files.stg.api.ogq.me/PROFILE_IMG/854154dc/59605cd451458/OGQ_뉴욕메트로폴리탄박물관_2019-10-29.jpg?format=r240_240"
},
"items": [
{
"itemId": "1",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/d8f439cd/59ebfdc934f8d/1.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=1&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "2",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/758e29cd/59ebfdc92e857/2.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=2&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "3",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/601339cd/59ebfdc933106/3.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=3&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "4",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/1c7239cd/59ebfdc9327c1/4.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=4&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "5",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/e26639cd/59ebfdc93662e/5.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=5&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "6",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/93f879cd/59ebfdc978f39/6.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=6&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "7",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/c24e69cd/59ebfdc96e42c/7.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=7&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "8",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/b0b289cd/59ebfdc982b0b/8.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=8&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "9",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/fb2189cd/59ebfdc9812bf/9.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=9&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "10",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/116379cd/59ebfdc973611/10.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=10&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "11",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/1522c9cd/59ebfdc9c2251/11.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=11&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "12",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/0a24a9cd/59ebfdc9a42a0/12.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=12&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "13",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/1084c9cd/59ebfdc9c4801/13.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=13&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "14",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/3fb7b9cd/59ebfdc9b7bf3/14.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=14&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "15",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/208ec9cd/59ebfdc9ce802/15.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=15&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "16",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/9fdfd9cd/59ebfdc9dfdf9/16.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=16&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "17",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/5dece9cd/59ebfdc9eced5/17.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=17&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "18",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/9f24f9cd/59ebfdc9f42f9/18.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=18&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "19",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/ce04f9cd/59ebfdc9f40ec/19.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=19&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "20",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/2e541acd/59ebfdca145e2/20.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=20&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "21",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/55fe2acd/59ebfdca2ef55/21.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=21&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "22",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/be512acd/59ebfdca215eb/22.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=22&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "23",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/67623acd/59ebfdca32676/23.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=23&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "24",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/87c02acd/59ebfdca20c78/24.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=24&userId=123123121231&creatorId=572457554cd42"
}
}
]
}
}
]
}
}Sticker Add the feature of "Favorites"
Add your favorite stickers.
POST
/v1/favorite-stickers
[request]
| 요청타입 | Parameter | Description | Required |
|---|---|---|---|
| Query Param | userId | A unique value that can identify a user within the service. | 0 |
| Body | contentIds | List of sticker IDs to add to "Favorites" | 0 |
[Request example]
POST
`https://oapi.ogq.me/v1/favorite-stickers`
{
"contentIds": [
"17506d5fe220111",
"17506d5fe220111",
"17506d5fe220111"
]
}Sticker change the order in "Favorites"
Users can change the order of stickers in "Favorites".
This is an API for the change of the order in "Favorites".
PUT
/v1/favorite-stickers
[request]
| 요청타입 | Parameter | Description | Required |
|---|---|---|---|
| Query Param | userId | A unique value that can identify a user within the service. | 0 |
| Body | favoriteItems | An item list of favorite sticker sets | 0 |
favoriteItems
| 요청타입 | Parameter | Description | Required |
|---|---|---|---|
| Body | contentId | The sticker ID you added to "Favorites" | X |
| Body | ordering | order of stickers in ”Favorite" | X |
[Request example]
PUT
`https://oapi.ogq.me/v1/favorite-stickers`
{
"favoriteItems": [
{
"contentId": "17506d5fe220111",
"ordering": 3
},
{
"contentId": "17506d5fe2201232",
"ordering": 4
}
]
}Delete "Favorite Stickers"
This is an API for the deletion of sticker elements from "Favorites"
DELETE
/v1/favorite-stickers/{contentId}
[request]
| 요청타입 | Parameter | Description | Required |
|---|---|---|---|
| Query Param | userId | A unique value that can identify a user within the service. | 0 |
| path | contentId | ContentId to delete from sticker favorites | 0 |
[Request example]
DELETE
`https://oapi.ogq.me/v1/favorite-stickers/{contentId}`
Search "Recent Stickers"
“Recent Stickers" is a list of the most recently used stickers by the user.
Calling the onUsed URL in the Feedback API will add the user's recently used sticker to this list.
This is an API that provides a list of recently used stickers.
GET
/v1/recent-stickers
[request]
| 요청타입 | Parameter | Description | Required |
|---|---|---|---|
| Query Param | userId | A unique value that can identify a user within the service. | 0 |
| Query Param | pageSize | The number of sticker elements to be received in one request. The default number is 40, and the maximum number is 100. | X |
| Query Param | page | Page number Page number starts from 0. | X |
[Request example]
GET
`https://oapi.ogq.me/v1/recent-stickers`
[ Response Body (data)]
요청이 성공하면 응답 바디에 JSON 객체로 아래 값을 포함합니다.
| 파라미터명 | 타입 | 설명 |
|---|---|---|
| elements | object | list of recently used stickers |
elements
| 파라미터명 | 타입 | 설명 |
|---|---|---|
| recentId | String | ID recently used |
| usedItemId | String | The Item Id of the sticker used among the sticker elements |
| sticker | list | sticker used recently |
sticker
| 파라미터명 | 타입 | 설명 |
|---|---|---|
| contentId | String | Unique ID value of the sticker content |
| title | String | The name of the sticker content |
| description | String | Detailed description of the sticker content |
| mainImageUrl | String | Sticker content representative image URL Sticker content consists of multiple sticker images. The image representing this is the mainImage. |
| tabImageUrl | String | image URL for tabs This image can be used to display a list of sticker elements on a small screen. It can be used in tab lists such as chat input windows. |
| animated | boolean | identification of animated stickers Indicates whether the sticker content is animated content. If true, it is an animated sticker. Animated stickers are in gif format, and regular stickers are in png image format. |
| creator | object | It displays the information of the creator who created the sticker content. |
| items | object | A list of detailed stickers |
creator
| 파라미터명 | 타입 | 설명 |
|---|---|---|
| name | String | Creator's name |
| profileUrl | String | URL of the creator's profile image |
items
| 파라미터명 | 타입 | 설명 |
|---|---|---|
| itemId | number | ID of individual stickers included in the sticker content |
| url | number | URL of individual sticker images |
| feedbacks | object | Object for delivering event information of individual stickers |
[Response example]
{
"code": 20000,
"data": {
"elements": [
{
"recentId": 0,
"usedItemId": "1",
"sticker": {
"contentId": "17506ed36343a8a",
"title": "아기자기 솜토끼 아솜",
"description": "새롭게 돌아온 아솜 ! 좀 더 아기자기하고 예뻐졌다 💗 리본색깔이 기분이나 상황에따라 바뀌는 점이 달라졌다",
"mainImageUrl": "https://preview.files.stg.api.ogq.me/STICKER/8a623acd/59ebfdca326a8/main.png?format=o240_240",
"tabImageUrl": "https://preview.files.stg.api.ogq.me/STICKER_TAB/b0a04acd/59ebfdca40a0b/tab.png?format=w97",
"animated": false,
"creator": {
"name": "jrjeon",
"profileUrl": "https://preview.files.stg.api.ogq.me/PROFILE_IMG/854154dc/59605cd451458/OGQ_뉴욕메트로폴리탄박물관_2019-10-29.jpg?format=r240_240"
},
"items": [
{
"itemId": "1",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/d8f439cd/59ebfdc934f8d/1.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=1&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "2",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/758e29cd/59ebfdc92e857/2.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=2&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "3",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/601339cd/59ebfdc933106/3.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=3&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "4",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/1c7239cd/59ebfdc9327c1/4.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=4&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "5",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/e26639cd/59ebfdc93662e/5.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=5&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "6",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/93f879cd/59ebfdc978f39/6.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=6&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "7",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/c24e69cd/59ebfdc96e42c/7.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=7&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "8",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/b0b289cd/59ebfdc982b0b/8.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=8&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "9",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/fb2189cd/59ebfdc9812bf/9.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=9&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "10",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/116379cd/59ebfdc973611/10.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=10&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "11",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/1522c9cd/59ebfdc9c2251/11.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=11&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "12",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/0a24a9cd/59ebfdc9a42a0/12.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=12&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "13",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/1084c9cd/59ebfdc9c4801/13.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=13&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "14",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/3fb7b9cd/59ebfdc9b7bf3/14.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=14&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "15",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/208ec9cd/59ebfdc9ce802/15.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=15&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "16",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/9fdfd9cd/59ebfdc9dfdf9/16.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=16&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "17",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/5dece9cd/59ebfdc9eced5/17.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=17&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "18",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/9f24f9cd/59ebfdc9f42f9/18.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=18&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "19",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/ce04f9cd/59ebfdc9f40ec/19.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=19&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "20",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/2e541acd/59ebfdca145e2/20.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=20&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "21",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/55fe2acd/59ebfdca2ef55/21.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=21&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "22",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/be512acd/59ebfdca215eb/22.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=22&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "23",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/67623acd/59ebfdca32676/23.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=23&userId=123123121231&creatorId=572457554cd42"
}
},
{
"itemId": "24",
"url": "https://preview.files.stg.api.ogq.me/STICKER_IMAGE/87c02acd/59ebfdca20c78/24.png?format=o320_320",
"feedbacks": {
"onUsed": "https://stg.oapi.ogq.me/v1/feedbacks?requestId=1768561ff1c001e&eventType=favorite&actionType=onUsed&contentType=STICKER&contentId=17506ed36343a8a&itemId=24&userId=123123121231&creatorId=572457554cd42"
}
}
]
}
}
]
}
}Delete "Recent Stickers"
Delete the sticker in the "Recent Stickers" list
DELETE
/v1/favorite-stickers/{recentId}
[request]
| 요청타입 | Parameter | Description | Required |
|---|---|---|---|
| Query Param | userId | A unique value that can identify a user within the service. | 0 |
| path | recentId | Id to delete from most recent usage sticker | 0 |
[Request example]
DELETE
`https://oapi.ogq.me/v1/favorite-stickers/{recentId}`
Feedback API
This is an API that enables the server to use and access sticker contents. You can call the URL in "sticker.items.feedbacks.onUsed" in the sticker response results.
GET
/v1/feedbacks
[Request example]
GET
`https://oapi.ogq.me/v1/feedbacks`
Copyright ©2020 by OGQ Corp. All rights reserved
대표이사 신철호 | 이메일 support@ogq.me
서울특별시 강남구 논현로 164 10층 (도곡동, 튼튼영어빌딩)
사업자 등록번호 220-86-76113
통신판매업신고번호 제2018-서울강남-03954호
문의전화 070-7403-6158
서울특별시 강남구 논현로 164 10층 (도곡동, 튼튼영어빌딩)
사업자 등록번호 220-86-76113
통신판매업신고번호 제2018-서울강남-03954호
문의전화 070-7403-6158