Stipop Javascript SDK

Quick guide to Stipop Javascript SDK Link to Docs

Installation

stipop-js-sdk can be installed on Linux, Mac OS or Windows without any issues.

npm install --save stipop-js-sdk 

Getting API key

To use the Javascript SDK you need your api key.

You can get the api key by signing up and creating an application in Stipop Dashboard.

Get started

es5

const Stipop = require('stipop-js-sdk');
const client = new Stipop(`${YOUR_API_KEY}`, 'v1');

es6

import Stipop from 'stipop-js-sdk';
const client = new Stipop(`${YOUR_API_KEY}`, 'v1');

List of features

| Method | Return Type | | ----------------------------------------------------------------- | ------------------- | | getPack() | Promise<Object> | | getPackInfo() | Promise<Object> | | getPackRecent() | Promise<Object> | | getPackSendSticker() | Promise<Object> | | getPackFrequentlySticker() | Promise<Object> | | getCuration() | Promise<Object> | | getSearch() | Promise<Object> | | getKeyword() | Promise<Object> | | getKeywordRecent() | Promise<Object> | | deleteKeywordAll() | Promise<Object> | | deleteKeyword() | Promise<Object> | | downloadPack() | Promise<Object> | | downloadList() | Promise<Object> | | init() | Promise<Object> | | mysticker() | Promise<Object> | | mystickerHideList() | Promise<Object> | | mystickerHide() | Promise<Object> | | myStickerOrder() | Promise<Object> | | myStickerFavoriteList() | Promise<Object> | | myStickerFavorite() | Promise<Object> |

getPack()

get the trending Package List

Params

| Name | Description | Type | Required | | --------------| ----------------------| --------------| ------------------| | userId | Unique 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. |String | true | | lang | Specify default language for regional stickers. Use a 2-letter ISO 639-1 language code. Default Value: en | String | false | | countryCode | Specify default country for local stickers. Use a 2-letter ISO 3166-1 country code. Default Value: US | String | false | | animated | Y: Look for animated stickers only N: Look for static(still) stickers only Empty parameter:Look for all stickers|String|false| | pageNumber | Specify pageNumber to show limit number of stickers per page. | Integer | false | | limit | The maximum number of stickers per page. Use pageNumber accordingly for optimized sticker view. Default Value: 20 (max: 50) | Integer | false |

Examples

const params = {
    userId: '9937',
    lang: en,
    countryCode: US,
    pageNumber:1,
    limit:10
}

const data = await client.getPack(params);

Response Format

{
    "header": {
      "code": "0000",
      "status": "success",
      "message": "success"
    },
    "body": {
        "packageList": [
        {
            "packageId": 2309,                          
            "packageName": "cada día",                    
            "packageImg": "https://img....70AAeHBn4N.png", 
            "packageCategory": "Animation/Cartoon,Gag", 
            "packageKeywords": "bonito,mono,bello,adorable,life,cute,lovely", 
            "packageAnimated": "N",                       
            "isNew": "N",                               
            "artistName": "pinono",                     
            "language": "Spanish",                         
            "isDownload": "Y",                             
                "isWish": "N"					
        },
        {
            "packageId": 2473,
            "packageName": "¿Cómo estás?",
            "packageImg": "https://img.....Ggdu7s3J15.gif",
            "packageCategory": "Phrases,Etc.",
            "packageKeywords": "¿Cómoestás?,letra",
            "packageAnimated": "Y",
            "isNew": "N",
            "artistName": "annapig",
            "language": "Spanish",
                "isDownload": "Y",                             
                "isWish": "N"					 
        },
        ......
        ],
        "pageMap": {
          "pageNumber": 1,
          "onePageCountRow": 10,
          "totalCount": 2953,
          "pageCount": 296,
          "groupCount": 30,
          "groupNumber": 0,
          "pageGroupCount": 10,
          "startPage": 1,
          "endPage": 10,
          "startRow": 0,
          "endRow": 10,
          "modNum": 3,
          "listStartNumber": 2953
        }
    }
}

