clue

Documentation

Overview

Package clue 线索及建站工具API 相关models

Index

• type CallbackRequest
  • func (r CallbackRequest) Encode() []byte
• type Clue
• type Form
• type FormDetail
• type FormDetailRequest
  • func (r FormDetailRequest) Encode() string
• type FormDetailResponse
• type FormElement
• type FormElementType
• type FormGetRequest
  • func (r FormGetRequest) Encode() string
• type FormGetResponse
• type FormGetResponseData
• type FormType
• type GetRequest
  • func (r GetRequest) Encode() string
• type GetResponse
• type GetResponseData
• type KeyAction
• type KeyActionGetRequest
  • func (r KeyActionGetRequest) Encode() string
• type KeyActionGetResponse
• type KeyActionGetResponseData
• type SmartPhone
• type SmartPhoneGetRequest
  • func (r SmartPhoneGetRequest) Encode() string
• type SmartPhoneGetResponse
• type SmartPhoneGetResponseData
• type Store

Types

type CallbackRequest

type CallbackRequest struct {
	// AdvertiserIDs 广告主id列表
	AdvertiserIDs []string `json:"advertiser_ids,omitempty"`
	// ClueID 线索ID
	ClueID string `json:"clue_id,omitempty"`
	// Source 广告来源，新版深度转化 source为1 允许值：0,1；对于source为0的线索回传，飞鱼平台不再披露显示，允许值0将于2020年9月24日下线
	Source int `json:"source,omitempty"`
	// ClueConvertState 线索状态 ：194:回访-信息确认、195:回访-加为好友、196:回访-高潜成交
	ClueConvertState int `json:"clue_convert_state,omitempty"`
}

CallbackReqeust 回传有效线索 API Request

func (CallbackRequest) Encode

func (r CallbackRequest) Encode() []byte

Encode implement PostRequest interface

type Clue

