docs: correct htsy API field types, names, and CLI examples
This commit is contained in:
@@ -7,7 +7,7 @@
|
||||
| 目标 | 接口 | 请求字段 | 常用返回字段 |
|
||||
| --- | --- | --- | --- |
|
||||
| 素材上传 | `POST /api/material/upload` | `type`(string, 必填,素材类型);`material`(bytes, 必填,素材) | `link`(string,素材地址) |
|
||||
| 列表 | `POST /api/material/list` | `page`(int64, 必填,page);`pageSize`(int64, 必填,pageSize);`name`(string, 可选,素材名字搜索);`type`(string, 必填,类型);`isQy`(bool, 可选,是否属于企业) | `list`(repeated MaterialInfo,计划列表);`page`(int64,page);`pageSize`(int64,pageSize);`total`(int64,总数);`last`(bool,是否最后) |
|
||||
| 列表 | `POST /api/material/list` | `page`(int64, 必填,page);`pageSize`(int64, 必填,pageSize);`name`(string, 可选,素材名字搜索);`type`(string, 必填,类型);`isQy`(bool, 可选,是否属于企业) | `list`(repeated MaterialInfo,素材列表);`page`(int64,page);`pageSize`(int64,pageSize);`total`(int64,总数);`last`(bool,是否最后) |
|
||||
| 添加 | `POST /api/material/add` | `id`(int64, 可选,素材id);`type`(string, 必填,素材类型);`name`(string, 必填,素材名字);`text`(MessageText, 可选,文本消息 text);`image`(MessageImage, 可选,图片消息 image);`sticker`(MessageSticker, 可选,表情消息 sticker);`video`(MessageVideo, 可选,视频消息 video);`miniProgram`(MessageMiniProgram, 可选,小程序 miniProgram);`link`(MessageLink, 可选,链接 link);`audio`(MessageAudio, 可选,音频 audio);`compositeImage`(MessageCompositeImage, 可选,合成图 compositeImage);`inviteGroup`(MessageInviteGroup, 可选,入群邀请 inviteGroup);`goods`(MessageGoods, 可选,商品 goods);`freeVideo`(MessageFreeVideo, 可选,视频号 freeVideo);`liveBroadcastRoom`(MessageLiveBroadcastRoom, 可选,直播间 liveBroadcastRoom);`file`(MessageFile, 可选,文件 file);`note`(MessageNote, 可选,笔记 note);`collection`(repeated Collection, 可选,合集 collection);`materialGroup`(repeated MaterialDialogueContent, 可选,素材组List);`isQy`(bool, 可选,是否属于企业);... 另有 1 个字段 | `id`(int64) |
|
||||
| 删除 | `POST /api/material/del` | `ids`(repeated int64, 必填,删除的ids);`type`(string, 必填,素材类型) | 空对象或无业务数据 |
|
||||
| 更新 | `POST /api/material/update` | `id`(int64, 可选,素材id);`type`(string, 必填,素材类型);`name`(string, 必填,素材名字);`text`(MessageText, 可选,文本消息 text);`image`(MessageImage, 可选,图片消息 image);`sticker`(MessageSticker, 可选,表情消息 sticker);`video`(MessageVideo, 可选,视频消息 video);`miniProgram`(MessageMiniProgram, 可选,小程序 miniProgram);`link`(MessageLink, 可选,链接 link);`audio`(MessageAudio, 可选,音频 audio);`compositeImage`(MessageCompositeImage, 可选,合成图 compositeImage);`inviteGroup`(MessageInviteGroup, 可选,入群邀请 inviteGroup);`goods`(MessageGoods, 可选,商品 goods);`freeVideo`(MessageFreeVideo, 可选,视频号 freeVideo);`liveBroadcastRoom`(MessageLiveBroadcastRoom, 可选,直播间 liveBroadcastRoom);`file`(MessageFile, 可选,文件 file);`note`(MessageNote, 可选,笔记 note);`collection`(repeated Collection, 可选,合集 collection);`materialGroup`(repeated MaterialDialogueContent, 可选,素材组List);`isQy`(bool, 可选,是否属于企业);... 另有 1 个字段 | 空对象或无业务数据 |
|
||||
@@ -24,7 +24,7 @@
|
||||
| 话术库标签创建 | `POST /api/material/dialogue/tag/add` | `name`(string, 可选,类别名) | `id`(int64,id) |
|
||||
| 话术库标签列表 | `POST /api/material/dialogue/tag/list` | `{}` | `list`(repeated MaterialDialogueTagItem) |
|
||||
| 话术库标签更新 | `POST /api/material/dialogue/tag/update` | `id`(int64, 可选);`name`(string, 可选) | 空对象或无业务数据 |
|
||||
| 话术库分类删除 | `POST /api/material/dialogue/tag/del` | `id`(int64, 可选) | 空对象或无业务数据 |
|
||||
| 话术库标签删除 | `POST /api/material/dialogue/tag/del` | `id`(int64, 可选) | 空对象或无业务数据 |
|
||||
| 为话术库设置分类或者标签 | `POST /api/material/dialogue/setCategoryOrTag` | `dialogueId`(repeated int64, 必填,素材id);`categoryId`(int64, 可选,类别id);`tagIds`(repeated int64, 可选,标签id);`needDelTagIds`(repeated int64, 可选,要删除的标签id) | 空对象或无业务数据 |
|
||||
| 获取oss上传的token,有效期5分钟 | `POST /api/material/getOssToken` | `type`(string, 必填,素材类型 image video等);`original`(string, 必填,来源 messagePush material等) | `accessID`(string,阿里云accessid);`host`(string,阿里云host);`policy`(string,阿里云policy);`signature`(string,阿里云signature);`dir`(string,阿里云文件目录);`expire`(int64,阿里云expire 毫秒);`domain`(string,阿里云domain) |
|
||||
|
||||
|
||||
Reference in New Issue
Block a user