获取会话中的消息
接口说明
目前分身容器内会传入历史20轮对话,已经可以满足绝大多数需求,若20轮不满足需求,可以使用该接口获取历史消息。本接口主要用于非分身主服务中获取消息。本接口适用于使用了`Session`概念的用户,其他用户获取消息请使用消息查询接口QueryMessage
使用限制
注意:该域名只有在分身专属开发环境抖音云中才可以访问
基本信息
名称 | 描述 |
---|---|
HTTP URL | http://open-ai-byted-org.dyc.ivolces.com/dy_open_api/avatar/atomic/api/get_message_by_session/ |
HTTP Method | POST |
Scope | bytedance.avatar_arch.atomic_service_proxy |
请求参数
请求头
content-type必填String
固定值"application/json"
Body展开全部子属性
params必填Struct
展开子属性
request_info必填Struct
展开子属性
请求示例
curl --location --request POST 'http://open-ai-byted-org.dyc.ivolces.com/dy_open_api/avatar/atomic/api/get_message_by_session/' \ --header 'content-type: application/json' \ --data '{ "params": { "session_id": "la82k8gIMQ", "limit": 10, "offset": 1 }, "request_info": { "provider_id": "0", "biz_id": "format", "traffic_source": { "source": "", "enter_from": "", "traffic_type": "" }, "open_id": "your_open_id", "avatar_app_id": "your_app_id" } }'
响应参数
Body展开全部子属性
data必填Struct
展开子属性
err_msg必填String
示例:"access_token无效"
错误描述
err_no必填Int32
示例:28001003
错误码
log_id必填String
示例:"202405291440576E078D8757B9"
日志id
响应示例
{ "messages": [ { "content": { "data": { "raw_content": "SJvtFlIAeK", "display_content": "RptsfRuf6a", "brief": "YzZ4LxsgFQ", "image_content": "1OyBPgG2rk", "audio_content": "188OyIfAY2", "video_content": "l7ZInQSy7R", "custom_content": "4OqhJrI9x7", "ext": { "g8EJsGbbeR": "tZiX9ssqAw" } }, "multi_content": [ { "card_content": { "card_content": "B4APS4VpYN" }, "type": 1, "content": "JhJ65sv5gI", "rich_text_content": { "display_text": "1dmISNIQaY", "ext": "HpadoWdZYs" }, "image_content": { "url": "QElm96cYYZ", "ocr": "F4Bmv19Dd0", "item_id": "U5EwYqyS0X" } } ], "type": 1 }, "create_time_unix_milli": 2601142089064321000, "parent_message_id": "D8xB2vsxYY", "ext": { "4CESTaPEnP": "pbCd6v0Xa2" }, "conversation_id": "CRk7JFHlaX", "update_time_unix_milli": 7801359646112102000, "participants": [ { "participant_type": 1, "participant_id": "ohmz8jfMO7" } ], "status": 1, "id": "iMxw3KmPJJ", "session_id": "3CLJXYyAEp", "sender": { "participant_type": 1, "participant_id": "Il18oAmPdP" }, "reply_to_id": "WcXE0C4VEU" } ] }
错误码
HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
---|---|---|---|
200 | 28001005 | 系统内部错误,请重试 | 请求重试,若依然无解请向平台提交反馈 |
200 | 28001003 | access_token无效 | 重新请求生成access_token |
200 | 28001008 | access_token过期,请刷新或重新授权 | 重新请求生成access_token |
200 | 28001016 | 当前应用已被封禁或下线 | clientKey被封禁或者下线 |
200 | 28001006 | 网络调用错误,请重试 | 重试即可 |
200 | 28001014 | 应用未授权任何能力 | 确认应用是否授权能力 |
200 | 28001018 | 应用未获得该能力 | 开通相关能力 |
200 | 28003017 | quota已用完 | 联系平台处理 |
200 | 28001019 | 应用该能力已被封禁 | 该能力被封禁,联系平台处理 |
200 | 28001007 | 参数不合法 | 根据错误信息检查请求参数是否填写正常 |