销售历史记录相关API

获取销售通话历史数据

请求地址

GET https://deal-api.kuick.cn/api/v1.7/calls

是否需要认证

参数说明

参数名称 参数类别 是否必填 参数说明
app_id string 项目id
kuick_user_id string KuickDeal用户id
call_status int 接通状态,0:未接通,1:已接通
time_range_type int 通话时长选项范围,-1:全部、1:0~1分钟、2:1~5分钟、3:5~15分钟、4:15分钟以上
start_index int 分页开始索引,例如:第一页时,start_index为0,每页20条数据时,第二页时,start_index为20
count int 每页显示条数

正常返回结果

{
    "status": 1,
    "data": [
        {
            "id": "d4ff7375-88c1-4c3a-9d63-15a2495e8951",
            "appId": "xxxx",
            "audioUrl": "https://xxxx.mp3",
            "m4aAudioUrl": "https://xxxx.mp4",
            "duration": 122,
            "callStatus": 1,
            "audioStatus": 1,
            "callTime": "2017-12-26 17:40:07",
            "endTime": "2017-12-26 17:42:18",
            "asyncTaskId": "d37a8ebf-e5ef-494c-aece-a4decce0c252",
            "fromUserId": "4840",
            "toUserId": "c5c565a8-0377-4d85-86f7-155e47a6f46e",
            "fromUserType": 2,
            "toUserType": 1,
            "photoURI": "https://xxxx.png",
            "name": "xxxx",
            "phoneNum": "xxxx",
            "customer": {
                "name": "xxxx",
                "title": "",
                "email": "demo@kuick.cn",
                "phone": "xxxx",
                "company": "",
                "status": 1,
                "id": "c5c565a8-0377-4d85-86f7-155e47a6f46e",
                "appId": "2db3304b-2d5d-4f35-a860-6c4d315ade1a",
                "mergedCustomerId": null,
                "headportraitUrl": "https://xxxx.png",
                "groupId": null,
                "sex": 2,
                "address": null,
                "ageState": 0,
                "fixedPhone": null,
                "createdAt": "2017-12-26 16:23:54",
                "updatedAt": "2017-12-26 16:23:54"
            }
        },
        {
            "id": "88544513-e549-48ad-b95d-3b9073148263",
            "appId": "2db3304b-2d5d-4f35-a860-6c4d315ade1a",
            "audioUrl": null,
            "m4aAudioUrl": null,
            "duration": 0,
            "callStatus": 0,
            "audioStatus": 2,
            "callTime": "2017-12-28 10:06:41",
            "endTime": null,
            "asyncTaskId": null,
            "fromUserId": "4840",
            "toUserId": "76fd5134-0c1f-40f6-9814-deeadf1a965b",
            "fromUserType": 2,
            "toUserType": 1,
            "photoURI": "https://xxxx.png",
            "name": "jacky",
            "phoneNum": "xxxx",
            "customer": {
                "name": "xxxx",
                "title": "",
                "email": "demo@kuick.cn",
                "phone": "xxxx",
                "company": "",
                "status": 1,
                "id": "76fd5134-0c1f-40f6-9814-deeadf1a965b",
                "appId": "xxxx",
                "mergedCustomerId": null,
                "headportraitUrl": "https://xxxx.png",
                "groupId": null,
                "sex": 2,
                "address": null,
                "ageState": 0,
                "fixedPhone": null,
                "createdAt": "2017-12-27 23:16:08",
                "updatedAt": "2017-12-27 23:16:08"
            }
        }
    ]
}

正常返回结果说明

