smartphone

Documentation

Overview

Package smartphone 智能电话组件 API models

Index

• type CreateRequest
  • func (r CreateRequest) Encode() []byte
• type CreateResponse
• type CreateResponseData
• type DeleteRequest
  • func (r DeleteRequest) Encode() []byte
• type GetRequest
  • func (r GetRequest) Encode() string
• type GetResponse
• type GetResponseData
• type Record
• type RecordRequest
  • func (r RecordRequest) Encode() string
• type RecordResponse
• type RecordResponseData
• type SmartPhone
• type TimeRange

Types

type CreateRequest

type CreateRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// CallDisplay 是否显示真实手机号
	// 1：显示真实手机号
	// 0：显示虚拟号（默认）
	CallDisplay int `json:"call_display,omitempty"`
	// Name 智能电话名称，长度不超过20
	Name string `json:"name,omitempty"`
	// NoDisturbTimes 免打扰开启时间段(最多5组，不填或者空数组代表不开启免打扰)
	// 所选时间内，用户通过广告页所拨电话将由语音机器人应答，商家将不会收到来电
	// 非工作时段所有来电及录音可在飞鱼查看，并支持回拨
	// 触发非工作模式同样记转化
	NoDisturbTimes []TimeRange `json:"no_disturb_times,omitempty"`
	// PhoneNumber 电话号码
	// 支持固话(如01012345678)、手机号
	// 暂不支持400号码绑定
	PhoneNumber string `json:"phone_number,omitempty"`
	// ValidateType 对用户手机号的验证类型，可选值:
	// CLUE_PRIORITY：优先线索量。对系统判定异常电话进行语音验证，未通过验证的用户线索仍然获取
	// VALIDITY_PRIORITY： 优先有效性。对系统判定异常电话进行语音验证，只获取通过验证的用户线索
	// NONE_VERIFICATION：不进行验证。无论什么类型用户，均不进行语音验证
	ValidateType enum.ClueValidateType `json:"validate_type,omitempty"`
}

CreateRequest 创建智能电话 API Request

func (CreateRequest) Encode

func (r CreateRequest) Encode() []byte

Encode implenent PostRequest interface

type CreateResponse

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

CreateResponse 创建智能电话 API Response

type CreateResponseData

type CreateResponseData struct {
	// InstanceID 生成的智能电话ID
	InstanceID uint64 `json:"instance_id,omitempty"`
	// Key advertiser_id的加密字段
	Key string `json:"key,omitempty"`
}

CreateResponseData json返回值

type DeleteRequest

type DeleteRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// InstanceID 智能电话ID
	InstanceID uint64 `json:"instance_id,omitempty"`
}

DeleteRequest 删除智能电话 API Request

func (DeleteRequest) Encode

func (r DeleteRequest) Encode() []byte

Encode implenent PostRequest interface

type GetRequest

type GetRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// InstanceIDs 智能电话ID列表; 若指定instance_ids进行过滤，其他的过滤条件将不生效
	InstanceIDs []string `json:"instance_ids,omitempty"`
	// StartTime 起始时间，格式：%Y-%m-%d，默认7天前，即不指定起止时间获取最近7天数据
	StartTime string `json:"start_time,omitempty"`
	// EndTime 截止时间，格式：%Y-%m-%d，默认当天，即不指定起止时间获取最近7天数据
	EndTime string `json:"end_time,omitempty"`
	// IsDel 删除标记，默认获取未删除的数据; 可选值：0，1（0表示未删除，1表示已删除）
	IsDel int `json:"is_del,omitempty"`
	// Page 页码，默认值为1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，默认值为10，最大不超过50
	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 {
	// Key advertiser_id的加密字段
	Key string `json:"key,omitempty"`
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// List 智能电话列表
	List []SmartPhone `json:"list,omitempty"`
}

GetResponseData json返回值

type Record

