会话消息查询接口

收藏
我的收藏

接口说明

目前分身容器内会传入历史 20 轮(40条)对话消息,已经可以满足绝大多数需求,若20轮不满足需求,可以使用该接口获取历史消息。

使用限制

注意:该域名只有在分身专属开发环境抖音云中才可以访问

基本信息

名称描述
HTTP URL
http://open-ai-byted-org.dyc.ivolces.com/dy_open_api/avatar/atomic/api/query_message/
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/query_message/' \ --header 'content-type: application/json' \ --data '{ "params": { "session_id": "a1dQ2BxnFR", "conversation_id": "XpmuPUwQX0", "start_time_unix_milli": 1640995200000, "end_time_unix_milli": 1672531199000, "limit": 817155995, "sort_order": 1, "excluded_session_ids": [ "zt93fJSxlt" ], "excluded_conversation_ids": [ "pTiTItPxOh" ] }, "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": [ { "update_time_unix_milli": 5624890863972509000, "reply_to_id": "lAUloS7PPI", "session_id": "wP842NlmrG", "parent_message_id": "Lm2gSg4JaW", "status": 1, "participants": [ { "participant_id": "1QQ5vSrcju", "participant_type": 1 } ], "content": { "type": 1, "data": { "raw_content": "tNmLmSNm0s", "display_content": "X7WjXOjEMs", "brief": "EKtxgskOJK", "image_content": "RD0jIud8MY", "audio_content": "3AESgDQzKW", "video_content": "rbA9W3LWBa", "custom_content": "wchdYgBPrj", "ext": { "JrmK9OEXPy": "dPRtTPn48B" } }, "multi_content": [ { "content": "kkstUgwcXI", "rich_text_content": { "display_text": "8n08L0rmWT", "ext": "PdQd7zHoEd" }, "image_content": { "url": "MORTJprFJm", "ocr": "tvyKaPvk6a", "item_id": "T0YP2OOm5j" }, "card_content": { "card_content": "RM80WonWiU" }, "type": 1 } ] }, "sender": { "participant_id": "dYVuKT8kjy", "participant_type": 1 }, "create_time_unix_milli": 9170053873264463000, "ext": { "NOjP0wDYsO": "jtPZ5HhfGG" }, "id": "Xjjx9RSWSO", "conversation_id": "IZlw70xkVG" } ] }
切换单列布局

错误码

HTTP 状态码错误码错误码描述排查建议
20028001005
系统内部错误,请重试
请求重试,若依然无解请向平台提交反馈
20028001003
access_token无效
重新请求生成access_token
20028001008
access_token过期,请刷新或重新授权
重新请求生成access_token
20028001016
当前应用已被封禁或下线
clientKey被封禁或者下线
20028001006
网络调用错误,请重试
重试即可
20028001014
应用未授权任何能力
确认应用是否授权能力
20028001018
应用未获得该能力
开通相关能力
20028003017
quota已用完
联系平台处理
20028001019
应用该能力已被封禁
该能力被封禁,联系平台处理
20028001007
参数不合法
根据错误信息检查请求参数是否填写正常
200-40001
具体缺失或错误的请求字段信息
按照错误消息修改入参后重新请求