字段名称 字段类型 字段说明
status int 返回结果状态,0:失败,1:成功
data array 返回结果列表
id string 通话记录id
appId string 项目id
audioUrl string 通话录音地址,mp3格式
m4aAudioUrl string 通话录音地址,mp4格式
duration int 通话时长,单位秒
callStatus int 通话状态,0:未接通,1:已接通
audioStatus int 通话录音处理状态,0:未处理、1:处理成功、2:处理失败
callTime date 通话拨打时间
endTime date 通话结束时间
asyncTaskId string 通话录音处理任务记录id
fromUserType int 通话发起方用户类型,1:客户、2:KuickDeal用户:2
fromUserId string 通话发起方用户id,即:当fromUserType为1时,formUserId为客户id
toUserType int 接收方用户类型,1:客户、2:KuickDeal用户:2
toUserId string 接收方用户id,即:当toUserType为1时,toUserId为客户id
photoURI string 接收方用户头像
name string 接收方用户名称
phoneNum string 接收方用户手机号
name string 接收方用户名称
customer object 客户对象
customer.name string 客户名称
customer.title string 客户职位
customer.email string 客户邮箱
customer.phone string 客户手机号
customer.company string 客户公司
customer.status int 客户状态,1:正常,0:删除
customer.id string 客户id
customer.appId string 项目id
customer.mergedCustomerId string 客户合并之前的客户id
customer.headportraitUrl string 客户头像
customer.groupId string 客户所属分组id
customer.sex int 客户性别,0:女、1:男、2:未知
customer.address string 客户详细地址
customer.ageState int 客户年龄段, -1:未选择,0:25~35,1:35~45,2:45~55:,3:55~65,4:65以上
customer.fixedPhone string 客户座机号
customer.createdAt date 客户创建时间
customer.updatedAt date 客户修改时间

异常返回结果

{
    "status": 0,
    "code": "Bad Request",
    "msg": "Required String parameter 'app_id' is not present"
}

异常返回结果说明

字段名称 字段类型 字段说明
status int 返回结果状态,0:失败,1:成功
code string 错误吗
msg string 接口调用错误信息

获取链接发送历史

请求地址

GET https://deal-api.kuick.cn/api/v1.7/app/{app-id}/links

是否需要认证

参数说明

参数名称 参数类别 是否必填 参数说明
app-id string 项目id
参数名称 参数类别 是否必填 参数说明
kuick_user_id string KuickDeal用户id
with_url int 返回结果中是否带链接的完整url,值为1时返回结果包含链接完整url
start_index int 分页开始索引,例如:第一页时,start_index为0,每页20条数据时,第二页时,start_index为20
count int 每页显示条数

正常返回结果

{
    "status": 1,
    "data": [
        {
            "id": "596e533e-8633-4c02-8d27-67f58ffc6d40",
            "appId": "2db3304b-2d5d-4f35-a860-6c4d315ade1a",
            "name": "这是链接名称",
            "shortName": "dcda0660-0e62-11e8-9cfe-0dd4c4c2b853",
            "creatorId": "4840",
            "creatorName": "xxxx",
            "conferenceId": "8243",
            "remark": "",
            "file1": "11925",
            "file2": "",
            "file3": "",
            "file4": "",
            "shareToken": "39pYRE1s",
            "formType": "",
            "formPosition": 0,
            "type": 1,
            "website": "",
            "clueId": null,
            "src": "link_view",
            "formPopTime": "",
            "isDirectional": 1,
            "customerId": "d4c340ee-8c3e-48f0-9c5a-41a1de313f1f",
            "newViewCount": 1,
            "newViewerCount": 1,
            "createdAt": "2018-02-10 21:04:00",
            "updatedAt": "2018-02-10 21:04:00",
            "officialAccountId": "8692790f-d9e4-4dd9-bc5d-48fd35e15805",
            "weixinGrantType": 0,
            "utmSource": null,
            "utmMedium": null,
            "utmCampaign": null,
            "utmContent": null,
            "utmTerm": null,
            "customer": {
                "id": "d4c340ee-8c3e-48f0-9c5a-41a1de313f1f",
                "appId": "2db3304b-2d5d-4f35-a860-6c4d315ade1a",
                "name": "xxxx",
                "title": null,
                "email": null,
                "phone": "xxxx",
                "company": null,
                "status": 1,
                "mergedCustomerId": null,
                "headportraitUrl": "https://xxxx.png",
                "createdAt": "2018-02-10 20:51:41",
                "updatedAt": "2018-02-10 20:51:41"
            },
            "linkViewLogCount": 1,
            "clueCount": 0,
            "viewerCount": 1,
            "url": "https://xxxx"
        },
        {
            "id": "7d07c510-174a-4582-b9b2-50e922fb7fac",
            "appId": "2db3304b-2d5d-4f35-a860-6c4d315ade1a",
            "name": "这是链接名称",
            "shortName": "3b747180-0e11-11e8-9cfe-0dd4c4c2b853",
            "creatorId": "4840",
            "creatorName": "xxxx",
            "conferenceId": "8243",
            "remark": "",
            "file1": null,
            "file2": "",
            "file3": "",
            "file4": "",
            "shareToken": "39pYRE1s",
            "formType": "",
            "formPosition": 0,
            "type": 3,
            "website": "https://www.baidu.com",
            "clueId": null,
            "src": "link_view",
            "formPopTime": "",
            "isDirectional": 0,
            "customerId": null,
            "newViewCount": 0,
            "newViewerCount": 0,
            "createdAt": "2018-02-10 11:19:40",
            "updatedAt": "2018-02-10 11:19:40",
            "officialAccountId": null,
            "weixinGrantType": 1,
            "utmSource": "百度",
            "utmMedium": "媒介",
            "utmCampaign": "活动",
            "utmContent": "内容",
            "utmTerm": "关键词",
            "linkViewLogCount": 1,
            "clueCount": 0,
            "viewerCount": 1,
            "url": "https://xxxx?share_token=39pYRE1s&utm_source=百度&utm_medium=媒介&utm_campaign=活动&utm_content=内容&utm_term=关键词"
        }
    ]
}

