接口说明

该接口用于查询互动用户（与授权应用用户产生互动行为，触发 Webhook 消息的用户）的具体互动记录

该接口涉及 scope 在用户点击授权，开发者获取到 code 调用 /oauth/access_token/ 接口时，返回的 scope 参数中将不再包含该 scope；授权(authorize), 取消授权(unauthorize) Webhook 事件中 scope 参数同样不会包含该 scope，开发者仍可以使用该 access_token 调用本接口。授权用户可以在设置-账号与安全-授权管理-经营授权中查看 / 取消已授权的 im 能力。抖音开放平台将于近期补齐 access_token 返回该 scope 的能力。

使用限制

该能力需要用户进行 web 扫码授权，当前仅支持一个用户授权一个应用，详见授权概述
当前开放用户范围：小程序品牌号及员工号和认证企业号及其员工号；后续将基于抖音经营者实际诉求逐步拓展开放用户范围。
该接口只支持前一天（T+1）至七天前（T+7）时间范围内的数据查询
若想获取有效数据，需要申请相关 WebHook 的权限，目前支持的事件包括

事件名	需要scope	描述
im_receive_msg	im.direct_message	接收私信，用户收到私信触发
im_send_msg	im.direct_message	发送私信，用户发送私信触发
im_enter_direct_msg	im.direct_message	接收用户进入私信会话页事件，用户主动进入私信会话页触发
im_group_receive_msg	im.group_message	接收群消息事件
im_group_send_msg	im.group_message	发送群消息事件
new_video_digg	user.intention	接收用户点赞事件
new_follow_action	user.intention	接收用户关注事件
group_fans_event	im.group_fans.create_list	用户加群事件
enter_group_audit_change	im.group_fans.create_list	用户加群申请事件

具体的 Webhook 事件权限要求等，详见事件列表

基本信息

名称	描述
HTTP URL	https://open.douyin.com/api/douyin/v1/interactive/intention/log/list/
HTTP Method	GET
Scope	user.intention
权限要求	需要申请权限。新能力上线能力实验室后，经营者可在“控制台-能力管理-能力实验室”中申请。后期能力若转为正式开放能力，可在“控制台-能力管理-互动管理”中申请。

请求参数

请求头

access-token必填String

示例：act.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ

调用https://open.douyin.com/oauth/access_token/生成的token

content-type必填String

示例：application/json

固定值"application/json"

Query

count必填Int64

示例：10

本次查询获取数量

最大值 100

end_time必填Int64

示例：1661819675

结束时间戳（秒级）

open_id必填String

示例：28940f5a-d8a4-4258-8a74-6a8e647431be

授权用户唯一标识

start_time必填Int64

示例：1681819675

开始时间戳(秒级)

eventString

示例：im_authorization

事件名

不传的时候默认获取全部事件

query_sessionString

示例：@9VxQh6rGTNAjPS/4do48Es7912fqP/+HOZZ3qAqlL1UVaPj560zdRmYqig357zEBfmnprZLqmDe9tIPiPwahqQ==

下次查询的 session 信息，首次查询时无需传入

请求示例
curl --location 'https://open.douyin.com/api/douyin/v1/interactive/intention/log/list/?open_id=28940f5a-d8a4-4258-8a74-6****&count=1&start_time=1681795343&end_time=1681816943' \
--header 'access-token: act.e3dcd4304cf47f1bbbbbc15544b2ea8eAIAU8xXNwOPTqUQvCc3kdae1'

响应参数

Body展开全部子属性

data必填Struct

展开子属性

err_msg必填String

错误信息

err_no必填Int32

错误码

log_id必填String

logid，用于提供给抖开进行错误排查

