获取会话中的消息
接口说明
目前分身容器内会传入历史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 '' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{"params":{"session_id":"CsWNk8sU0q","limit":1341960303166921717,"offset":8985979150096212945},"request_info":{"provider_id":"q6eZRoNOk4","open_id":"4eBrpLJaEf","avatar_app_id":"Cqwp4gc6hP","tenant_id":"je7glwF7kY","conversation_id":"OYKPhZntnq","biz_id":"p7TQYrgelL","traffic_source":{"traffic_type":"9bdCAl2qkX","source":"USArtUtp2O","enter_from":"4Jodh6QMQr"},"open_guid":"aeIRvw3wAv","avatar_user_id":"WOj9fYQneu","user_id":"VAfFTBcyGX"}}'
响应参数
Body展开全部子属性
data必填Struct
展开子属性
err_msg必填String
示例:"access_token无效"
错误描述
err_no必填Int32
示例:28001003
错误码
log_id必填String
示例:"202405291440576E078D8757B9"
日志id
响应示例
{ "messages": [ { "id": "xlNLph9ShN", "update_time_unix_milli": 8364088513594378000, "parent_message_id": "pPjEvQSqdG", "ext": { "jPptyCSGg3": "jCdaR5H4Z9" }, "participants": [ { "participant_type": 1, "participant_id": "ZrMQtRhmka" } ], "sender": { "participant_type": 1, "participant_id": "ukeRDQu8nQ" }, "status": 1, "conversation_id": "DuPEoxFBnl", "create_time_unix_milli": 2580791366086333400, "content": { "type": 1, "data": { "display_content": "snzHqfnCGV", "brief": "z8LkF4NfRq", "image_content": "C4x5idgUXb", "audio_content": "zHB0CJ90SB", "video_content": "hlZZdGuygF", "custom_content": "h8GNQZOdkk", "ext": { "t9gtr8y3e3": "xTq8orraEP" }, "raw_content": "Kcu2kP8dso" }, "multi_content": [ { "image_content": { "item_id": "otEvAANECF", "url": "FTUDmysO2B", "ocr": "N8InQlNalg" }, "card_content": { "card_content": "d8kenVKjvm" }, "debug_content": { "debug_content": "dI2xbmPteb" }, "reasoning_content": { "reasoning_content": "UrXReHyxmw" }, "type": 1, "content": "EakE4v9kAg", "rich_text_content": { "ext": "4VEclOWpDx", "display_text": "4Q6PvFhHfF" } } ] }, "reply_to_id": "vrbgC6Mk2n", "session_id": "bmO8pjQpur" } ] }
错误码
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 | 参数不合法 | 根据错误信息检查请求参数是否填写正常 |