正常返回结果说明

字段名称 字段类型 字段说明
status int 返回结果状态,0:失败,1:成功
data array 返回结果列表
id string 链接记录id
appId string 项目id
name string 链接名称
shortName string 链接短名称,暂未使用
creatorId string 链接创建人id,即:KuickDeal用户id
creatorName string 链接创建人名称,即:KuickDeal用户名称
conferenceId string 会议记录id
remark string 链接备注
file1 string 链接关联文件id,文件链接时值不为空
file2 string 链接关联文件id,暂未使用该字段
file3 string 链接关联文件id,暂未使用该字段
file4 string 链接关联文件id,暂未使用该字段
shareToken string 链接分享token
formType string 链接插入表单类型,固定值为1
formPosition int 链接插入表单位置
type int 链接类型,1:文件资料链接,2:网页资料链接,3:重定向链接
website string 网页类型链接及重定向链接填写的网址
clueId string 链接表单记录id
src string 链接创建来源,默认为link_view
formPopTime date 链接表单弹出时间,暂未使用该字段
isDirectional int 是否为定向链接,0:非定向,1:定向
customerId string 定向的客户id,isDirectional为1时customerId不为空
newViewCount int 新增浏览次数
newViewerCount int 新增浏览人数
createdAt date 链接创建时间
updatedAt date 链接编辑时间
officialAccountId string 链接关联公众号记录id
weixinGrantType int 微信授权类型,0:隐式授权,1:显示授权
utmSource string utm来源
utmMedium string utm媒介
utmCampaign string utm活动
utmContent string utm内容
utmTerm string utm关键词
linkViewLogCount int 链接浏览总次数
clueCount int 链接表单提交总次数
viewerCount int 链接浏览总人次数
url string 链接访问地址,调用API时有参数with_url=1时返回结果包含该字段
customer object 客户对象,定向链接时返回结果包含该字段
customer.name string 客户名称
customer.title string 客户职位
customer.email string 客户邮箱
customer.phone string 客户手机号
customer.id string 客户id
customer.appId string 项目id
customer.mergedCustomerId string 客户合并之前的客户id
customer.headportraitUrl string 客户头像
customer.createdAt date 客户创建时间
customer.updatedAt date 客户修改时间

异常返回结果

NEED_AUTH

异常返回结果说明

没有权限调用API

获取链接详情

请求地址

GET https://deal-api.kuick.cn/api/v1.7/link/{link-id}/view-logs

是否需要认证

参数说明

参数名称 参数类别 是否必填 参数说明
link-id string 链接记录id
参数名称 参数类别 是否必填 参数说明
start_index int 分页开始索引,例如:第一页时,start_index为0,每页20条数据时,第二页时,start_index为20
count int 每页显示条数

正常返回结果

