API开放平台

TIP

# 开放接口API说明-企业头条接口

# 推送接口

接口说明：推送客户头条阅读时长。客户在勤策订货完成有效阅读时，进行推送 请求方式： POST（HTTPS）
请求地址： 第三方服务接口URL
请求参数：

参数名称 参数值
msgId 消息ID
dataId 数据ID
dataVersion 接口数据版本，如：001
dataFormat 数据格式：json
dataSource 数据来源。biz：业务功能产生，api：开放接口产生
timestamp 请求时间戳，如：1503276678552
status 数据同步状态。0：数据首次同步，2：数据失败同步
statusTime 上次同步失败时间。格式：yyyy-MM-dd HH:mm:ss
tenantId 企业ID，各注册企业在勤策中对应的唯一ID
digest 数据签名，md5(data|pushsecret|timestamp)
dataType notice
data <<请求数据体>> ，说明：格式为JSON格式数据

请求数据体：

{
    "id": "9082305616016928196",
    "cmId": "4678348326854106720",
    "readStartTime": "2022-04-11 11:43:57",
    "readTotalTime": "11",
    "noticeName": "标题"
}

参数说明：

参数 类型 必填 说明
id VARCHAR(32) 是 头条ID
cmId VARCHAR(32) 是 客户ID
readStartTime VARCHAR(100) 是 本次阅读时间
readTotalTime VARCHAR(100) 是 本次阅读时长
noticeName VARCHAR(200) 是 企业头条标题

响应示例：

{
 "return_code": 0,
 "return_msg": ""
}

参数说明：

参数 类型 说明
return_code int 响应编码。0：成功，1：失败
return_msg String 响应说明

# 企业头条浏览时长查询接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/notice/v1/queryMendianNotice/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "create_start_time": "2021-01-01 00:00:00",
    "create_end_time": "2022-01-20 00:00:00",
    "page_number":1,
    "page_size":1000
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
create_start_time VARCHAR(32) 否 企业头条创建开始时间
create_end_time VARCHAR(32) 否 企业头条创建结束时间
page_number INT 是 页码默认1，每页默认1000条
page_size INT 否 每页记录条数，默认最大是1000条，可以根据业务数据的大小自行优化调整

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
    {
        "notice_id":9074661587937863089,
        "store_id":6851186861578848677,
        "read_start_time":"2022-01-19 19:16",
        "read_total_time": "206"
    }
]

参数说明：

参数 类型 必填 说明
notice_id VARCHAR(32) 是 头条id
store_id VARCHAR(32) 是 客户id
read_start_time VARCHAR(32) 否 阅读时间
read_total_time VARCHAR(32) 否 阅读时长

← 投诉反馈相关 →