短信模板

通过以下接口可以对短信模板进行添加、修改、删除操作，可以对短信和彩信模板进行查询、提交审核操作。

查询单个模板

返回短信模板的基本信息

URL 

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

HTTP请求方式

post    get

参数说明

参数 类型 必须 说明
smsUser string 是 smsUser
templateIdStr string 是 模板ID
signature string 是 数字签名, 合法性验证

请求示例

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

返回值说明

参数 说明
templateId 短信模板ID
templateName 短信模板名称
msgType 业务类型
smsType 内容类型
isVerify 是否审核通过
templateContent 短信模板内容
createTime 短信模板创建时间
updateTime 短信模板更新时间

返回值示例

{
    "info": {
        "templateId": 00,
        "templateName": "验证码",
        "msgType": "国内短信",
        "smsType": "验证码",
        "templateContent": "【爱发信】短息api模板",
        "isVerify": "审核通过",
        "createTime": "2015-03-23",
        "updateTime": "2017-03-29"
    },
    "message": "请求成功",
    "result": true,
    "statusCode": 200
}

查询多个模板

返回短信模板的基本信息

URL 

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

HTTP请求方式

post    get

参数说明

参数 类型 必须 说明
smsUser string 是 smsUser
templateIdStr string 否 模板ID, 多个用;分隔
start int 否 查询起始位置, 取值区间 [0-], 默认为 0
limit int 否 查询个数, 取值区间 [0-100], 默认为 100
isVerifyStr string 否 是否通过验证；"0"待审核 "1"审核通过"-1"审核不通过 -2"未提审"
signature string 是 数字签名, 合法性验证

注意:

  1. 用户可指定模板ID进行查询，未指定时，默认查询全部模板
  2. 查询起始位置，取值为 [0-]默认为0
  3. 查询个数限制为0-100，默认为100

请求示例

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

返回值说明

参数 说明
templateId 短信模板ID
templateName 短信模板名称
msgType 业务类型
smsType 内容类型
isVerify 是否审核通过
templateContent 短信模板内容
templateCreateTime 短信模板创建时间
templateUpdateTime 短信模板更新时间

返回值示例

{
    "result" : true,
    "statusCode" : 200,
    "message" : "请求成功",
    "info" : {
        "total" : 2,
        "list" : [{
                "templateContent" : "【SendCloud】闪达科技",
                "templateCreateTime" : "2016-08-25",
                "templateId" : 00,
                "templateName" : "中秋快乐",
                "msgType" : "国内短信",
                "smsType" : "验证码",
                "isVerify" : "审核通过",
                "templateUpdateTime" : "2016-08-25"
            }, {
                "templateContent" : "【爱发信】闪达科技",
                "templateCreateTime" : "2016-08-25",
                "templateId" : 01,
                "templateName" : "国庆快乐",
                "msgType" : "国内短信",
                "smsType" : "验证码",
                "isVerify" : "审核通过",
                "templateUpdateTime" : "2016-08-25"
            }
        ]
    }
}

添加模板

返回是否添加成功的信息

URL 

https://api.sendcloud.net/smsapi/addsms

HTTP请求方式

post    get

参数说明

参数 类型 必须 说明
smsUser string 是 smsUser
templateName string 是 模板名称，不能重复
templateText string 是 模板内容
signName string * 短信内容中的中括号里面的签名
signId Integer * 短信签名的id
signPositionStr string 否 签名位置，"0"代表前置"1"代表后置，默认前置。仅msgType=2时，本参数生效。
smsTypeStr string 是 短信内容类型，"0"表示验证码，"1"表示行业通知，"2"表示营销
signature string 是 数字签名, 合法性验证
msgType string 否 业务类型，"0"代表国内短信，"2"代表国际短信，默认国内短信
sendToSubscriber string 否 是否会员发送(必须是数值字符串，且只能是0或1)，"0"代表会员发送，"1"代表非会员发送。若内容类型为行业通知或营销，请填写此参数
estimateSendNum string 否 预估发送量(必须是数值字符串，最大只能是2147483647)，。若内容类型为行业通知或营销，请填写此参数
sendContentExample string 否 发送示例内容，若模版中使用变量，请填写发送示例

注意:

  1. signId为短信签名的id，非国际短信signId和signName两个参数只需传一个，如果signId不为空，signName自动忽略，国际短信可不传signId和signName
  2. 创建模板，所传签名必须是审核通过的

请求示例

https://api.sendcloud.net/smsapi/addsms?smsUser=***&templateName=***&templateText=***&signName=***&signPositionStr=**8&smsTypeStr=***&signature=***&msgType=***

返回值说明

参数 说明
templateId 短信模板ID

返回值示例

{
    "info" : {
        "templateId" : 3381
    },
    "message" : "插入成功",
    "result" : true,
    "statusCode" : 200
}

提交审核

返回是否提交成功的基本信息

URL 

https://api.sendcloud.net/smsapi/submitsms

HTTP请求方式

post    get

参数说明

参数 类型 必须 说明
smsUser string 是 smsUser
templateIdStr string 是 模板ID
signature string 是 数字签名, 合法性验证

请求示例

https://api.sendcloud.net/smsapi/submitsms?smsUser=***&templateIdStr=***&signature=***

返回值示例

{
    "result" : true,
    "statusCode" : 200,
    "message" : "提交成功",
    "info" : {}
}

更新模板

返回是否提交成功的基本信息

URL 

https://api.sendcloud.net/smsapi/updatesms

HTTP请求方式

post    get

参数说明

参数 类型 必须 说明
smsUser string 是 smsUser
templateIdStr string 是 模板ID
templateName string 是 模板名称
templateText string 否 模板内容
signName string * 短信内容中的中括号里面的签名
signId Integer * 短信签名的id
signPositionStr string 否 签名位置: "0"代表前置, "1"代表后置
smsTypeStr string 是 短信内容类型，"0"表示验证码，"1"表示行业通知，"2"表示营销
signature string 是 数字签名, 合法性验证
sendToSubscriber string 否 是否会员发送(必须是数值字符串，且只能是0或1)，"0"代表会员发送，"1"代表非会员发送。若内容类型为行业通知或营销，请填写此参数
estimateSendNum string 否 预估发送量(必须是数值字符串，最大只能是2147483647)。若内容类型为行业通知或营销，请填写此参数
sendContentExample string 否 发送示例内容，若模版中使用变量，请填写发送示例

注意:

  1. signId为短信签名的id，非国际短信signId和signName两个参数只需传一个，如果signId不为空，signName自动忽略，国际短信可不传signId和signName
  2. 签名类型需和所更新的模板本身业务类型一致，比如所更新模板业务类型是国内模板，签名类型需是国内签名，模板是国际模板，签名需是国际签名，所传签名状态需是审核通过的

请求示例

https://api.sendcloud.net/smsapi/updatesms?smsUser=***&templateIdStr=***&templateName=***&templateText=***&signName=***&signPositionStr=***&smsTypeStr=***&signature=***&msgType=***

返回值示例

{
    "result" : true,
    "statusCode" : 200,
    "message" : "更新成功",
    "info" : {}
}

删除模板

返回是否提交成功的基本信息

URL 

https://api.sendcloud.net/smsapi/deletesms

HTTP请求方式

post    get

参数说明

参数 类型 必须 说明
smsUser string 是 smsUser
templateIdStr string 是 模板ID
signature string 是 数字签名, 合法性验证

请求示例

https://api.sendcloud.net/smsapi/deletesms?smsUser=***&templateIdStr=***&signature=***

返回值示例

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