{
    "status": 1,
    "data": [
        {
            "id": "52aa1521-cac3-48f5-ab48-2286f32ba2fe",
            "viewerId": "a98b74f6-c0f7-4108-892c-94ad113ff2aa",
            "viewerName": "匿名浏览者3",
            "ip": "61.148.205.234",
            "location": "北京市",
            "system": "iOS 11.2.532",
            "client": "MicroMessenger(微信) 6.6.1",
            "linkId": "305b3d04-4b1c-4a4f-bd5b-b66f90152a77",
            "clueId": null,
            "viewTime": "2018-02-27 11:10:18",
            "leaveTime": "2018-02-27 11:10:32",
            "spreadId": "",
            "utmSource": "testzhu",
            "utmMedium": "",
            "utmCampaign": "",
            "utmContent": "",
            "utmTerm": "",
            "linkName": "20170710KuickDeal介绍",
            "totalDuration": 12846,
            "totalPage": 5,
            "durations": [
                {
                    "id": "da935b96-5129-4539-8a43-9c6304d9d85e",
                    "fileId": "11258",
                    "pageIndex": "0",
                    "duration": "944",
                    "linkViewLogId": "52aa1521-cac3-48f5-ab48-2286f32ba2fe",
                    "sortIndex": 0,
                    "createdAt": "2018-02-27 11:10:19",
                    "endedAt": "2018-02-27 11:10:19",
                    "fileName": "20170710KuickDeal介绍.pdf",
                    "fileURL": "https://cdn-img-oss-prod.kuick.cn/conference/8237/ppt/7a496b51-4f8c-4e89-9dd9-eca6aabbb1ce/img/pict-1.png",
                    "total": 12846
                },
                {
                    "id": "3cd8cf80-e55c-4a9f-a6c2-bceb8647eee5",
                    "fileId": "11258",
                    "pageIndex": "0",
                    "duration": "22",
                    "linkViewLogId": "52aa1521-cac3-48f5-ab48-2286f32ba2fe",
                    "sortIndex": 1,
                    "createdAt": "2018-02-27 11:10:20",
                    "endedAt": "2018-02-27 11:10:20",
                    "fileName": "20170710KuickDeal介绍.pdf",
                    "fileURL": "https://cdn-img-oss-prod.kuick.cn/conference/8237/ppt/7a496b51-4f8c-4e89-9dd9-eca6aabbb1ce/img/pict-1.png",
                    "total": 12846
                },
                {
                    "id": "1eef2d06-3f2f-4df7-896e-19b242d20fe6",
                    "fileId": "11258",
                    "pageIndex": "1",
                    "duration": "1000",
                    "linkViewLogId": "52aa1521-cac3-48f5-ab48-2286f32ba2fe",
                    "sortIndex": 2,
                    "createdAt": "2018-02-27 11:10:21",
                    "endedAt": "2018-02-27 11:10:20",
                    "fileName": "20170710KuickDeal介绍.pdf",
                    "fileURL": "https://cdn-img-oss-prod.kuick.cn/conference/8237/ppt/7a496b51-4f8c-4e89-9dd9-eca6aabbb1ce/img/pict-2.png",
                    "total": 12846
                },
                {
                    "id": "4925efdb-5427-4ba9-a789-52d43e07b8bf",
                    "fileId": "11258",
                    "pageIndex": "2",
                    "duration": "880",
                    "linkViewLogId": "52aa1521-cac3-48f5-ab48-2286f32ba2fe",
                    "sortIndex": 3,
                    "createdAt": "2018-02-27 11:10:21",
                    "endedAt": "2018-02-27 11:10:21",
                    "fileName": "20170710KuickDeal介绍.pdf",
                    "fileURL": "https://cdn-img-oss-prod.kuick.cn/conference/8237/ppt/7a496b51-4f8c-4e89-9dd9-eca6aabbb1ce/img/pict-3.png",
                    "total": 12846
                },
                {
                    "id": "caed2f2b-d268-430a-be19-36ca955c9234",
                    "fileId": "11258",
                    "pageIndex": "3",
                    "duration": "10000",
                    "linkViewLogId": "52aa1521-cac3-48f5-ab48-2286f32ba2fe",
                    "sortIndex": 4,
                    "createdAt": "2018-02-27 11:10:22",
                    "endedAt": "2018-02-27 11:10:32",
                    "fileName": "20170710KuickDeal介绍.pdf",
                    "fileURL": "https://cdn-img-oss-prod.kuick.cn/conference/8237/ppt/7a496b51-4f8c-4e89-9dd9-eca6aabbb1ce/img/pict-4.png",
                    "total": 12846
                }
            ],
            "canBeCreateCustomer": false
        }
    ]
}