响应示例
正常响应示例异常响应示例
{
  "err_no": 0,
  "err_msg": "",
  "log_id": "20230419214506BBF9134A4E1E961A3F70",
  "data": {
    "intention_log_infos": [
      {
        "content": "{\"event\":\"im_receive_msg\",\"client_key\":\"aw4194pysb89vab\",\"from_user_id\":\"eb2921c7-b771-4a7f-913d-5c83edf51f62\",\"to_user_id\":\"28940f5a-d8a4-4258-8a74-6a8e647431be\",\"content\":{\"conversation_short_id\":\"@9VxQh6rGTNAjPS/4do48Es7912TqPvqFPJF1qwykJ1kSZvX760zdRmYqig357zEBxvhDiz3L1fs5/fgoye6gkA==\",\"server_message_id\":\"@9VxQh6rGTNAjPS/4do48Es7912fqP/+HOZZ3qAqlL1UVaPj560zdRmYqig357zEBfmnprZLqmDe9tIPiPwahqQ==\",\"conversation_type\":1,\"create_time\":1681799848725,\"message_type\":\"image\",\"source\":\"\",\"scene_type\":100,\"user_infos\":[{\"open_id\":\"eb2921c7-b771-4a7f-913d-5c83edf51f62\",\"nick_name\":\"普皮123\",\"avatar\":\"https://p3.douyinpic.com/aweme/720x720/aweme-avatar/tos-cn-i-0813_d8e6795fc59d4fa1afbb86b0ce0cfc37.jpeg?from=3782654143\"},{\"open_id\":\"28940f5a-d8a4-4258-8a74-6a8e647431be\",\"nick_name\":\"企业\",\"avatar\":\"https://p3.douyinpic.com/aweme/720x720/aweme-avatar/mosaic-legacy_3792_5112637127.jpeg?from=3782654143\"}]},\"log_id\":\"02168179984822600000000000000000000ffff0ac63e9d1d0a4b\",\"event_id\":\"\"}",
        "event": "im_receive_msg",
        "event_time": "1681799849067",
        "open_id": "eb2921c7-b771-4a7f-913d-5c83edf123"
      },
      {
        "content": "{\"event\":\"im_send_msg\",\"client_key\":\"aw4194pysb89vab\",\"from_user_id\":\"28940f5a-d8a4-4258-8a74-6a8e64743132\",\"to_user_id\":\"eb2921c7-b771-4a7f-913d-5c83edf51f62\",\"content\":{\"conversation_short_id\":\"@9VxQh6rGTNAjPS/4do48Es7912TqPvqFPJF1qwykJ1kSZvX760zdRmYqig357zEBxvhDiz3L1fs5/fgoye6gkA==\",\"server_message_id\":\"@9VxQh6rGTNAjPS/4do48Es7912fqP/+HPpZ4oAOlLlkQafj160zdRmYqig357zEBPcdyuvL4/H9HyycVFwEKIQ==\",\"conversation_type\":1,\"create_time\":1681799925320,\"message_type\":\"text\",\"source\":\"\",\"scene_type\":100,\"text\":\"文字自足\",\"user_infos\":[{\"open_id\":\"28940f5a-d8a4-4258-8a74-6a8e647431be\",\"nick_name\":\"企业123\",\"avatar\":\"https://p6.douyinpic.com/aweme/720x720/aweme-avatar/mosaic-legacy_3792_5112637127.jpeg?from=3782654143\"},{\"open_id\":\"eb2921c7-b771-4a7f-913d-5c83edf51f62\",\"nick_name\":\"普皮***\",\"avatar\":\"https://p6.douyinpic.com/aweme/720x720/aweme-avatar/tos-cn-i-0813_d8e6795fc59d4fa1afbb86b0ce0cfc37.jpeg?from=3782654143\"}]},\"log_id\":\"02168179992492200000000000000000000ffff0ac63e9d5dcc33\",\"event_id\":\"\"}",
        "event": "im_send_msg",
        "event_time": "1681799925570",
        "open_id": "eb2921c7-b771-4a7f-913d-5c83edf123"
      },
      {
        "content": "{\"event\":\"im_group_receive_msg\",\"client_key\":\"aw4194pysb89vab\",\"from_user_id\":\"28940f5a-d8a4-4258-8a74-6a8e64743242\",\"to_user_id\":\"28940f5a-d8a4-4258-8a74-6a8e647431be\",\"content\":{\"conversation_short_id\":\"@9VxQh6rGTNAjPS/4do48Es7912frNf+KOp15oAmgJlMSaPT560zdRmYqig357zEBxptq5l+blGKwmg/aUg64ww==\",\"server_message_id\":\"@9VxQh6rGTNAjPS/4do48Es7912fqP/+EPZxwrQ+jJ1MSbfT960zdRmYqig357zEBGtMlPqmU1K7J6z2Z21MU4w==\",\"conversation_type\":2,\"create_time\":1681800184637,\"message_type\":\"text\",\"source\":\"\",\"scene_type\":100,\"text\":\"给哼哼唧唧\",\"owner_id\":\"28940f5a-d8a4-4258-8a74-6a8e647431be\",\"user_infos\":[{\"open_id\":\"65dcbfb7-cddc-409c-9a61-8cff1ed1fb5e\",\"nick_name\":\"我是852\",\"avatar\":\"https://p3.douyinpic.com/aweme/720x720/aweme-avatar/tos-cn-avt-0015_7f42cb25ea95710122fe0b6b48546040.jpeg?from=3782654143\"},{\"open_id\":\"28940f5a-d8a4-4258-8a74-6a8e647***\",\"nick_name\":\"企业***\",\"avatar\":\"https://p3.douyinpic.com/aweme/720x720/aweme-avatar/mosaic-legacy_3792_5112637127.jpeg?from=3782654143\"}]},\"log_id\":\"02168180018421000000000000000000000ffff0a9fd6cfbd8f79\",\"event_id\":\"\"}",
        "event": "im_group_receive_msg",
        "event_time": "1681800184933",
        "open_id": "65dcbfb7-cddc-409c-9a61-8cff1ad12"
      },
      {
        "content": "{\"event\":\"im_enter_direct_msg\",\"client_key\":\"aw4194pysb89vab\",\"from_user_id\":\"65dcbfb7-cddc-409c-9a61-8cff1ed1fb5e\",\"to_user_id\":\"28940f5a-d8a4-4258-8a74-6a8e647412\",\"content\":\"{\\\"conversation_short_id\\\":\\\"@9VxQh6rGTNAjPS/4do48Es7912fqP/+EPpZyqAOvLVUSafX860zdRmYqig357zEBtAf1bCgtWX+PDLlgPeichg==\\\",\\\"server_message_id\\\":\\\"@9VxQh6rGTNAjPS/4do48Es7912fqP/+FO5R0rgqlKlkVbfH760zdRmYqig357zEBTSmfydGzCdTVnhY17yjSIA==\\\",\\\"conversation_type\\\":1,\\\"create_time\\\":1681800236901,\\\"scene_type\\\":4,\\\"user_infos\\\":[{\\\"open_id\\\":\\\"65dcbfb7-cddc-409c-9a61-8cff1ed1fb5e\\\",\\\"nick_name\\\":\\\"我是8068\\\",\\\"avatar\\\":\\\"https://p26.douyinpic.com/aweme/720x720/aweme-avatar/tos-cn-avt-0015_7f42cb25ea95710122fe0b6b48546040.jpeg?from=3782654143\\\"},{\\\"open_id\\\":\\\"28940f5a-d8a4-4258-8a74-6a8e647431be\\\",\\\"nick_name\\\":\\\"企业**\\\",\\\"avatar\\\":\\\"https://p26.douyinpic.com/aweme/720x720/aweme-avatar/mosaic-legacy_3792_5112637127.jpeg?from=3782654143\\\"}]}\",\"log_id\":\"02168180023688800000000000000000000ffff0a9fd6cfe9bed8\"}",
        "event": "im_enter_direct_msg",
        "event_time": "1681800237112",
        "open_id": "65dcbfb7-cddc-409c-9a61-8cff1e214"
      }
    ],
    "query_session": "@9VxQh6rGTNAjPS/4do48Es6xxzu8dbzteco2xlHzZkMZfI6IpjicIDsWyFW7yGRVD2G/7zZQcvpdwOmMGiG0UUKGpe976ngABqEXkgIvtgDegRxR8HzftKftzzNWF5nIEWg4zNLU9OCea61/v1P9HhMc5H1Lfs+JnxrMr5KNmKQ=",
    "has_more": true
  }
}

错误码

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	参数不合法	根据错误信息检查请求参数是否填写正常

开发者文档

互动用户记录查询

接口说明

使用限制

基本信息

请求参数

响应参数

错误码

互动用户记录查询在线调试

接口说明

使用限制

基本信息

请求参数

响应参数

错误码

互动用户记录查询