type Clue struct {
	// ClueID 线索ID
	ClueID model.Uint64 `json:"clue_id,omitempty"`
	// AdvertiserID 广告主ID
	AdvertiserID model.Uint64 `json:"advertiser_id,omitempty"`
	// AdvertiserName 广告主名
	AdvertiserName string `json:"advertiser_name,omitempty"`
	// AdID 计划ID
	AdID model.Uint64 `json:"ad_id,omitempty"`
	// AdName 计划名
	AdName string `json:"ad_name,omitempty"`
	// CreativeID 广告创意id
	CreativeID model.Uint64 `json:"creative_id,omitempty"`
	// PromotionName 体验版广告名称
	PromotionName string `json:"promotion_name,omitempty"`
	// PromotionID 体验版广告ID
	// 注意：体验版广告信息与计划/创意信息互斥，不会同时返回
	PromotionID uint64 `json:"promotion_id,omitempty"`
	// SiteID 站点ID
	SiteID model.Uint64 `json:"site_id,omitempty"`
	// SiteName 站点名称
	SiteName string `json:"site_name,omitempty"`
	// MidInfo 升级版素材组(投放2.0)
	// 注意：投放1.0为空，mid_info是一个jsonstring，示例
	//  {    "titleId" : 123,    "videoId" : 234,    "imageId" : 135}
	MidInfo string `json:"mid_info,omitempty"`
	// IntentionEstimation 线索意向。拉取到线索后，intention_estimation的获取会有约 10 分钟延迟；建议 10 分钟后重新拉取并和该条线索进行匹配
	IntentionEstimation string `json:"intention_estimation,omitempty"`
	// ExternalURL 落地页 url
	ExternalURL string `json:"external_url,omitempty"`
	// ClueType 组件类型，允许值：
	// 0: 表单提交；
	// 1: 在线咨询;
	// 2: 智能电话;
	// 3: 网页回呼;
	// 4: 卡券;
	// 5：抽奖
	ClueType int `json:"clue_type,omitempty"`
	// ModuleName 组件名字
	ModuleName string `json:"module_name,omitempty"`
	// ModuleID 组件ID
	ModuleID model.Uint64 `json:"module_id,omitempty"`
	// CreateTime 线索创建时间，如：2020-04-29
	CreateTime string `json:"create_time,omitempty"`
	// CreateTimeDetail 线索创建时间，如：2020-04-29 00:00:00
	CreateTimeDetail string `json:"create_time_detail,omitempty"`
	// Date 日期
	Date string `json:"date,omitempty"`
	// ClueSource 线索来源，目前几种线索来源分别是，允许值：
	// 0: 外部流量；
	// 1: 正常投放;
	// 2: 外部导入;
	// 3: 异常提交;
	// 4: 广告预览;
	// 5: 抖音私信;
	// 6: 鲁班线索
	ClueSource int `json:"clue_source,omitempty"`
	// Name 姓名
	Name string `json:"name,omitempty"`
	// Telephone 电话
	Telephone string `json:"telephone,omitempty"`
	// Gender 性别
	// 允许值：
	// 0：未知；
	// 1：男 ；
	// 2：女
	Gender int `json:"gender,omitempty"`
	// Age 年龄
	Age int `json:"age,omitempty"`
	// Email 邮箱
	Email string `json:"email,omitempty"`
	// Weixin 微信
	Weixin string `json:"weixin,omitempty"`
	// QQ QQ
	QQ string `json:"qq,omitempty"`
	// ProvinceName 省份
	ProvinceName string `json:"province_name,omitempty"`
	// CityName 城市
	CityName string `json:"city_name,omitempty"`
	// Address 详细地址
	Address string `json:"address,omitempty"`
	// Location 用户地址信息
	Location string `json:"location,omitempty"`
	// Remark 用户备注留言
	Remark string `json:"remark,omitempty"`
	// RemarkDict 广告主自定义的其它字段信息，可自定义获取; 例：若创建表单时自定义了"test_case"字段的设置，则产生的remark_dict线索为："test_case": "xxx"
	RemarkDict map[string]string `json:"remark_dict,omitempty"`
	// FormRemark 广告主表单自定义字段，无业务逻辑，仅作表单标志
	FormRemark string `json:"form_remark,omitempty"`
	// AppName 流量来源，比如「今日头条 」、「抖音」 拉取到线索后，app_name 的获取会有约 10 分钟延迟；建议 10 分钟后重新拉取并和该条线索进行匹配。
	AppName string `json:"app_name,omitempty"`
	// ConvertStatus 转化状态;允许值：数据获取中、无、合法转化、不匹配转化、广告预览、其他不合法转化、外部流量;拉取到线索后，convert_status 的获取会有约 10 分钟延迟；建议 10 分 钟后重新拉取并和该条线索进行匹配。
	ConvertStatus string `json:"convert_status,omitempty"`
	// ReqID 当前线索对应广告的请求id
	ReqID string `json:"req_id,omitempty"`
	// ClueState 线索状态值; 枚举值：1 新线索、2 明确意向、3 转商机、4 无效、5 加微信
	ClueState int `json:"clue_state,omitempty"`
	// ClueStateName 线索状态名称，“clue_state”对应的名称
	ClueStateName string `json:"clue_state_name,omitempty"`
	// ClueOwnerName 所属人姓名
	ClueOwnerName string `json:"clue_owner_name,omitempty"`
	// FollowStateName 线索通话状态名称; 包含值：未联系、未接通、已接通、有效沟通
	FollowStateName string `json:"follow_state_name,omitempty"`
	// CountryName 所在城市中的【区】字段
	CountryName string `json:"country_name,omitempty"`
	// SystemTags 线索相关的系统标签，是一个标签项的数组
	SystemTags []string `json:"system_tags,omitempty"`
	// Tags 线索被打上的人工标签，，是一个标签项的数组，包括自定义标签和行业标签
	Tags []string `json:"tags,omitempty"`
	// AllocationStatus 分配状态值; 枚举值：0 待分配、1 已分配
	AllocationStatus int `json:"allocation_status,omitempty"`
	// Store 门店信息
	Store *Store `json:"store,omitempty"`
}

Clue 线索

type Form