| Attribute Name | Type | Description | | -------------- | ---- | ----------- | |packageId |string| Sticker package ID | |packageName |int |Sticker package name | |packageImg |string| Main image of sticker package | |packageCategory|int |Sticker package category | |packageKeywords|string| Sticker package keyword | |packageAnimated|int |Is sticker animated (Y/N) | |price |string| Price of sticker pack: [Free] [$0.99] [$1.99]| |isNew |string| Is sticker new (Y/N) | |artistName |int |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) |

getPackInfo

The Sticker Pack Info API contains all the sticker images and package information you need to display a sticker pack page.

Params

| Name | Description | Type | Required | | --------------| ----------------------| --------------| ------------------| | packId | The [packId] of a sticker pack, NOT stickerId.Example: 6363, 5636, 5859 | string | true| | userId | Unique 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. |String | true |

Examples

const params = {
    userId: '9937',
    packId: 118
}

const data = await client.getPackInfo(params);

Response Format

{
  "header": {
      "code": "0000",
      "status": "success",
      "message": "success"
  },
  "body": {
      "package": {
        "packageId": 118,                      
        "artistName": "MightyCat",            
        "packageName": "Stuart",                
        "packageImg": "https://img....png",   
        "packageAnimated": "N",                
        "packageCategory": "Animation/Cartoon", 
        "packageKeywords": "Stuart,Sticker",    
        "isNew": "N",                           
        "language": "English",                  
        "isDownload": "Y",                            
        "isWish": "N",					
        "stickers": [                          
            {
                "stickerId": 790,              
                "packageId": 118,               
                "stickerImg": "https://img...._5_2.png" 
            },
            {
                "stickerId": 791,
                "packageId": 118,
                "stickerImg": "https://img....._6_1.png"
            }
            ......
        ]
    }
  }
}

| Attribute Name | Type | Description | | -------------- | ---- | ----------- | |packageId |string |Sticker package ID | |packageName |int |Sticker package name | |packageImg |string |Main image of sticker package | |packageCategory|int |Sticker package category | |packageKeywords|string |Sticker package keyword | |packageAnimated|int |Is sticker animated (Y/N) | |isNew |string |Is sticker new (Y/N) | |artistName |int |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) | |stickers |string |List of stickers within the sticker package| |stickerId |string |Sticker ID | |stickerImg |string |Sticker image url |

getPackRecent()

The Recently Viewed Packs API gives the list of sticker packs a user has viewed recently

Params

| Name | Description | Type | Required | | --------------| ----------------------| --------------| ------------------| | userId | Unique 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. |String | true | | pageNumber | Specify pageNumber to show limit number of stickers per page. | Integer | false | | limit | The maximum number of stickers per page. Use pageNumber accordingly for optimized sticker view. Default Value: 20 (max: 50) | Integer | false |

Examples

const params = {
    userId: '9937',
    pageNumber:1,
    limit:20
}

const data = await client.getPackRecent(params);

Response Format

{
    "header": {
      "code": "0000",
      "status": "success",
      "message": "success"
    },
    "body": {
        "packageList": [
        {
            "packageId": 2309,                          
            "packageName": "cada día",                    
            "packageImg": "https://img....70AAeHBn4N.png", 
            "packageCategory": "Animation/Cartoon,Gag", 
            "packageKeywords": "bonito,mono,bello,adorable,life,cute,lovely", 
            "packageAnimated": "N",                       
            "isNew": "N",                               
            "artistName": "pinono",                     
            "language": "Spanish",                         
            "isDownload": "Y",                             
                "isWish": "N"					
        },
        {
            "packageId": 2473,
            "packageName": "¿Cómo estás?",
            "packageImg": "https://img.....Ggdu7s3J15.gif",
            "packageCategory": "Phrases,Etc.",
            "packageKeywords": "¿Cómoestás?,letra",
            "packageAnimated": "Y",
            "isNew": "N",
            "artistName": "annapig",
            "language": "Spanish",
                "isDownload": "Y",                             
                "isWish": "N"					 
        },
        ......
        ],
        "pageMap": {
          "pageNumber": 1,
          "onePageCountRow": 10,
          "totalCount": 2953,
          "pageCount": 296,
          "groupCount": 30,
          "groupNumber": 0,
          "pageGroupCount": 10,
          "startPage": 1,
          "endPage": 10,
          "startRow": 0,
          "endRow": 10,
          "modNum": 3,
          "listStartNumber": 2953
        }
    }
}