type Record struct {
	// InstanceID 智能电话ID
	InstanceID uint64 `json:"instance_id,omitempty"`
	// AdID 广告计划ID
	AdID uint64 `json:"ad_id,omitempty"`
	// SiteID 建站落地页ID
	SiteID uint64 `json:"site_id,omitempty"`
	// ClueID 线索ID
	ClueID uint64 `json:"clue_id,omitempty"`
	// CallDuration 呼叫时长，秒单位
	CallDuration int64 `json:"call_duration,omitempty"`
	// RealDuration 通话时长，秒单位
	RealDuration int64 `json:"real_duration,omitempty"`
	// VirtualNumber 呼叫的虚拟号码
	VirtualNumber string `json:"virtual_number,omitempty"`
	// StartTIme 拨打时间，格式：%Y-%m-%d %H:%M:%S
	StartTime string `json:"start_time,omitempty"`
	// CreateTime 创建时间，格式：%Y-%m-%d %H:%M:%S
	CreateTime string `json:"create_time,omitempty"`
}

Record 智能电话拨打记录

type RecordRequest

type RecordRequest struct {
	// AdvertiserID 广告主ID
	AdvertiserID uint64 `json:"advertiser_id,omitempty"`
	// InstanceIDs 智能电话ID，不超过100个
	InstanceIDs []uint64 `json:"instance_ids,omitempty"`
	// AdIDs 广告计划ID，不超过100个
	AdIDs []uint64 `json:"ad_ids,omitempty"`
	// ClueIDs 线索ID，不超过100个
	ClueIDs []uint64 `json:"clue_ids,omitempty"`
	// SiteIDs 建站落地页ID，不超过100个
	SiteIDs []uint64 `json:"site_ids,omitempty"`
	// StartTime 起始时间，格式：%Y-%m-%d，默认7天前，即不指定起止时间获取最近7天数据
	StartTime string `json:"start_time,omitempty"`
	// EndTime 截止时间，格式：%Y-%m-%d，默认当天，即不指定起止时间获取最近7天数据
	EndTime string `json:"end_time,omitempty"`
	// Page 页码，默认值为1
	Page int `json:"page,omitempty"`
	// PageSize 页面大小，默认值10，不超过50
	PageSize int `json:"page_size,omitempty"`
}

RecordRequest 查询智能电话拨打记录 API Request

func (RecordRequest) Encode

func (r RecordRequest) Encode() string

type RecordResponse

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

RecordResponse 查询智能电话拨打记录 API Response

type RecordResponseData

type RecordResponseData struct {
	// PageInfo 分页信息
	PageInfo *model.PageInfo `json:"page_info,omitempty"`
	// List 智能电话列表
	List []Record `json:"list,omitempty"`
}

RecordResponseData json返回值

type SmartPhone

type SmartPhone struct {
	// CallDisplay 是否显示真实手机号
	// 1：显示真实手机号
	// 0：显示虚拟号（默认）
	CallDisplay int `json:"call_display,omitempty"`
	// CreateTime 表单创建时间，格式：%Y-%m-%d %H:%M:%S
	CreateTime string `json:"create_time,omitempty"`
	// InstanceID 生成的智能电话ID
	InstanceID uint64 `json:"instance_id,omitempty"`
	// Name 智能电话名称，长度不超过20
	Name string `json:"name,omitempty"`
	// NoDisturbTimes 免打扰开启时间段(最多5组，不填或者空数组代表不开启免打扰)
	// 所选时间内，用户通过广告页所拨电话将由语音机器人应答，商家将不会收到来电
	// 非工作时段所有来电及录音可在飞鱼查看，并支持回拨
	// 触发非工作模式同样记转化
	NoDisturbTimes []TimeRange `json:"no_disturb_times,omitempty"`
	// PhoneNumber 电话号码
	// 支持固话(如01012345678)、手机号
	// 暂不支持400号码绑定
	PhoneNumber string `json:"phone_number,omitempty"`
	// ValidateType 对用户手机号的验证类型，可选值:
	// CLUE_PRIORITY：优先线索量。对系统判定异常电话进行语音验证，未通过验证的用户线索仍然获取
	// VALIDITY_PRIORITY： 优先有效性。对系统判定异常电话进行语音验证，只获取通过验证的用户线索
	// NONE_VERIFICATION：不进行验证。无论什么类型用户，均不进行语音验证
	ValidateType enum.ClueValidateType `json:"validate_type,omitempty"`
}

SmartPhone 智能电话

type TimeRange

type TimeRange struct {
	// StartTime 开始时间
	StartTime string `json:"start_time,omitempty"`
	// EndTIme 结束时间
	EndTime string `json:"end_time,omitempty"`
}

TimeRange 时间范围