type Form struct {
	// AdvID 广告主ID
	AdvID uint64 `json:"adv_id,omitempty"`
	// InstanceID 表单ID
	InstanceID uint64 `json:"instance_id,omitempty"`
	// Name 表单名称
	Name string `json:"name,omitempty"`
	// Version 版本信息
	Version int `json:"version,omitempty"`
	// IsDel 是否已删除，1（删除）0（未删除）
	IsDel int `json:"is_del,omitempty"`
	// SubType 线索表单类型，返回值：
	// NORMAL_FORM（普通表单）
	// ADVANCED_CREATIVE_FORM（附加创意表单）
	SubType FormType `json:"sub_type,omitempty"`
	// EnableLayer 是否未分层表单，1（是）、0（否）
	EnableLayer int `json:"enable_layer,omitempty"`
	// FormType 表单类型，返回值：
	// NORMAL_FORM（普通表单）
	// ADVANCED_CREATIVE_FORM（附加创意表单）
	FormType FormType `json:"form_type,omitempty"`
	// ContainPhone 表单内是否包含电话元素; 1（是）、0（否）
	ContainPhone int `json:"contain_phone,omitempty"`
	// LightingPageURL 轻落地页URL，仅附加创意表单中存在
	LigntingPageURL string `json:"lighting_page_url,omitempty"`
	// CreateTime 创建时间，格式：Y-m-d H:M:S
	CreateTime string `json:"create_time,omitempty"`
}

Form 表单信息

type FormDetail

type FormDetail struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// InstanceID 表单ID
	InstanceID uint64 `json:"instance_id,omitempty"`
	// Name 表单名
	Name string `json:"name,omitempty"`
	// Title 表单标题
	Title string `json:"title,omitempty"`
	// SubmitText 提交按钮文案
	SubmitText string `json:"submit_text,omitempty"`
	// SubTitle 副标题
	SubTitle string `json:"sub_title,omitempty"`
	// Elements 表单元素
	Elements []FormElement `json:"elements,omitempty"`
}

FormDetail 表单详情

type FormDetailRequest

type FormDetailRequest struct {
	// AdvertiserID 广告主id，范围：1 <= advertiser_id <= MAX_INT64
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// InstanceID 表单ID
	InstanceID uint64 `json:"instance_id,omitempty"`
}

FormDetailRequest 建站工具——查询表单详情 API Request

func (FormDetailRequest) Encode

func (r FormDetailRequest) Encode() string

Encode implement GetRequest interface

type FormDetailResponse

type FormDetailResponse struct {
	model.BaseResponse
	// Data json 返回值
	Data *FormDetail `json:"data,omitempty"`
}

FormDetailResponse 建站工具——查询表单详情 API Response

type FormElement

type FormElement struct {
	// Label 元素标签
	Label string `json:"label,omitempty"`
	// AllowEmpty 是否允许为空
	// 返回值：
	// 0（必填），
	// 1（可为空）
	AllowEmpty int `json:"allow_empty,omitempty"`
	// Type 表单元素类型
	// 返回值：
	// NAME（姓名）
	// TELEPHONE（电话）
	// EMAIL（邮箱）
	// NUMBER（数值）
	// SEX（性别）
	// DATE（日期）
	// CITY（城市）
	// TEXT（文本）
	// TEXTAREA（文本域）
	// SELECT（下拉框）
	// RADIO（单选框）
	// CHECKBOX（多选框）
	// CALCULATOR（计算器
	Type FormElementType `json:"type,omitempty"`
	// IsUnique 是否可重复
	// 返回值：
	// 0（唯一）
	// 1（可重复）
	IsUnique int `json:"is_unique,omitempty"`
}

FormElement 表单元素

type FormElementType

type FormElementType string

FormElementType 表单元素类型

const (
	// FormElementType_NAME 姓名
	FormElementType_NAME FormElementType = "NAME"
	// FormElementType_TELEPHONE 电话
	FormElementType_TELEPHONE FormElementType = "TELEPHONE"
	// FormElementType_EMAIL 邮箱
	FormElementType_EMAIL FormElementType = "EMAIL"
	// FormElementType_NUMBER 数值
	FormElementType_NUMBER FormElementType = "NUMBER"
	// FormElementType_SEX 性别
	FormElementType_SEX FormElementType = "SEX"
	// FormElementType_DATE 日期
	FormElementType_DATE FormElementType = "DATE"
	// FormElementType_CITY 城市
	FormElementType_CITY FormElementType = "CITY"
	// FormElementType_TEXT 文本
	FormElementType_TEXT FormElementType = "TEXT"
	// FormElementType_TEXTAREA 文本域
	FormElementType_TEXTAREA FormElementType = "TEXTAREA"
	// FormElementType_SELECT 下拉框
	FormElementType_SELECT FormElementType = "SELECT"
	// FormElementType_RADIO 单选框
	FormElementType_RADIO FormElementType = "RADIO"
	// FormElementType_CHECKBOX 多选框
	FormElementType_CHECKBOX FormElementType = "CHECKBOX"
	// FormElementType_CALCULATOR 计算器
	FormElementType_CALCULATOR FormElementType = "CALCULATOR"
)

