SMS Signature

You can query, add or modify signature through the following interfaces.

Query single signature

Return to SMS signature

URL

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

HTTP Request Method

post    get

Parameter Description

parameter	type	required or not	description
smsUser	string	yes	smsUser
id	Integer	yes	signature ID
signature	string	yes	signature, validity verification

Request Example

https://api.sendcloud.net/smsapi/sign/get?smsUser=***&id=***&signature=***

Returned value description

parameter	description
id	SMS signature ID
signName	signature name
signTypeDesc	signature type description
verifyStatus	verify status
createTime	time of signature creation
updateTime	time of signature update

Returned value example

{
    "info": {
        "smsSignVo": {
            "createTime": "2015-04-10 10:44:37",
            "id": 0,
            "signName": "闪闪",
            "signTypeDesc": "国内短信",
            "updateTime": "2016-06-14 19:20:35",
            "verifyStatus": "审核通过"
        }
    },
    "statusCode": 200,
    "message": "获取短信签名成功",
    "result": true
}

Query multiple signature

Return to SMS signature

URL

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

HTTP Request Method

post    get

Parameter Description

parameter	type	required or not	description
smsUser	string	yes	smsUser
signature	string	yes	signature, validity verification

Request Example

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

Returned value description

parameter	description
id	SMS signature ID
signName	signature name
signTypeDesc	signature type description
verifyStatus	verify status
createTime	time of signature creation
updateTime	time of signature update

Returned value example

{
    "info": {
        "voList": [{
                "createTime": "2015-04-10 10:44:37",
                "id": 1427,
                "signName": "闪达",
                "signTypeDesc": "国内短信",
                "updateTime": "2016-06-14 19:20:35",
                "verifyStatus": "审核通过"
            }, {
                "createTime": "2017-06-27 14:24:31",
                "id": 1429,
                "signName": "闪达1",
                "signTypeDesc": "国内短信",
                "updateTime": "2017-06-27 14:24:31",
                "verifyStatus": "待审核"
            }, {
                "createTime": "2017-06-27 14:24:45",
                "id": 1430,
                "signName": "闪达2",
                "signTypeDesc": "国内短信",
                "updateTime": "2017-06-27 14:24:45",
                "verifyStatus": "待审核"
            }
        ]
    },
    "statusCode": 200,
    "message": "获取短信签名成功",
    "result": true
}

Add signature

Return to the added SMS signature

URL

https://api.sendcloud.net/smsapi/sign/add

HTTP Request Method

post    get

Parameter Description

|parameter|position|type|required or not|description| |:---|:---|:---|:---|:---|:---| |smsUser|query|string|是|smsUser| |signName|query|string|是|签名名称| |signType|query|string|是|签名类型 0 国内 1 国际| |signSource|query|string|是|签名来源 0企事业单位的全称或简称 1工信部备案网站的全称或简称 2已上线APP应用的全称或简称 3公众号或小程序的全称或简称 4电商平台店铺名的全称或简称 5商标名的全称或简称| |isThirdRights|query|string|是|是否涉及第三方权益: 0否 1是| |signature|query|string|是|数字签名, 合法性验证| |businessLicenseImg|body|string(binary)|否|当isThirdRights参数为1时则必传。文件大小上限2MB.不参与数字签名| |otherImgs|body|string(binary)|否|附加图片，最大个数3个。每个文件大小上限2MB.不参与数字签名|

说明：

若传businessLicenseImg或otherImgs 文件时，必须用表单提交（form-data）；若不传文件，则用x-www-form-urlencoded
仅通过短信备案的账号，可以调用，否则报错 "短信未备案，请登录网站提交短信备案"

Request Example

businessLicenseImg: file://C:\Users\Administrator\Pictures\dog.jpg
otherImgs:
  - file://C:\Users\Administrator\Pictures\linglong1.jpg
  - file://C:\Users\Administrator\Pictures\linglong2.jpg
  - file://C:\Users\Administrator\Pictures\linglong3.jpg

Returned value example

{

    "result": true,
    "statusCode": 200,
    "message": "请求成功",
    "info": {
        "id": 11617     #签名ID
    }
}

Update signature

Return to updated SMS signature

URL

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

HTTP Request Method

post    get

|parameter|position|type|required or not|description| |:---|:---|:---|:---|:---|:---| |smsUser|query|string|是|smsUser| |id|query|string|是|签名ID| |signName|query|string|否|签名名称| |signType|query|string|否|签名类型 0 国内 1 国际| |signSource|query|string|否|签名来源 0企事业单位的全称或简称 1工信部备案网站的全称或简称 2已上线APP应用的全称或简称 3公众号或小程序的全称或简称 4电商平台店铺名的全称或简称 5商标名的全称或简称| |isThirdRights|query|string|否|是否涉及第三方权益: 0否 1是| |signature|query|string|是|数字签名, 合法性验证| |businessLicenseImg|body|string(binary)|否|当isThirdRights参数为1时则必传。文件大小上限2MB。不参与数字签名| |otherImgs|body|string(binary)|否|附加图片，最大个数3个。每个文件大小上限2MB。不参与数字签名|

说明：

若传businessLicenseImg或otherImgs 文件时，必须用表单提交（form-data）；若不传文件，则用x-www-form-urlencoded
仅可修改审核不通过的短信签名

Request Example

businessLicenseImg: file://C:\Users\Administrator\Pictures\dog.jpg
otherImgs:
  - file://C:\Users\Administrator\Pictures\linglong1.jpg
  - file://C:\Users\Administrator\Pictures\linglong2.jpg
  - file://C:\Users\Administrator\Pictures\linglong3.jpg

Delete signature

URL

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

HTTP Request Method

post    get

|parameter|position|type|required or not|description| |:---|:---|:---|:---|:---|:---| |smsUser|query|string|是|smsUser| |id|query|string|是|签名ID| |signature|query|string|是|数字签名, 合法性验证|