| Attribute Name | Type | Description | | -------------- | ---- | ----------- | |packageId |string| Sticker package ID | |packageName |int |Sticker package name | |packageImg |string| Main image of sticker package | |packageCategory|int |Sticker package category | |packageKeywords|string| Sticker package keyword | |packageAnimated|int |Is sticker animated (Y/N) | |price |string| Price of sticker pack: [Free] [$0.99] [$1.99]| |isNew |string| Is sticker new (Y/N) | |artistName |int |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) |

getPackSendSticker()

The Recently Sent Stickers API gives the list of stickers which a user has sent in recent order

Params

| Name | Description | Type | Required | | --------------| ----------------------| --------------| ------------------| | userId | Unique 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. |String | true | | pageNumber | Specify pageNumber to show limit number of stickers per page. | Integer | false | | limit | The maximum number of stickers per page. Use pageNumber accordingly for optimized sticker view. Default Value: 20 (max: 50) | Integer | false |

Examples

const params = {
    userId: '9937',
    pageNumber:1,
    limit:20
}

const data = await client.getPackSendSticker(params);

Response Format

{
  "header": {
      "code": "0000",
      "status": "success",
      "message": "success"
  },
  "body": {
  	"stickerList": [
        {
            "stickerId": 3684,					
            "packageId": 347,						
            "stickerImg": "https://img.....l_08.png"	
        },
        {
            "stickerId": 3683,
            "packageId": 347,
            "stickerImg": "https://img...._07.png"
        }
    ],
    "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
    }
  }
}

| Attribute Name | Type | Description | | -------------- | ---- | ----------- | |packageId |string |Sticker package ID | |stickerId |string |Sticker ID | |stickerImg |string |Sticker image url |

getPackFrequentlySticker()

The Frequently Sent Stickers API gives the list of stickers which a user has used most frequently on any chat interface.

Params

| Name | Description | Type | Required | | --------------| ----------------------| --------------| ------------------| | userId | Unique 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. |String | true | | pageNumber | Specify pageNumber to show limit number of stickers per page. | Integer | false | | limit | The maximum number of stickers per page. Use pageNumber accordingly for optimized sticker view. Default Value: 20 (max: 50) | Integer | false |

Examples

const params = {
    userId: '9937',
    pageNumber:1,
    limit:20
}

const data = await client.getPackFrequentlySticker(params);

Response Format

{
  "header": {
      "code": "0000",
      "status": "success",
      "message": "success"
  },
  "body": {
  	"stickerList": [
        {
            "stickerId": 3684,					
            "packageId": 347,						
            "stickerImg": "https://img.....l_08.png"	
        },
        {
            "stickerId": 3683,
            "packageId": 347,
            "stickerImg": "https://img...._07.png"
        }
    ],
    "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
    }
  }
}

| Attribute Name | Type | Description | | -------------- | ---- | ----------- | |packageId |string |Sticker package ID | |stickerId |string |Sticker ID | |stickerImg |string |Sticker image url |

getCuration()

Get list of curation stickers

Params

| Name | Description | Type | Required | | --------------| ----------------------| --------------| ------------------| | type | A : weekly stickers B: 배너| string | true | | userId | Unique 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. |String | true | | lang | Specify default language for regional stickers. Use a 2-letter ISO 639-1 language code. Default Value: en | String | true | | countryCode | Specify default country for local stickers. Use a 2-letter ISO 3166-1 country code. Default Value: US | String | true | | pageNumber | Specify pageNumber to show limit number of stickers per page. | Integer | false | | limit | The maximum number of stickers per page. Use pageNumber accordingly for optimized sticker view. Default Value: 20 (max: 50) | Integer | false |

Examples

const params = {
    type: 'A',
    userId: '9937',
    lang: 'en',
    countryCode: 'US'
    pageNumber:1,
    limit:20
}

const data = await client.getCuration(params);

Response Format

