SMS Lable

You can query, add, modify and delete SMS tags through the following interfaces.

---

Query a single label

Return basic information of SMS tag

URL

https://api.sendcloud.net/smsapi/label/get

HTTP Request Method

post    get

Parameter Description

parameter	type	required or not	description
smsUser	string	yes	smsUser
labelId	Integer	yes	sms label ID
signature	string	yes	digital signature, validity verification

Request Example

https://api.sendcloud.net/smsapi/label/get?smsUser=***&labelId=***&signature=***

Returned value description

parameter	description
labelId	SMS label ID
labelName	SMS label name
createTime	SMS label create time
updateTime	SMS label update time

Returned value example

{
    "info": {
        "vo": {
            "createTime": "2017-09-07 14:48:05",
            "labelId": 10,
            "labelName": "test",
            "updateTime": "2017-09-07 14:48:05"
        }
    },
    "message": "查询成功",
    "result": true,
    "statusCode": 200
}

---

Query multiple labels

URL

https://api.sendcloud.net/smsapi/label/list

HTTP Request Method

post    get

Parameter Description

parameter	type	required or not	description
smsUser	string	yes	smsUser
labelName	string	no	label Name
start	Integer	no	start position, [0-], defaults to 0
limit	Integer	no	the number of queries. The value range is [0-100]. The default value is 100
signature	string	yes	digital signature, validity verification

Request Example

https://api.sendcloud.net/smsapi/label/list?smsUser=***&signature=***

Returned value description

parameter	description
total	Number of all SMS labes of the user
count	Number of interfaces queried this time
labelId	SMS label ID
labelName	SMS label name
createTime	SMS label create time
updateTime	SMS label update time

Returned value example

{
    "info": {
        "total": 1,
        "count": 1,
        "voList": [{
                "createTime": "2017-09-07 14:48:05",
                "labelId": 10,
                "labelName": "test",
                "updateTime": "2017-09-07 14:48:05"
            }
        ]
    },
    "statusCode": 200,
    "message": "查询成功",
    "result": true
}

---

Add label

Return the basic information of SMS tag after adding successfully

URL

https://api.sendcloud.net/smsapi/label/save

HTTP Request Method

post    get

Parameter Description

parameter	type	required or not	description
smsUser	string	yes	smsUser
labelName	string	yes	label name,the upper limit of label creation is 100000
signature	string	yes	digital signature, validity verification

Request Example

https://api.sendcloud.net/smsapi/label/save?smsUser=***&labelName=***&signature=***

Returned value description

parameter	description
labelId	SMS label ID
labelName	SMS label name
createTime	SMS label create time
updateTime	SMS label update time

Returned value example

{
    "info": {
        "vo": {
            "createTime": "2017-09-08 16:31:13",
            "labelId": 11,
            "labelName": "test2",
            "updateTime": "2017-09-08 16:31:13"
        }
    },
    "statusCode": 200,
    "message": "保存成功",
    "result": true
}

---

Update label

URL

https://api.sendcloud.net/smsapi/label/update

HTTP Request Method

post    get

parameter	type	required or not	description
smsUser	string	yes	smsUser
labelId	Integer	yes	label Id
labelName	string	yes	label name
signature	string	yes	digital signature, validity verification

Request Example

https://api.sendcloud.net/smsapi/label/update?smsUser=***&laelId=***&labelName=***&signature=***

Returned value description

parameter	description
labelId	SMS label ID
labelName	SMS label name
createTime	SMS label create time
updateTime	SMS label update time

Returned value example

{
    "info": {
        "vo": {
            "createTime": "2017-09-08 16:31:13",
            "labelId": 11,
            "labelName": "test3",
            "updateTime": "2017-09-08 16:32:36"
        }
    },
    "statusCode": 200,
    "message": "更新成功",
    "result": true
}

---

Delete label

URL

https://api.sendcloud.net/smsapi/label/delete

HTTP Request Method

post    get

parameter	type	required or not	description
smsUser	string	yes	smsUser
labelId	Integer	yes	label ID
signature	string	yes	digital signature, validity verification

Request Example

https://api.sendcloud.net/smsapi/label/delete?smsUser=***&id=***&signName=***&signType=***&signature=***

Returned value example

{
    "info": {},
    "message": "删除成功",
    "result": true,
    "statusCode": 200
}