type FormGetRequest

type FormGetRequest struct {
	// AdvertiserID 广告主id，范围：1 <= advertiser_id <= MAX_INT64
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Page 页码，默认为1，范围：page >= 1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，默认10条每页，范围：page_size >= 1
	PageSize int `json:"page_size,omitempty"`
	// StartTIme 起始时间，格式：%Y-%m-%d，默认三天前
	StartTime string `json:"start_time,omitempty"`
	// EndTime 截止时间，格式：%Y-%m-%d，默认今天
	EndTime string `json:"end_time,omitempty"`
	// InstanceID 表单ID
	InstanceID uint64 `json:"instance_id,omitempty"`
	// IsDel 是否删除，允许值：1（未删除）2（已删除）默认未删除
	IsDel int `json:"is_del,omitempty"`
	// FormType 表单类型，允许值：
	// NORMAL_FORM（普通表单）
	// ADVANCED_CREATIVE_FORM（附加创意表单）
	FormType FormType `json:"form_type,omitempty"`
}

FormGetRequest 建站工具——查询已有表单列表 API Request

func (FormGetRequest) Encode

func (r FormGetRequest) Encode() string

Encode implement GetRequest interface

type FormGetResponse

type FormGetResponse struct {
	model.BaseResponse
	// Data json 返回值
	Data *FormGetResponseData `json:"data,omitempty"`
}

FormGetResponse 建站工具——查询已有表单列表 API Response

type FormGetResponseData

type FormGetResponseData struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// List 表单列表
	List []Form `json:"list,omitempty"`
}

FormGetResponseData json 返回值

type FormType

type FormType string

表单类型

const (
	// NORMAL_FORM 普通表单
	NORMAL_FORM FormType = "NORMAL_FORM"
	// ADVANCED_CREATIVE_FORM 附加创意表单
	ADVANCED_CREATIVE_FORM FormType = "ADVANCED_CREATIVE_FORM"
)

type GetRequest

type GetRequest struct {
	// AdvertiserIDs 广告主ids
	AdvertiserIDs []string `json:"advertiser_ids,omitempty"`
	// StartTime 查询起始时间，格式：yyyy-MM-dd 或者 yyyy-MM-dd hh:mm:ss
	StartTime string `json:"start_time,omitempty"`
	// EndTime 查询截止时间，格式：yyyy-MM-dd 或者 yyyy-MM-dd hh:mm:ss
	EndTime string `json:"end_time,omitempty"`
	// Page 页数 默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小 默认值: 10
	PageSize int `json:"page_size,omitempty"`
}

GetRequest 获取线索列表 API Request

func (GetRequest) Encode

func (r GetRequest) Encode() string

Encode implement GetRequest interface

type GetResponse

type GetResponse struct {
	model.BaseResponse
	// Data json返回值
	Data *GetResponseData `json:"data,omitempty"`
}

GetResponse 获取线索列表 API Response

type GetResponseData

type GetResponseData struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// List 线索列表
	List []Clue `json:"list,omitempty"`
}

GetResponseData json返回值

type KeyAction

type KeyAction struct {
	// AdvID 广告主ID
	AdvID uint64 `json:"adv_id,omitempty"`
	// Name 活动名
	Name string `json:"name,omitempty"`
	// AdPlanName 计划名
	AdPlanName string `json:"ad_plan_name,omitempty"`
	// AdPlanID 计划plan id
	AdPlanID uint64 `json:"ad_plan_id,omitempty"`
	// ClueID 线索id
	ClueID uint64 `json:"clue_id,omitempty"`
	// ReqID 当前线索对应广告的请求id
	ReqID string `json:"req_id,omitempty"`
	// SiteID 站点id
	SiteID uint64 `json:"site_id,omitempty"`
	// Cid cid
	Cid uint64 `json:"cid,omitempty"`
	// CreateTime 创建时间
	CreateTime string `json:"create_time,omitempty"`
}

