clue

Documentation

Overview

Package clue 本地推线索管理相关

Index

• type Clue
• type LifeCallbackEvent
• type LifeCallbackRequest
  • func (r LifeCallbackRequest) Encode() []byte
• type LifeGetRequest
  • func (r LifeGetRequest) Encode() string
• type LifeGetResponse
• type LifeGetResult

Types

type Clue

type Clue struct {
	// ClueID 线索ID
	ClueID string `json:"clue_id,omitempty"`
	// LocalAccountID 广告主ID
	LocalAccountID model.Uint64 `json:"local_account_id,omitempty"`
	// AdvertiserName 广告主名
	AdvertiserName string `json:"advertiser_name,omitempty"`
	// PromotionID 广告ID
	PromotionID model.Uint64 `json:"promotion_id,omitempty"`
	// PromotionName 广告名称
	PromotionName string `json:"promotion_name,omitempty"`
	// ContentID 内容ID
	ContentID string `json:"content_id,omitempty"`
	// ToolID 线索工具ID
	ToolID string `json:"tool_id,omitempty"`
	// CreateTimeDetail 线索创建时间，如：2020-04-29 00:00:00
	CreateTimeDetail string `json:"create_time_detail,omitempty"`
	// ModifyTime 线索修改时间，如：2020-04-29 00:00:00
	ModifyTime string `json:"modify_time,omitempty"`
	// Name 姓名
	Name string `json:"name,omitempty"`
	// Telephone 客户留资手机号。当团购订单退款后，不可获取明文手机号。 默认值: ""
	Telephone string `json:"telephone,omitempty"`
	// Gender 性别 可选值:
	// UNKNOWN 未知
	// MALE 男
	// FEMALE 女
	// 默认值: UNKNOWN
	Gender local.Gender `json:"gender,omitempty"`
	// Age 年龄
	Age int `json:"age,omitempty"`
	// ProvinceName 用户填写省份
	ProvinceName string `json:"province_name,omitempty"`
	// CityName 用户填写城市
	CityName string `json:"city_name,omitempty"`
	// CountyName 用户填写区县
	CountyName string `json:"county_name,omitempty"`
	// Address 用户填写详细地址
	Address string `json:"address,omitempty"`
	// Remark 商家备注
	Remark string `json:"remark,omitempty"`
	// RemarkDict 商家表单自定义的字段信息，及其他线索相关信息
	RemarkDict string `json:"remark_dict,omitempty"`
	// FlowType 流量类型 可选值:
	// NATURE 自然流量
	// AD 广告流量
	FlowType local.ClueFlowType `json:"flow_type,omitempty"`
	// ActionType 互动场景 可选值:
	// SHORT_VIDEO 短视频
	// LIVE_VIDEO 直播
	// HOME_PAGE 企业主页
	// IM_MESSAGE 消息列表
	// GROUPON_ORDER 团购tab
	// ALIEN_CARD 异形卡
	// OTHERS 其他
	ActionType local.ClueActionType `json:"action_type,omitempty"`
	// LeadsPage 留资页面 可选值:
	// POI POI页
	// PRODUCT_DETAIL 商详页
	// OTHER 其他
	LeadsPage local.LeadsPage `json:"leads_page,omitempty"`
	// ClueType 留资组件 可选值:
	// FORM 表单提交
	// CONSULT 在线咨询
	// SMARTPHONE 智能电话
	// GROUP_BUYING 团购留资
	ClueType local.ClueType `json:"clue_type,omitempty"`
	// FollowLifeAccountType 跟进账户类型 可选值:
	// HEAD 总部
	// REGION 区域
	// SINGLE 门店
	FollowLifeAccountType local.FollowLifeAccountType `json:"follow_life_account_type,omitempty"`
	// FollowLifeAccountID 跟进账户ID
	FollowLifeAccountID string `json:"follow_life_account_id,omitempty"`
	// FollowLifeAccountName 跟进账户名称
	FollowLifeAccountName string `json:"follow_life_account_name,omitempty"`
	// OrderID 订单ID
	OrderID uint64 `json:"order_id,omitempty"`
	// EffectiveState 线索阶段 可选值:
	// 0 新线索
	// 1 有意向
	// 2 成交
	// 3 无效
	// 6 已加微信
	// 7 待再次沟通
	// 204 到店
	EffectiveState int `json:"effective_state,omitempty"`
	// ClueOwnerName 所属人姓名
	ClueOwnerName string `json:"clue_owner_name,omitempty"`
	// FollowStateName 线索通话状态 可选值:
	// NOT_CALLED 待联系
	// NOT_ANSWERED 未接通
	// SHORT_ANSWERED 已接通
	// ANSWERED 有效沟通
	// DEEP_ANSWERED 深度沟通
	FollowStateName local.FollowStateName `json:"follow_state_name,omitempty"`
	// SystemTags 线索被打上的系统标签，是一个标签项的数组
	SystemTags []string `json:"system_tags,omitempty"`
	// Tags 线索被打上的人工标签，是一个标签项的数组，包括自定义标签和行业标签
	Tags []string `json:"tags,omitempty"`
	// AllocationStatus  分配状态 可选值:
	// NOT_ASSIGN 待分配
	// ASSIGNED 已分配
	AllocationStatus local.ClueAllocationStatus `json:"allocation_status,omitempty"`
	// ReqID 当前线索对应广告的请求id
	ReqID string `json:"req_id,omitempty"`
}

