邮件标签

标签为用户发送邮件提供了另一个维度的统计方式.

你可以使用 API 进行标签的查询, 添加, 删除, 更新操作


批量查询

URL

http://sendcloud.sohu.com/webapi/label.list.json

HTTP请求方式

post    get

参数说明

参数 类型 必须 说明
api_user string API_USER
api_key string API_KEY
query string 模糊查询的关键词
start int 查询起始位置, 取值区间 [0-], 默认为 0
limit int 查询个数, 取值区间 [0-100], 默认为 100

请求示例

http://sendcloud.sohu.com/webapi/label.list.json?api_user=***&api_key=***&start=0&limit=2

返回值说明

参数 说明
labelId 标签ID
labelName 标签名称
totalCount 所有标签个数

返回值示例

{
  "message": "success",
  "list": [
    {
      "labelId": 10,
      "labelName": "label1"
    },
    {
      "labelId": 20,
      "labelName": "label2"
    }
  ],
  "totalCount": 101
}

查询

URL

http://sendcloud.sohu.com/webapi/label.get.json

HTTP请求方式

post    get

参数说明

参数 类型 必须 说明
api_user string API_USER
api_key string API_KEY
labelId string * 标签ID
labelName string * 标签名称

提示:

  1. labelId 与 labelName 的组合 或者 labelId 参数labelName 需二者取一

请求示例

http://sendcloud.sohu.com/webapi/label.get.json?api_user=***&api_key=***&labelId=89

返回值说明

参数 说明
labelId 标签ID
labelName 标签名称

返回值示例

{
    "message":"success", 
    "label":{
            "labelId":89,
            "labelName":test
    }
}

添加

URL

http://sendcloud.sohu.com/webapi/label.create.json

HTTP请求方式

post    get

参数说明

参数 类型 必须 说明
api_user string API_USER
api_key string API_KEY
labelName string 需要添加的标签名称

请求示例

http://sendcloud.sohu.com/webapi/label.create.json?api_user=***&api_key=***&labelName=test

返回值说明

参数 说明
labelId 标签ID
labelName 标签名称

返回值示例

{
    "message":"success", 
    "label":{
            "labelId":89,
            "labelName":test
    }
}

删除

URL

http://sendcloud.sohu.com/webapi/label.delete.json

HTTP请求方式

post    get

参数说明

参数 类型 必须 说明
api_user string API_USER
api_key string API_KEY
labelId int 需要删除的标签ID

请求示例

http://sendcloud.sohu.com/webapi/label.delete.json?api_user=***&api_key=***&labelId=89

返回值说明

参数 说明
deleteCount 成功删除的个数

返回值示例

{
    "message":"success",
    "deleteCount":1
}

更新

URL

http://sendcloud.sohu.com/webapi/label.update.json

HTTP请求方式

post    get

参数说明

参数 类型 必须 说明
api_user string API_USER
api_key string API_KEY
labelId int 需要更新的标签ID
labelName string 需要更新的标签名称

请求示例

http://sendcloud.sohu.com/webapi/label.update.json?api_user=***&api_key=***&labelId=89&labelName=test

返回值说明

参数 说明
updateCount 更新成功的个数

返回值示例

{
    "message":"success", 
    "updateCount":1
}