KeyAction 活动记录

type KeyActionGetRequest

type KeyActionGetRequest struct {
	// AdvertiserIDs 广告主ids
	AdvertiserIDs []string `json:"advertiser_ids,omitempty"`
	// StartTime 查询起始时间，格式：yyyy-MM-dd 或者 yyyy-MM-dd hh:mm:ss
	StartTime string `json:"start_time,omitempty"`
	// EndTime 查询截止时间，格式：yyyy-MM-dd 或者 yyyy-MM-dd hh:mm:ss
	EndTime string `json:"end_time,omitempty"`
	// Page 页数 默认值: 1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小 默认值: 10
	PageSize int `json:"page_size,omitempty"`
}

KeyActionGetRequest 获取活动记录 API Request

func (KeyActionGetRequest) Encode

func (r KeyActionGetRequest) Encode() string

Encode implement GetRequest interface

type KeyActionGetResponse

type KeyActionGetResponse struct {
	model.BaseResponse
	// Data json返回值
	Data *KeyActionGetResponseData `json:"data,omitempty"`
}

KeyActionGetResponse 获取活动记录 API Response

type KeyActionGetResponseData

type KeyActionGetResponseData struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// List 线索列表
	List []KeyAction `json:"list,omitempty"`
}

KeyActionGetResponseData json返回值

type SmartPhone

type SmartPhone struct {
	// InstanceID 智能电话组件ID
	InstanceID uint64 `json:"instance_id,omitempty"`
	// Name 智能电话名称
	Name string `json:"name,omitempty"`
	// CallDisplay 是否为真实可接通的电话：0：表示不向商家显示用户真实手机号，而是虚拟号1：表示商家看到用户的真实号码
	CallDisplay int `json:"call_display,omitempty"`
	// PhoneID 电话id
	PhoneID uint64 `json:"phone_id,omitempty"`
	// PhoneNumber 电话号码，支持固话(如01012345678)、手机号；暂不支持400号码
	PhoneNumber string `json:"phone_number,omitempty"`
	// CreateTime 创建时间，格式：Y-m-d H:M:S
	CreateTime string `json:"create_time,omitempty"`
}

SmartPhone 智能电话

type SmartPhoneGetRequest

type SmartPhoneGetRequest struct {
	// AdvertiserID 广告主id，范围：1 <= advertiser_id <= MAX_INT64
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// Page 页码，默认为1，范围：page >= 1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，默认10条每页，范围：page_size >= 1
	PageSize int `json:"page_size,omitempty"`
}

SmartPhoneGetRequest 建站工具——查询已有智能电话 API Request

func (SmartPhoneGetRequest) Encode

func (r SmartPhoneGetRequest) Encode() string

Encode implement GetRequest interface

type SmartPhoneGetResponse

type SmartPhoneGetResponse struct {
	model.BaseResponse
	// Data json 返回值
	Data *SmartPhoneGetResponseData `json:"data,omitempty"`
}

SmartPhoneGetResponse 建站工具——查询已有智能电话 API Response

type SmartPhoneGetResponseData

type SmartPhoneGetResponseData struct {
	// AdvKey 表征创建者信息的字段，历史为加密的advId
	AdvKey string `json:"adv_key,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// List 智能电话列表
	List []SmartPhone `json:"list,omitempty"`
}

SmartPhoneGetResponseData json 返回值

type Store

type Store struct {
	// StoreID 门店ID
	StoreID uint64 `json:"store_id,omitempty"`
	// StoreName 门店名称
	StoreName string `json:"store_name,omitempty"`
	// StorePackID 门店活动ID
	StorePackID uint64 `json:"store_pack_id,omitempty"`
	// StoreLocation 门店所在地
	StoreLocation string `json:"store_location,omitempty"`
	// StoreAddress 门店详细地址
	StoreAddress string `json:"store_address,omitempty"`
	// StoreRemark 门店备注
	StoreRemark string `json:"store_remark,omitempty"`
	// StorePackRemark 门店活动备注
	StorePackRemark string `json:"store_pack_remark,omitempty"`
}

Store 门店信息