正常返回结果说明

字段名称 字段类型 字段说明
status int 返回结果状态,0:失败,1:成功
data array 返回结果列表
id string 链接浏览记录id
viewerId string 链接浏览用户id
viewerName string 链接浏览名称
ip string 链接浏览用户ip
location string 链接浏览用户地理位置
system string 浏览链接操作系统
client string 浏览链接客户端
linkId string 链接记录id
clueId string 浏览链接填写表单记录id
viewTime date 浏览链接开始时间
leaveTime string 浏览链接结束时间
spreadId string 链接传播记录id
utmSource string utm来源
utmMedium string utm媒介
utmCampaign string utm活动
utmContent string utm内容
utmTerm string utm关键词
linkName string 链接名称
totalDuration int 链接浏览总时长,单位毫秒
totalPage int 链接浏览总页数
canBeCreateCustomer boolean 链接浏览用户是否可以添加为客户,true:可以添加为客户、false:不可以添加为客户【已经为客户时
durations array 浏览链接翻页数据
id string 浏览链接翻页记录id
fileId string 链接关联文件记录id
fileName string 链接关联文件名称
fileURL string 当前页面文件地址
pageIndex string 文件页面索引
duration string 每一页文件浏览时长,单位毫秒
linkViewLogId string 链接浏览记录id
sortIndex int 翻页排序索引
createdAt date 翻页记录创建时间
endedAt date 翻页记录结束时间
total int 链接浏览总时长,单位毫秒

异常返回结果

NEED_AUTH

异常返回结果说明

没有权限调用API

获取邮件发送历史

请求地址

GET https://deal-api.kuick.cn/api/v1.7/posts

是否需要认证

参数说明

参数名称 参数类别 是否必填 参数说明
app_id string 项目id
owner_id string KuickDeal用户id
start_index int 分页开始索引,例如:第一页时,start_index为0,每页20条数据时,第二页时,start_index为20
count int 每页显示条数

正常返回结果

[
    {
        "appId": "2db3304b-2d5d-4f35-a860-6c4d315ade1a",
        "ownerId": "4840",
        "ownerName": null,
        "postId": "4c867387-807a-4378-9de5-244583c2efc6",
        "title": "群发",
        "sendWay": "email",
        "sendTime": "2018-01-19 11:25:03",
        "senderCount": 33,
        "successLogCount": 0,
        "viewLogCount": 0,
        "linkViewLogCount": 0,
        "returnLogCount": 0,
        "viewLogUserCount": 0,
        "linkViewLogUserCount": 0,
        "returnLogUserCount": 0
    },
    {
        "appId": "2db3304b-2d5d-4f35-a860-6c4d315ade1a",
        "ownerId": "4840",
        "ownerName": null,
        "postId": "aaf61aff-f6d8-4ba0-89df-88fd7e84f294",
        "title": "测试数据",
        "sendWay": "email",
        "sendTime": "2018-01-05 10:37:34",
        "senderCount": 33,
        "successLogCount": 0,
        "viewLogCount": 0,
        "linkViewLogCount": 0,
        "returnLogCount": 0,
        "viewLogUserCount": 0,
        "linkViewLogUserCount": 0,
        "returnLogUserCount": 0
    }
]

正常返回结果说明

字段名称 字段类型 字段说明
appId string 项目id
ownerId string 邮件群发所属人id,即KuickDeal用户id
ownerName string 邮件群发所属人名称,即KuickDeal用户名称
postId string 邮件群发记录id
title string 邮件群发主题
sendWay string 发送方式,固定为“email”
sendTime date 发送时间
senderCount int 发送对象数
successLogCount int 发送成功数
viewLogCount int 邮件打开次数
viewLogUserCount int 邮件打开人数
linkViewLogCount int 邮件内容中链接的点击次数
linkViewLogUserCount int 邮件内容中链接的点击人数
returnLogCount int 查看邮件后网站回访次数
returnLogUserCount int 查看邮件后网站回访人数

异常返回结果

NEED_AUTH

异常返回结果说明

没有权限调用API
北京西会科技有限公司©2015-2018 all right reserved,powered by Gitbook该文件修订时间: 2018-11-21 01:53:15

results matching ""

    No results matching ""