{
  "header": { "code": "0000", "status": "success", "message": "success" },
  "body": {
    "card": {
      "cardId": 2,
      "title": "Today’s Sticker",
      "type": "B",
      "imgUrl": null,
      "language": "en",
      "country": "us",
      "packageList": [{
        "packageId": 8036,
        "packageName": null,
        "artistName": null,
        "packageImg": null,
        "stickerImg": null,
        "cardImgUrl": "https://img...mLAVMWt.png",
        "lightBackgroundCode": "#EAFDA9",
        "darkBackgroundCode": "#F1FFC2",
        "isDownload": "N",
        "stickers": null
      },
      ....
      ]
    }
  }
}

| Attribute Name | Type | Description | | -------------- | ---- | ----------- | | cardId | Integer | | | title | string | | | type | string | | | imgUrl | string | | | language | string | | | country | string | | | packageList| array | |

getSearch()

The Sticker Search API let's users search for stickers with search tags

Params

| Name | Description | Type | Required | | --------------| ----------------------| --------------| ------------------| | q | Search tag term or phrase. Supports 40+ languages. | string | true | | userId | Unique 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. |String | true | | lang | Specify default language for regional stickers. Use a 2-letter ISO 639-1 language code. Default Value: en | String | true | | countryCode | Specify default country for local stickers. Use a 2-letter ISO 3166-1 country code. Default Value: US | String | true | | pageNumber | Specify pageNumber to show limit number of stickers per page. | Integer | false | | limit | The maximum number of stickers per page. Use pageNumber accordingly for optimized sticker view. Default Value: 20 (max: 50) | Integer | false |

Examples

const params = {
    userId: '9937',
    q: 'cute',
    lang: 'en',
    pageNumber:1,
    limit:20
}

const data = await client.getSearch(params);

Response Format

