Skip to content

Latest commit

 

History

History
405 lines (233 loc) · 12.5 KB

EnterpriseApi.md

File metadata and controls

405 lines (233 loc) · 12.5 KB
Raw

\EnterpriseApi

All URIs are relative to https://open.douyin.com

Method HTTP request Description
EnterpriseLeadsTagCreate Post /enterprise/leads/tag/create 创建标签
EnterpriseLeadsTagDelete Post /enterprise/leads/tag/delete 删除标签
EnterpriseLeadsTagList Get /enterprise/leads/tag/list 获取标签列表
EnterpriseLeadsTagUpdate Post /enterprise/leads/tag/update 编辑标签
EnterpriseLeadsTagUserList Get /enterprise/leads/tag/user/list 获取打标签的用户列表
EnterpriseLeadsTagUserUpdate Post /enterprise/leads/tag/user/update 给用户设置标签
EnterpriseLeadsUserActionList Get /enterprise/leads/user/action/list 获取意向用户互动记录
EnterpriseLeadsUserDetail Get /enterprise/leads/user/detail 获取意向用户详情
EnterpriseLeadsUserList Get /enterprise/leads/user/list 获取意向用户列表

EnterpriseLeadsTagCreate

EnterpriseLeadsTagCreateRsp EnterpriseLeadsTagCreate(ctx, accessToken, openId, body)

创建标签

创建标签

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
openId string 通过/oauth/access_token/获取，用户唯一标志
body EnterpriseLeadsTagCreateReq

Return type

EnterpriseLeadsTagCreateRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnterpriseLeadsTagDelete

EnterpriseLeadsTagDeleteRsp EnterpriseLeadsTagDelete(ctx, accessToken, openId, body)

删除标签

删除标签

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
openId string 通过/oauth/access_token/获取，用户唯一标志
body EnterpriseLeadsTagDeleteReq

Return type

EnterpriseLeadsTagDeleteRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnterpriseLeadsTagList

EnterpriseLeadsTagListRsp EnterpriseLeadsTagList(ctx, accessToken, openId, count, optional)

获取标签列表

获取标签列表

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
openId string 通过/oauth/access_token/获取，用户唯一标志
count int64
optional *EnterpriseLeadsTagListOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a EnterpriseLeadsTagListOpts struct

Name Type Description Notes

cursor | optional.Int64| |

Return type

EnterpriseLeadsTagListRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnterpriseLeadsTagUpdate

EnterpriseLeadsTagUpdateRsp EnterpriseLeadsTagUpdate(ctx, accessToken, openId, body)

编辑标签

编辑标签

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
openId string 通过/oauth/access_token/获取，用户唯一标志
body EnterpriseLeadsTagUpdateReq

Return type

EnterpriseLeadsTagUpdateRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnterpriseLeadsTagUserList

EnterpriseLeadsTagUserListRsp EnterpriseLeadsTagUserList(ctx, accessToken, openId, count, tagId, optional)

获取打标签的用户列表

获取打标签的用户列表

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
openId string 通过/oauth/access_token/获取，用户唯一标志
count int64
tagId int64
optional *EnterpriseLeadsTagUserListOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a EnterpriseLeadsTagUserListOpts struct

Name Type Description Notes

cursor | optional.Int64| |

Return type

EnterpriseLeadsTagUserListRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnterpriseLeadsTagUserUpdate

EnterpriseLeadsTagUserUpdateRsp EnterpriseLeadsTagUserUpdate(ctx, accessToken, openId, body)

给用户设置标签

给用户设置标签

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
openId string 通过/oauth/access_token/获取，用户唯一标志
body EnterpriseLeadsTagUserUpdateReq

Return type

EnterpriseLeadsTagUserUpdateRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnterpriseLeadsUserActionList

EnterpriseLeadsUserActionListRsp EnterpriseLeadsUserActionList(ctx, accessToken, openId, count, userId, optional)

获取意向用户互动记录

获取意向用户互动记录

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
openId string 通过/oauth/access_token/获取，用户唯一标志
count int64
userId string
optional *EnterpriseLeadsUserActionListOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a EnterpriseLeadsUserActionListOpts struct

Name Type Description Notes

cursor | optional.Int64| | actionType | optional.Int64| |

Return type

EnterpriseLeadsUserActionListRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnterpriseLeadsUserDetail

EnterpriseLeadsUserDetailRsp EnterpriseLeadsUserDetail(ctx, accessToken, openId, userId)

获取意向用户详情

获取意向用户详情

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
openId string 通过/oauth/access_token/获取，用户唯一标志
userId string

Return type

EnterpriseLeadsUserDetailRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnterpriseLeadsUserList

EnterpriseLeadsUserListRsp EnterpriseLeadsUserList(ctx, accessToken, openId, count, startTime, endTime, actionType, optional)

获取意向用户列表

获取意向用户列表

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accessToken string 调用/oauth/access_token/生成的token，此token需要用户授权。
openId string 通过/oauth/access_token/获取，用户唯一标志
count int64 分页数量。
startTime int64
endTime int64
actionType int64 分类 `0` - 全部 `1` - 私信互动 `2` - 组件互动 `3` - 主页互动
optional *EnterpriseLeadsUserListOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a EnterpriseLeadsUserListOpts struct

Name Type Description Notes

cursor | optional.Int64| 分页游标 | leadsLevel | optional.Int64| 用户状态 `-1` - 没兴趣 `0` - 了解 `1` - 有兴趣 `2` - 有意愿 `10` - 已转化 |

Return type

EnterpriseLeadsUserListRsp

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]