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

API: shorturl/group  

 

   概览

 

shorturl/group是 SUBMAIL 的短网址群组 API。

使用 shorturl/group API 可以获取、创建、编辑或删除您的短网址群组。

shorturl/group API 使用 HTTP 规范中的 GET, POST, PUT, DELETE 方法对模板群组进行操作,使用 GET 方法获取单个或全部短网址群组、POST 方法创建新的短网址群组、PUT 方法更新或编辑一个短网址群组,或使用 DELETE 方法删除一个短网址群组。

 

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

appid

string

必需

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

group

string

可选

短网址群组ID

要获取单个短网址群组,请将在此参数中提交您要查询的具体群组id。为空则获取所有的短网址群组列表。

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/group POST 方法(创建短网址群组)请求参数
参数
类型
必需/可选
默认
描述

appid

string

必需

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

name

string

必需

短网址群组名称

timestamp

UNIX 时间戳

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

sign_type

string

可选

normal

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

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

signature

string

必需

应用密匙 或 数字签名

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

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

appid

string

必需

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

name

string

必需

短网址群组名称

group

string

必需

要修改的短网址群组ID

timestamp

UNIX 时间戳

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

sign_type

string

可选

normal

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

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

signature

string

必需

应用密匙 或 数字签名

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

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

appid

string

必需

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

group

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 方法删除短网址群组


 
 

 

   返回码