- 短信点击统计
- 分手机号统计点击
- 仅统计点击量
- 生成短链接
- 请求
- 请求参数
- 响应
- short_url参数
- Json响应示例:
- 获取短链接统计
- 请求
- 请求参数
- 响应
- Json返回示例:
- 下载短链接点击号码
- 请求
- 请求参数
- 下载短链接点击号码
- 响应
- 文件流示例:
短信点击统计
我们提供2种方式统计短链接点击:"分手机号统计点击"可以帮助您统计到具体哪些用户点击了短链接及总点击量。"仅统计点击量"可以帮助您统计短链接的点击量。
分手机号统计点击
通过API接口使用短链接统计功能(仅支持V2),步骤如下:
调用接口 /v2/short_url/shorten.json 生成短链接。
调用接口 /v2/sms/single_send.json 或 /v2/sms/batch_send.json 发送短信,短信内容中需包含上一步生成的短链接,发送时
mobile_stat
参数需要传true
.如:【云片网】请点击yp2.cn/YUNpian 了解详情。这种情况下会把短链接替换为目标手机号的专属链接(下发的每一条短信里面的短链接都不同),用于统计哪些号码的机主点击了短信中的链接(分手机号统计点击功能只支持yp2.cn的短链接,不支持t.cn的短链接)。登录官网用户控制台查看统计数据(更新频率约10min),国内短信->数据统计->点击统计。或者通过接口
下载短链接点击号码
获取。
仅统计点击量
通过API接口使用短链接统计功能(仅支持V2),步骤如下:
调用接口 /v2/short_url/shorten.json 生成短链接。
调用接口 /v2/sms/single_send.json 或 /v2/sms/batch_send.json 发送短信,短信内容中需包含上一步生成的短链接,如:【云片网】请点击t.cn/YUNpian 了解详情。
登录官网用户控制台查看统计数据(更新频率约10min),国内短信->数据统计->点击统计。
支持通过接口获取统计数据:/v2/short_url/stat.json。
生成短链接
HTTP头信息:
Accept:application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;
请求
URL:https://sms.yunpian.com/v2/short_url/shorten.json
注意:海外服务器地址 us.yunpian.com
访问方式:POST
附注:使用此接口生成短链接,然后调用特定接口(目前仅支持/v2/sms/single_send和/v2/sms/batch_send)发送带有该短链接的短信(可以不用http:// 开头),最后登录云片后台查看统计效果(10min更新一次),也可使用接口获取统计数据。限制:1秒钟内最多1次,超出限制将返回错误信息。
请求参数
参数名 | 类型 | 是否必须 | 描述 | 示例 |
---|---|---|---|---|
apikey | string | 是 | 用户唯一标识 | 9b11127a9701975c734b8aee0000000 |
long_url | string | 是 | 待转换的长网址,必须http:// 或https:// 开头 | https://www.yunpian.com |
stat_duration | integer | 否 | 点击量统计持续时间(天),过期后不再统计,区间[0,30],默认是30表示统计。 | 30 |
provider | integer | 否 | 生成的链接的域名,传入1是yp2.cn,2是t.cn,默认1 | 2 |
name | string | 否 | 取名方便区分,默认为“02-27 11:11生产的短链接” | yunpian |
响应
名称 | 类型 | 描述 |
---|---|---|
code | int | 正确为0表示成功,其他值表示错误,错误时不会有下面的数据 |
msg | string | 请求状态消息 |
short_url | json | json数组,需进一步解析 |
short_url参数
名称 | 类型 | 描述 |
---|---|---|
sid | string | 短链接唯一标识,用于获取统计数据 |
long_url | string | 原链接 |
short_url | string | 云片短链接 |
enter_url | string | 入口短链接,此为新浪短连接,若provider=1则enter_url=short_url |
name | string | 名字 |
stat_expire | string | 预计停止统计时间,为空时则没有开启统计 |
Json响应示例:
{
"code": 0,
"msg": "OK",
"short_url": {
"sid": "yUNpian",
"short_url": "https://yp2.cn/yUNpian",
"long_url": "https://www.yunpian.com",
"enter_url": "https://t.cn/EfeSeT",
"name": "02-28 19:59生成的短链接",
"stat_expire": "2019-03-30 19:59:11"
}
}
获取短链接统计
HTTP头信息:
Accept:application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;
请求
URL:https://sms.yunpian.com/v2/short_url/stat.json
注意:海外服务器地址 us.yunpian.com
访问方式:POST
附注:统计的时间粒度为10分钟,更新频率为10分钟。
请求参数
参数名 | 类型 | 是否必须 | 描述 | 示例 |
---|---|---|---|---|
apikey | string | 是 | 用户唯一标识 | 9b11127a9701975c734b8aee0000000 |
sid | string | 是 | 短链接唯一标识 | yunpian |
start_time | string | 否 | 开始时间,默认一个小时前 | 2017-03-29 11:30:00 |
end_time | string | 否 | 结束时间,默认当前时间 | 2017-03-29 12:10:00 |
响应
名称 | 类型 | 描述 |
---|---|---|
code | int | 正确为0表示成功,其他值表示错误,错误时不会有下面的数据 |
msg | string | 请求状态消息 |
stat | json | 需要进一步解析 |
Json返回示例:
{
"code": 0,
"msg": "OK",
"stat": {
"201703291130": 666,
"201703291140": 777,
"201703291150": 888,
"201703291200": 0,
"201703291210": 111
}
}
下载短链接点击号码
注意:这个接口要用GET来请求
HTTP头信息:
Accept:application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;
请求
URL:https://sms.yunpian.com/v2/short_url/clicked
注意:海外服务器地址 us.yunpian.com
访问方式:GET
请求参数
下载短链接点击号码
参数名 | 类型 | 是否必须 | 描述 | 示例 |
---|---|---|---|---|
apikey | String | 是 | 用户唯一标识 | 9b11127a9701975c734b8aee0000000 |
sid | String | 是 | 短链接唯一标识,生成短链接的接口返回 | abcDef |
start_time | String | 否 | 开始时间(用户点击) | 2017-03-29 11:30:00 |
end_time | String | 否 | 结束时间(用户点击) | 2017-03-29 12:10:00 |
响应
返回一个文件流,手机号码为去重后的文本,可指定时间范围
文件流示例:
返回的txt文件里内容如下:
13083960906
13083960906