{
  {
    "header": {
      "code": "0000",
      "status": "success",
      "message": "success"
    },
    "body": {
      "stickerList": [
        {
          "stickerId": 51229,
          "keyword": "cute",
          "stickerImg": "https://img....70AAeHBn4N.png"
        },
        {
          "stickerId": 50899,
          "keyword": "cute",
          "stickerImg": "https://img....70AAeHBn4N.png"
        },
        {
          "stickerId": 50898,
          "keyword": "cute",
          "stickerImg": "https://img....70AAeHBn4N.png"
        },
        ................
      ],
      "pageMap": {
        "pageNumber": 1,
        "onePageCountRow": 10,
        "totalCount": 80,
        "pageCount": 8,
        "groupCount": 1,
        "groupNumber": 0,
        "pageGroupCount": 10,
        "startPage": 1,
        "endPage": 8,
        "startRow": 0,
        "endRow": 10,
        "modNum": 10,
        "listStartNumber": 80
      }
    }
}

| Attribute Name | Type | Description | | -------------- | ---- | ----------- | |stickerId |string| Sticker ID | |keyword |string| Search tag | |packageName |Integer | Sticker package name| |stickerImg |string| Sticker image url|

getKeyword()

Use the Trending Search Terms API to show search tag suggestions based on trendy searches made by users.

Params

| Name | Description | Type | Required | | --------------| ----------------------| --------------| ------------------| | userId | Unique 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. |String | true | | lang | Specify default language for regional stickers. Use a 2-letter ISO 639-1 language code. Default Value: en | String | false | | countryCode | Specify default country for local stickers. Use a 2-letter ISO 3166-1 country code. Default Value: US | String | false |

Examples

const params = {
    userId: '9937',
    lang: 'en',
    countryCode: 'US'
}

const data = await client.getKeyword(params);

Response Format

{
  {
    "header": {
      "code": "0000",
      "status": "success",
      "message": "success"
    },
    "body": {
      "keywordList": [
      {
        "keyword": "hi"
      },
      {
        "keyword": "hello"
      },
      {
        "keyword": "thanks"
      }
    ]
    }
}

| Attribute Name | Type | Description | | -------------- | ---- | ----------- | |keyword |string| Search tag |

getKeywordRecent()

The Recent Search API shows a list of recent search tags made by a user.

Params

| Name | Description | Type | Required | | --------------| ----------------------| --------------| ------------------| | userId | Unique 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. |String | true |

Examples

const params = {
    userId: '9937'
}

const data = await client.getKeywordRecent(params);

Response Format

{
  {
    "header": {
      "code": "0000",
      "status": "success",
      "message": "success"
    },
    "body": {
      "keywordList": [
      {
        "keyword": "hi"
      },
      {
        "keyword": "hello"
      },
      {
        "keyword": "thanks"
      }
    ]
    }
}

| Attribute Name | Type | Description | | -------------- | ---- | ----------- | |keyword |string| Search tag |

deleteKeywordAll()

Delete all keywords

Params

| Name | Description | Type | Required | | --------------| ----------------------| --------------| ------------------| | userId | Unique 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. |String | true |

Examples

const params = {
    userId: '9937'
}

const data = await client.deleteKeywordAll(params);

Response Format

{
  "header": {
    "code": "0000",
    "status": "success",
    "message": "success"
  },
  "body": []
}

deleteKeyword()

Delete individual keywords

Params

| Name | Description | Type | Required | | --------------| ----------------------| --------------| ------------------| | userId | Unique 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. |String | true | | keyword | Keyword you'd like to delete | String | true |

Examples

const params = {
    userId: '9937',
    keyword: 'cute'
}

const data = await client.deleteKeyword(params);

Response Format

{
  "header": {
    "code": "0000",
    "status": "success",
    "message": "success"
  },
  "body": []
}

downloadPack()

The Recent Search API shows a list of recent search tags made by a user.

Params

| Name | Description | Type | Required | | --------------| ----------------------| --------------| ------------------| | packageId | The [packageId] of a sticker pack, NOT stickerId.Example: 6363, 5636, 5859 | string | true| | userId | Unique 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. |String | true | | isPurchase | Free Sticker Store: Set isPurchase as N. Paid Sticker Store: Set isPurchase as Y.Sticker Subscription: Set isPurchase as S.| String| false| | price | If isPurchase is Y, the default price is set for stickers. Default Price: Still Stickers [$0.99], Animated Stickers [$1.99]| String | false | | lang | Specify default language for regional stickers. Use a 2-letter ISO 639-1 language code. Default Value: en | String | false | | countryCode | Specify default country for local stickers. Use a 2-letter ISO 3166-1 country code. Default Value: US | String | false |

Examples

const params = {
    packageId: 118,
    userId: '9937'
}

const data = await client.downloadPack(params);

Response Format

{
  {
    "header": {
      "code": "0000",
      "status": "success",
      "message": "success"
    },
    "body": []
    }
}

downloadList()

List of sticker packs downloaded

Params

| Name | Description | Type | Required | | --------------| ----------------------| --------------| ------------------| | userId | Unique 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. |String | true | | pageNumber | Specify pageNumber to show limit number of stickers per page. | Integer | false | | limit | The maximum number of stickers per page. Use pageNumber accordingly for optimized sticker view. Default Value: 20 (max: 50) | Integer | false |

Examples

const params = {
    userId: '9937',
    pageNumber: 1,
    limit: 10
}

const data = await client.downloadList(params);

Response Format

{
  {
    "header": {
      "code": "0000",
      "status": "success",
      "message": "success"
    },
    "body": {
        "packageList": [
        {
            "packageId": 2309,                          
            "packageName": "cada día",                    
            "packageImg": "https://img....70AAeHBn4N.png", 
            "packageCategory": "Animation/Cartoon,Gag", 
            "packageKeywords": "bonito,mono,bello,adorable,life,cute,lovely", 
            "packageAnimated": "N",                       
            "isNew": "N",                               
            "artistName": "pinono",                     
            "language": "Spanish",                         
            "isDownload": "Y",                             
            "isWish": "N"					
        },
        {
            "packageId": 2473,
            "packageName": "¿Cómo estás?",
            "packageImg": "https://img.....Ggdu7s3J15.gif",
            "packageCategory": "Phrases,Etc.",
            "packageKeywords": "¿Cómoestás?,letra",
            "packageAnimated": "Y",
            "isNew": "N",
            "artistName": "annapig",
            "language": "Spanish",
            "isDownload": "Y",                             
             "isWish": "N"					 
        },
        ......
        ],
        "pageMap": {
          "pageNumber": 1,
          "onePageCountRow": 10,
          "totalCount": 2953,
          "pageCount": 296,
          "groupCount": 30,
          "groupNumber": 0,
          "pageGroupCount": 10,
          "startPage": 1,
          "endPage": 10,
          "startRow": 0,
          "endRow": 10,
          "modNum": 3,
          "listStartNumber": 2953
        }
    }
}

| Attribute Name | Type | Description | | -------------- | ---- | ----------- | |packageId |string| Sticker package ID | |packageName |int |Sticker package name | |packageImg |string| Main image of sticker package | |packageCategory|int |Sticker package category | |packageKeywords|string| Sticker package keyword | |packageAnimated|int |Is sticker animated (Y/N) | |isNew |string| Is sticker new (Y/N) | |artistName |int |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) |

init()

Add default stickers for users

Params

| Name | Description | Type | Required | | --------------| ----------------------| --------------| ------------------| | userId | Unique 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. |String | true | | lang | Specify default language for regional stickers. Use a 2-letter ISO 639-1 language code. Default Value: en | String | false |

Examples

const params = {
    userId: '9937',
    lang: 'en'
}

const data = await client.init(params);

Response Format

{
  "header": {
    "code": "0000",
    "status": "success",
    "message": "success"
  },
  "body": []
}

mysticker()

The My Sticker Packs API gives the list of stickers which a user has downloaded or purchased.

Params

| Name | Description | Type | Required | | --------------| ----------------------| --------------| ------------------| | userId | Unique 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. |String | true | | pageNumber | Specify pageNumber to show limit number of stickers per page. | Integer | false | | limit | The maximum number of stickers per page. Use pageNumber accordingly for optimized sticker view. Default Value: 20 (max: 50) | Integer | false |

Examples

const params = {
    userId: '9937',
    pageNumber: 1,
    limit : 10
}

const data = await client.mysticker(params);

Response Format

{
  "header": {
    "code": "0000",
    "status": "success",
    "message": "success"
  },
  "body": {
    packageList: [
      "packageList": [
        {
            "packageId": 2309,                          
            "packageName": "cada día",                    
            "packageImg": "https://img....70AAeHBn4N.png", 
            "packageCategory": "Animation/Cartoon,Gag", 
            "packageKeywords": "bonito,mono,bello,adorable,life,cute,lovely", 
            "packageAnimated": "N",
            "order": 7,
            "isNew": "N",                               
            "artistName": "pinono",                     
            "language": "Spanish",                         
            "isDownload": "Y",                             
            "isWish": "N"					
        },
        {
            "packageId": 2473,
            "packageName": "¿Cómo estás?",
            "packageImg": "https://img.....Ggdu7s3J15.gif",
            "packageCategory": "Phrases,Etc.",
            "packageKeywords": "¿Cómoestás?,letra",
            "packageAnimated": "Y",
            "order": 8,
            "isNew": "N",
            "artistName": "annapig",
            "language": "Spanish",
            "isDownload": "Y",                             
             "isWish": "N"					 
        },
     ]
    "pageMap": {
      "pageNumber": 1,
      "onePageCountRow": 20,
      "totalCount": 2,
      "pageCount": 1,
      "groupCount": 1,
      "groupNumber": 0,
      "pageGroupCount": 10,
      "startPage": 1,
      "endPage": 1,
      "startRow": 0,
      "endRow": 20,
      "modNum": 2,
      "listStartNumber": 2
    }
  }
}

| Attribute Name | Type | Description | | -------------- | ---- | ----------- | |packageId |string| Sticker package ID | |packageName |int |Sticker package name | |packageImg |string| Main image of sticker package | |packageCategory|int |Sticker package category | |packageKeywords|string| Sticker package keyword | |packageAnimated|int |Is sticker animated (Y/N) | |order|int | 순서 | |isNew |string| Is sticker new (Y/N) | |artistName |int |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) |

mystickerHideList()

The Hidden Sticker Packs API gives the list of sticker packs which a user has hidden (or deleted in case of free sticker packs) from the user’s my stickers list using the Hide/Recover My Pack API.

| Name | Description | Type | Required | | --------------| ----------------------| --------------| ------------------| | userId | Unique 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. |String | true | | pageNumber | Specify pageNumber to show limit number of stickers per page. | Integer | false | | limit | The maximum number of stickers per page. Use pageNumber accordingly for optimized sticker view. Default Value: 20 (max: 50) | Integer | false |

Examples

const params = {
    userId: '9937',
    pageNumber: 1,
    limit : 10
}

const data = await client.mystickerHideList(params);

Response Format

{
  "header": {
    "code": "0000",
    "status": "success",
    "message": "success"
  },
  "body": {
    packageList: [
      "packageList": [
        {
            "packageId": 2309,                          
            "packageName": "cada día",                    
            "packageImg": "https://img....70AAeHBn4N.png", 
            "packageCategory": "Animation/Cartoon,Gag", 
            "packageKeywords": "bonito,mono,bello,adorable,life,cute,lovely", 
            "packageAnimated": "N",                       
            "isNew": "N",                               
            "artistName": "pinono",                     
            "language": "Spanish",                         
            "isDownload": "Y",                             
            "isWish": "N"					
        },
        {
            "packageId": 2473,
            "packageName": "¿Cómo estás?",
            "packageImg": "https://img.....Ggdu7s3J15.gif",
            "packageCategory": "Phrases,Etc.",
            "packageKeywords": "¿Cómoestás?,letra",
            "packageAnimated": "Y",
            "isNew": "N",
            "artistName": "annapig",
            "language": "Spanish",
            "isDownload": "Y",                             
            "isWish": "N"					 
        },
     ]
    "pageMap": {
      "pageNumber": 1,
      "onePageCountRow": 20,
      "totalCount": 2,
      "pageCount": 1,
      "groupCount": 1,
      "groupNumber": 0,
      "pageGroupCount": 10,
      "startPage": 1,
      "endPage": 1,
      "startRow": 0,
      "endRow": 20,
      "modNum": 2,
      "listStartNumber": 2
    }
  }
}

| Attribute Name | Type | Description | | -------------- | ---- | ----------- | |packageId |string| Sticker package ID | |packageName |int |Sticker package name | |packageImg |string| Main image of sticker package | |packageCategory|int |Sticker package category | |packageKeywords|string| Sticker package keyword | |packageAnimated|int |Is sticker animated (Y/N) | |isNew |string| Is sticker new (Y/N) | |artistName |int |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) |

mystickerHide()

The Hide/Recover My Sticker Pack API allows for the user to hide or recover any sticker packages from the user’s my sticker list.

Params

| Name | Description | Type | Required | | --------------| ----------------------| --------------| ------------------| | userId | Unique 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. |String | true | | packageId | The [packageId] of a sticker pack, NOT stickerId.Example: 6363, 5636, 5859 | string | true|

Examples

const params = {
    userId: '9937',
    packageId: '118'
}

const data = await client.mystickerHide(params);

Response Format

{
  "header": {
    "code": "0000",
    "status": "success",
    "message": "success"
  },
  "body": []
}

myStickerOrder()

Change order of my sticker packs

Params

| Name | Description | Type | Required | | --------------| ----------------------| --------------| ------------------| | userId | Unique 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. |String | true | | currentOrder | Current order of a sticker pack | Integer | true| | newOrder | New order of a sticker pack | Integer | true|

Examples

const params = {
    userId: '9937',
    currentOrder: 7,
    newOrder: 5
}

const data = await client.mystickerHide(params);

Response Format

{
  "header": {
    "code": "0000",
    "status": "success",
    "message": "success"
  },
  "body": []
}

myStickerFavoriteList()

List of my favorite stickers

Params

| Name | Description | Type | Required | | --------------| ----------------------| --------------| ------------------| | userId | Unique 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. |String | true |

Examples

const params = {
    userId: '9937'
}

const data = await client.myStickerFavoriteList(params);

Response Format

{
  "header": {
    "code": "0000",
    "status": "success",
    "message": "success"
  },
  "body": {
    "favoriteList": [
      {
        "stickerId": 790,
        "stickerImg": "https://img.....png",
        "favoriteYN": "Y"
      },
      .....
    ]
  }
}

myStickerFavorite()

Selecting my favorite stickers

Params

| Name | Description | Type | Required | | --------------| ----------------------| --------------| ------------------| | userId | Unique 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. |String | true | | stickerId | Sticker ID | string | true|

Examples

const params = {
    userId: '9937',
    stickerId: 790
}

const data = await client.myStickerFavorite(params);

Response Format

{
  "header": {
    "code": "0000",
    "status": "success",
    "message": "success"
  },
  "body": []
}