Clue 线索

type LifeCallbackEvent

type LifeCallbackEvent struct {
	// EventCode 对线索当前事件状态clue_convert_state选择扩展标签。
	//  若clue_convert_state = INVALID_EVENT，则该字段必填，可选值:
	// 行业通用
	// CALL_THREE_TIMES_NO_RESPONSE 拨打3次以上未接通
	// CONNECTED_NO_INTENTION 接通但无意向
	// NO_AD_RESPONSE 反馈未在广告留资
	// OFFENSIVE_LANGUAGE 黑脏词
	// OTHER 其它
	// INVALID_NUMBER 空号/停机/关机
	// 家居行业
	// HOME_COLLABORATION_WITH_PEERS (家居)同行合作
	// HOME_NO_SHOW_FOR_MEASUREMENT_VISIT (家居)爽约上门量房
	// HOME_RENOVATION_TYPE_NOT_ACCEPTABLE (家居)装修类型不可承接
	// HOME_MISMATCH_DIFFERENT_LOCATIONS (家居)需求不匹配-需求与供给异地，原MISMATCH_DIFFERENT_LOCATIONS枚举逐步下线中
	// HOME_MISMATCH_LOW_BUDGET (家居)需求不匹配-消费力差（指代预算少/面积小），原MISMATCH_LOW_BUDGET枚举逐步下线中
	// 教育行业
	// EDU_MISMATCH_CLASS_TIME (教育)需求不匹配-上课时间不匹配
	// EDU_MISMATCH_COURSE (教育)需求不匹配-课程不匹配
	// EDU_MISMATCH_DIFFERENT_LOCATIONS (教育)需求不匹配-需求与供给异地
	// EDU_UNABLE_TO_ATTEND_IN_PERSON (教育)无法线下参加
	// 若clue_convert_state =ARRIVAL，对于家居行业可选扩展标签，则该字段为非必填，可选值:
	// HOME_MEASUREMENT_COMPLETED [家居]已量房
	// HOME_ORDER_DISPATCHED [家居]已派单
	// 若clue_convert_state =CLUE_CONFIRM，可选扩展标签，则该字段为非必填，可选值:
	// 家居行业
	// HOME_APPOINTMENT_SCHEDULED [家居]已约时间
	// HOME_CAN_ADD_WECHAT [家居]可加微
	// HOME_CONNECTED_WITH_INTERESTED_PARTY [家居]接通有意向
	// 教育行业
	// EDU_FIRST_CLASS_ATTENDED [教育]首次到课
	// EDU_INTERESTED [教育]有意向
	// 若clue_convert_state =CONVERSION_CLASS，家居行业可选扩展标签，则该字段为非必填，可选值:
	// HOME_CONTRACT_SIGNED [家居]已签约
	// HOME_SERVICE_DELIVERY_COMPLETED [家居]已完成服务交付
	ReasonCode local.ClueReasonCode `json:"reason_code,omitempty"`
	// ReasonMessage 自定义原因信息，选填，当reason_code = OTHER时建议填写
	ReasonMessage string `json:"reason_message,omitempty"`
}

type LifeCallbackRequest

type LifeCallbackRequest struct {
	// LocalAccountIDs 本地推广告主id列表
	LocalAccountIDs []uint64 `json:"local_account_ids,omitempty"`
	// ClueConvertState 线索当前事件状态，可选值:
	// ARRIVAL 顾客到店/销售人员成功上门
	// CLUE_CONFIRM 顾客表达有意向
	// CLUE_HIGH_INTENTION 定金或钩子品支付
	// CONVERSION_CLASS 正价支付
	// INVALID_EVENT 无效
	ClueConvertState local.ClueConvertState `json:"clue_convert_state,omitempty"`
	// EventData 无效事件标签；若clue_convert_state = INVALID_EVENT，则该字段必填
	EventData *LifeCallbackEvent `json:"event_data,omitempty"`
	// ClueID 线索id
	ClueID string `json:"clue_id,omitempty"`
}

LifeCallbackRequest 本地推线索回传 API Request

func (LifeCallbackRequest) Encode

func (r LifeCallbackRequest) Encode() []byte

Encode implements PostRequest interface

type LifeGetRequest

type LifeGetRequest struct {
	// LocalAccountIDs 广告主ids，上限50
	LocalAccountIDs []uint64 `json:"local_account_ids,omitempty"`
	// StartTime 查询起始时间，格式：yyyy-MM-dd hh:mm:ss
	StartTime string `json:"start_time,omitempty"`
	// EndTime 查询截止时间，格式：yyyy-MM-dd hh:mm:ss
	EndTime string `json:"end_time,omitempty"`
	// Page 页码
	Page int `json:"page,omitempty"`
	// PageSize 页面大小, 默认值: 10，上限：100
	PageSize int `json:"page_size,omitempty"`
}

LifeGetRequest 获取本地推线索列表 API Request

func (LifeGetRequest) Encode

func (r LifeGetRequest) Encode() string

Encode implements GetRequest interface

type LifeGetResponse

type LifeGetResponse struct {
	Data *LifeGetResult `json:"data,omitempty"`
	model.BaseResponse
}

LifeGetResponse 获取本地推线索列表 API Response

type LifeGetResult

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