售前咨询
4008-753-365 , (021) 6695-7999
* 在线交谈可咨询售前、售后等问题,在您开始接入 SUBMAIL 产品时,售前顾问和售后技术支持工程师可帮助您解决遇到的任何使用问题
售前顾问咨询 09:00 - 20:00 (24x7)
5周年活动
购物车
在线商务咨询
咨询热线:4008 753 365 (021) 6695 7999
返回顶部

API: ShortURL

 

   概览

 

Shorturl是 SUBMAIL 的短网址 API。

使用 Shorturl API 可以获取、创建、编辑或删除您的短网址模板。

shorturl API 使用 HTTP 规范中的 GET, POST, PUT, DELETE 方法对模板进行操作,使用 GET 方法获取单个或全部模板、POST 方法创建新的短网址模板并提交至 SUBMAIL 人工审核、PUT 方法更新或编辑一个短网址模板,或使用 DELETE 方法删除一个模板。

短网址模板引擎支持 SUBHOOK 异步推送状态,短网址模板在后台人工审核后,会使用 SUBHOOK 进行主动推送状态。

 

   URL
<主> https://service.mysubmail.com/shorturl
   支持格式
json
 https://service.mysubmail.com/shorturl.json
默认
xml
 https://service.mysubmail.com/shorturl.xml
 
   http 请求方式
GET
获取全部短网址,或获取指定的单个短网址
POST
创建一个新的短网址
PUT
编辑或更新一个短网址
DELETE
删除一个短网址
   ShortURl GET 方法(获取短网址列表)请求参数
参数
类型
必需/可选
默认
描述

appid

string

必需

在 SUBMAIL 应用集成中创建的短网址应用 ID

short_url

string

必须

短网址链接

要获取单个模板,请将在此参数中提交您要查询的具体短链地址。为空则获取所有的短网址地址。

rows

int

可选

100

单次返回数据的行数

请将该值控制在10-1000之间,若指定了一个无效的 rows 参数,API 将默认返回 100行数据

offset

int

可选

0

数据偏移指针

该值可以指定返回数据的偏移指针,例:假如单次请求包含150条数据,rows参数采用50行,此时需要查询第51-100行的数据,请将 offset 参数设为1(即数据偏移50行)即可得到第51-100行的数据,offset=2时,将返回第101-150行数据,以此类推

timestamp

UNIX 时间戳

可选 参阅 API 授权与验证机制  >  Timestamp UNIX 时间戳

sign_type

string

可选

normal

API 授权模式(  md5 or sha1 or normal )

参阅 API 授权与验证机制  >  授权和验证方式

signature

string

必需

应用密匙 或 数字签名

参阅 API 授权与验证机制  >  授权和验证方式

   ShortURL POST 方法(创建短网址)请求参数
参数
类型
必需/可选
默认
描述

appid

string

必需

在 SUBMAIL 应用集成中创建的短网址应用 ID

url

string

必需

目标网址。

您需要处理成短链接地址的长网址地址。

group

string

可选

短网址群组ID

item

string

可选

自定义标记。

手机号码,国际手机号码,邮件地址,或任意字符串,此参数通常配合 短网址群组功能使用。(最大长度不能超过32位)

domain

string

可选 link.wiki

域名选择。

SUBMAIL提供的域名选择:link.wiki、suburl.cn、yc2.co、v2c.co、sw2.co

企业版支持自定义域名设置。

access_password

string

可选

访问密码。

免费版未开放此权限。

access_limit

int

可选

访问次数限制。

免费版未开放此权限。

expire

int

可选

设置短网址过期时间,按小时计算。默认7天后过期。

免费版未开放此权限。

tag

string

可选

此参数用于标记一次 API 请求(最大长度不超过 64 位)

添加了 tag 参数的 API 请求,会在所有的 SUBHOOK 事件中携带此参数。

timestamp

UNIX 时间戳

可选 参阅 API 授权与验证机制  >  Timestamp UNIX 时间戳

sign_type

string

可选

normal

API 授权模式(  md5 or sha1 or normal )

参阅 API 授权与验证机制  >  授权和验证方式

signature

string

必需

应用密匙 或 数字签名

参阅 API 授权与验证机制  >  授权和验证方式

   ShortURL PUT 方法(更新短网址)请求参数
参数
类型
必需/可选
默认
描述

appid

string

必需

在 SUBMAIL 应用集成中创建的短网址的应用 ID

short_url

string

必需

目标短网址

url

string

可选

目标网址

pause

string

可选

短网址模板是否暂停使用。

参数为true或者false

item

string

可选

自定义标记。

手机号码,国际手机号码,邮件地址,或任意字符串,此参数通常配合 短网址群组功能使用。(最大长度不能超过32位)

access_password

string

可选  访问密码(暂未开放权限)

access_limit

int

可选 访问次数限制(暂未开放权限)

expire

int

可选 设置短网址过期时间,按小时计算

tag

string

可选

此参数用于标记一次 API 请求(最大长度不超过 32 位)

添加了 tag 参数的 API 请求,会在所有的 SUBHOOK 事件中携带此参数。

timestamp

UNIX 时间戳

可选 参阅 API 授权与验证机制  >  Timestamp UNIX 时间戳

sign_type

string

可选

normal

API 授权模式(  md5 or sha1 or normal )

参阅 API 授权与验证机制  >  授权和验证方式

signature

string

必需

应用密匙 或 数字签名

参阅 API 授权与验证机制  >  授权和验证方式

  ShortURL DELETE 方法(删除短网址)请求参数
参数
类型
必需/可选
默认
描述

appid

string

必需

在 SUBMAIL 应用集成中创建的短网址应用 ID

short_url

string

必需

需要删除的目标短网址

timestamp

UNIX 时间戳

可选 参阅 API 授权与验证机制  >  Timestamp UNIX 时间戳

sign_type

string

可选

normal

API 授权模式(  md5 or sha1 or normal )

参阅 API 授权与验证机制  >  授权和验证方式

signature

string

必需

应用密匙 或 数字签名

参阅 API 授权与验证机制  >  授权和验证方式

   代码示例

使用 CURL GET方法获取模板列表


 

使用 CURL POST方法提交短网址


 

使用 CURL PUT 方法修改短网址模板


 

 


使用 CURL DELETE 方法删除短网址模板


 

 

    review_status 短网址状态描述
review_status : 0
未提交审核
review_status : 1
正在审核
review_status : 2
审核通过
review_status : 3
未通过审核

 

   返回码