首页
学习
活动
专区
圈层
工具
发布
社区首页 >专栏 >数据鱼API「Emoji 表情符号」接口功能介绍

数据鱼API「Emoji 表情符号」接口功能介绍

原创
作者头像
用户12862874
发布于 2026-11-21 21:27:20
发布于 2026-11-21 21:27:20
90
举报

接口简介

「Emoji 表情符号」是数据鱼API平台提供的表情符号检索与解析接口,Base 路径 /api/emoji,共 5 个端点。它把一枚表情符号与它的中文名、所属分组、关键词、Unicode 码位和 HTML 实体串成一条结构化记录,供调用方按关键词检索、按分类浏览,或对单个字符做解析。

接口要解决的问题很具体:表情符号在昵称、评论、商品标题里大量出现,但程序侧往往只拿到一个字符,既不知道它叫什么,也无法判断它属于哪一类,更不方便转成 HTML 实体或码位形式输出。emoji 接口把这层映射放在服务端完成,调用方一次请求就能从字符得到可读描述,或从关键词得到字符清单。

数据来源是服务端内置的结构化表情库,按 Unicode 标准整理,当前收录 606 条记录、划分为 8 个分组。检索为本地内存匹配,不依赖外部上游服务,因此响应稳定;相应地,可检索范围也严格受限于这份内置数据,库中未收录的字符不会被检索到。

端点总览

方法

路径

说明

鉴权

GET

/api/emoji/ping

健康检查,返回版本与分类数量

否

GET

/api/emoji/search

按关键词搜索表情

是

GET

/api/emoji/categories

返回全部分类名称

是

GET

/api/emoji/group

按分类名称取该分类下的表情

是

GET

/api/emoji/parse

解析单个表情字符的完整信息

是

通用约定

  • 鉴权:通过 X-API-Key 请求头或 ?api_key= 查询参数传递密钥;缺失返回 4011,无效返回 4013。ping 为免鉴权端点。
  • 参数传递:GET 与 POST 均可,POST 支持 JSON body 或表单,参数名与 query 一致。
  • 响应结构:统一为 {"code":0,"msg":"success","data":...};data 在 search 与 group 中为数组,在 parse 中为对象,在 categories 中为字符串数组。
  • 错误码:4001 缺少必填参数,4002 参数格式非法,4003 取值不在支持列表,4004 查询目标未收录,4040 路由不存在,4050 方法不允许,5xxx 为服务端错误。4011 与 4013 的含义与其他接口一致,此处不再展开。

以上为数据鱼API平台的通用约定,本接口未对其做额外扩展。

核心端点详解

关键词搜索 search

在一个调用里完成关键词到表情清单的检索,匹配范围为中文名、关键词串与完整字符本身。

参数

类型

必填

默认

说明

q

string

是

—

搜索词,可为中文、英文或一个完整表情字符;为空返回 4001

limit

int

否

50

返回条数上限,达到上限即停止扫描

返回 data 为数组,元素字段包括:char 表情字符,name 中文名称,group 所属分组,keywords 关键词数组,codes 形如 U+1F600 的码位数组,html 十进制 HTML 实体。名称与关键词转为小写后做子串包含判断,字符做完全相等判断,因此英文关键词大小写不敏感,中文按原样匹配;结果按内置库顺序返回,不做相关度排序。

代码语言:javascript
复制
GET /api/emoji/search?q=开心&limit=10
代码语言:javascript
复制
{"code":0,"msg":"success","data":[{"char":"😀","name":"咧嘴笑","group":"笑脸与情感","keywords":["grinning","smile","开心"],"codes":["U+1F600"],"html":"😀"}]}

分类列表 categories

无参数,返回 8 个分类名称的字符串数组,顺序固定:笑脸与情感、手势与人、动物与自然、食物与饮料、活动与运动、旅行与地点、物品与工具、符号与标志。该端点通常作为 group 的前置调用,用于取得合法的分类名。

代码语言:javascript
复制
GET /api/emoji/categories

按分类取表情 group

按分类名取出该分类下的全部表情,适用于目录页、选择器一类需要整组展示的场景。

参数

类型

必填

默认

说明

name

string

是

—

分类名称,需与 categories 返回的名称完全一致

返回 data 为数组,元素结构与 search 相同。分类名精确匹配,大小写与空格都参与比较;传入不存在的分类不会报错,而是返回空数组。这一点与 parse 的失败行为不同,调用方需自行区分分类为空与分类不存在。

代码语言:javascript
复制
GET /api/emoji/group?name=笑脸与情感

单个表情解析 parse

给定一个表情字符,返回它在库中的唯一记录,常用于把用户输入或日志中的字符还原成可读信息。

参数

类型

必填

默认

说明

char

string

是

—

一个完整表情字符,按原样精确匹配

命中时返回该记录对象,字段同 search 的元素;未命中返回 HTTP 404 与业务码 4004,msg 为「未找到该表情」。多字符组合(肤色修饰、零宽连接序列)只有在库中作为单条记录收录时才能命中。

代码语言:javascript
复制
GET /api/emoji/parse?char=😀

数据与限制

  • 数据规模:内置 606 条记录、8 个分组,分类数量可由 ping 响应的 stats.categories 核对。
  • 检索上限:search 的 limit 默认 50,达到上限后停止扫描,因此结果是「前 N 条」而非全部命中。
  • 分页:search 与 group 均无分页参数,group 返回整个分类,没有条数上限。
  • 匹配方式:search 为名称与关键词的子串包含加字符全等,group 为分类名全等,parse 为字符全等。
  • 排序:结果按内置库的存储顺序输出,不按相关度或热度排序。
  • 数据源:本地结构化文件,读取后驻留内存,无外部上游依赖,不存在上游不可用导致的 5031 或 5032。
  • 覆盖范围:仅限库内收录的 606 条,Unicode 全量字符集中未收录的部分无法检索或解析。

典型使用场景

  • 表情选择器:先调 categories 取分组,再按用户点击的分组调 group 渲染面板。
  • 评论与昵称清洗:对文本中的表情逐个调用 parse,识别其名称或转换为 HTML 实体后存储。
  • 站内内容检索:在搜索框输入「开心」「动物」等词,调 search 返回候选表情用于插入或替换。
  • 文案检查:批量解析素材中的表情,统计分组分布,判断文案风格是否与目标人群匹配。

注意事项

  • 文档示例中的响应为空数组,是因为示例使用了占位参数(q=YOUR_Q、name=YOUR_NAME、char=YOUR_CHAR),并非端点无数据;换成真实取值即可返回记录。parse 在占位参数下返回 4004,属于未收录而不是服务故障。
  • group 的分类名必须与 categories 的输出完全一致,包括中文标点与空格;分类不存在时返回空数组而非错误码,容易与「分类下确实没有数据」混淆。
  • search 的 limit 未做上限与合法性校验,传 0 或负数时行为不符合直觉,建议固定使用正整数且不超过 50。
  • 同一关键词可能同时命中名称与关键词,但结果不会重复,每条记录只出现一次。
  • 表情的中文名称为便于中文用户检索所做的整理,官方名称以 Unicode 字符数据库为准;字符的实际渲染效果取决于终端与字体,接口只返回码位与实体,不保证显示形态。
  • 本接口属于数据鱼API平台的开发工具类接口,鉴权、错误码与响应结构与平台其他接口保持一致。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

目录
  • 接口简介
  • 端点总览
  • 通用约定
  • 核心端点详解
    • 关键词搜索 search
    • 分类列表 categories
    • 按分类取表情 group
    • 单个表情解析 parse
  • 数据与限制
  • 典型使用场景
  • 注意事项
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档