Emoji&Sticker相关使用文档(v1.0.4)

Emoji与文本混合排版使用说明:

服务器返回结果中包含了uri与url两个字段。在IM类应用中,文本与图像内容一般是分开传送的,在此我们定义其为文本通道与图像通道。使用该uri,可以在普通文本中占位并唯一标识对应的图像。发送端与接收端可在用户的文本内容中解析该uri并进行正确显示。url字段标识该图像在网络中存储的真实位置,如果客户端未存在该图像,则可通过网络进行获取。

"images":{
   "png":{
       "80":{
           "uri": "kika://sticker/K0S7tnsWHrFLUOfXiwCVcqTKIP_e",
           "url":"https://cdn.emojier.net/sticker/K0S7tnsWHrFLUOfXiwCVcqTKIP_e",
           "width":85,
           "height":80
       },
       "320":{
           "uri": "kika://sticker/RKt1S7uwUwFMs7fmiWC5cvTJI0_e",
           "url":"https://cdn.emojier.net/sticker/RKt1S7uwUwFMs7fmiWC5cvTJI0_e",
           "width":339,
           "height":320
       }
   }
}

OPEN API使用文档

ps: 文档中App key(6e44c40ecf977873ed2b18e954d263aa)用于演示用途,对速率有相应限制,勿在实际项目中使用。请联系客服申请正式App key。

Sticker

1. 获取sticker分类列表
GET - [ https://api.emojier.net/v1/sticker/categories/fetch ]
请求参数
参数名 必传 默认值 类型 描述
appKey Y string 客户app唯一识别码
limit N 10 int 每一页的结果数 (max <= 20)
offset N 0 int 每一页的偏移量
Ex:https://api.emojier.net/v1/sticker/categories/fetch?app_key=6e44c40ecf977873ed2b18e954d263aa
请求返回
成功
{
    "status":"SUCCESS",
    "data":[
        "kikahoneyrabbit",
        "kikaluckygirl"
    ]
}
失败
{
    "status":"ERROR",
    "errorMsg":"No Data."
}
2. sticker搜索
使用该接口可以通过标签值搜索相关联sticker或者使用分类列表请求返回的标签值来获取同一分类的sticker

GET - [ https://api.emojier.net/v1/sticker/search ]

请求参数
参数名 必传 默认值 类型 描述
appKey Y string 客户app唯一识别码
query Y string 搜索内容
limit N 10 int 每一页的结果数 (max <= 20)
offset N 0 int 每一页的偏移量
Ex:https://api.emojier.net/v1/sticker/search?app_key=6e44c40ecf977873ed2b18e954d263aa&query=sleepy
请求返回
成功
{
    "status":"SUCCESS",
    "data":[
        {
            "tags":[
                "diyminions",
                "minions",
                "yellow minions",
                "yawn",
                "sleepy",
                "lazy"
            ],
            "images":{
                "png":{
                    "80":{
                        "url":"https://cdn.emojier.net/sticker/O2CMS6sOUPieFnuGHptXcrTDIr_e",
                        "width":54,
                        "uri":"kika://sticker/O2CMS6sOUPieFnuGHptXcrTDIr_e",
                        "height":80
                    },
                    "320":{
                        "url":"https://cdn.emojier.net/sticker/nqS9f2UOFxCzinuOH1tocmT9IO_e",
                        "width":214,
                        "uri":"kika://sticker/nqS9f2UOFxCzinuOH1tocmT9IO_e",
                        "height":320
                    }
                }
            },
            "author": "Kika Tech"
        }
    ]
}
失败
{
    "status":"ERROR",
    "errorMsg":"No Data."
}

Gif

1. 获取gif分类列表
GET - [ https://api.emojier.net/v1/gif/categories/fetch ]
请求参数
参数名 必传 默认值 类型 描述
appKey Y string 客户app唯一识别码
limit N 10 int 每一页的结果数 (max <= 20)
offset N 0 int 每一页的偏移量
Ex:https://api.emojier.net/v1/gif/categories/fetch?app_key=6e44c40ecf977873ed2b18e954d263aa
请求返回
成功
{
    "status":"SUCCESS",
    "data":[
        "kikagifolympic",
        "kikagifemoji"
    ]
}
失败
{
    "status":"ERROR",
    "errorMsg":"No Data."
}
2. gif搜索
使用该接口可以通过标签值搜索相关联gif或者使用分类列表请求返回的标签值来获取同一分类的gif

GET - [ https://api.emojier.net/v1/gif/search ]

请求参数
参数名 必传 默认值 类型 描述
appKey Y string 客户app唯一识别码
query Y string 搜索内容
limit N 10 int 每一页的结果数 (max <= 20)
offset N 0 int 每一页的偏移量
Ex:https://api.emojier.net/v1/gif/search?app_key=6e44c40ecf977873ed2b18e954d263aa&query=lol
请求返回
成功
{
    "status":"SUCCESS",
    "data":[
        {
            "tags":[
                "kikagifemoji",
                "lol",
                "happy"
            ],
            "images":{
                "gif":{
                    "80":{
                        "width":80,
                        "uri":"kika://gif/APHGFesXClfJU1SxtLi1cgT2Iq_e",
                        "preview":"https://cdn.emojier.net/gif/nPHLSwswC5UvfWF2tKiLc6TvIL_e",
                        "url":"https://cdn.emojier.net/gif/APHGFesXClfJU1SxtLi1cgT2Iq_e",
                        "height":80
                    },
                    "280":{
                        "width":280,
                        "uri":"kika://gif/G9FzfyUJu6s6CaSVtDi2cxT6IO_e",
                        "preview":"https://cdn.emojier.net/gif/10Uxs8ueF0HGCZSQtAiWc3TwI5_e",
                        "url":"https://cdn.emojier.net/gif/G9FzfyUJu6s6CaSVtDi2cxT6IO_e",
                        "height":280
                    }
                }
            },
            "author": "Kika Tech"
        }
    ]
}
失败
{
    "status":"ERROR",
    "errorMsg":"No Data."
}