短信模板 API

HTTP 验证

使用 HTTP Basic Authentication 的方式做访问授权。这样整个 API 请求可以使用常见的 HTTP 工具来完成，比如：curl，浏览器插件等；

HTTP Header（头）里加一个字段（Key/Value对）：

Authorization: Basic base64_auth_string

其中 base64_auth_string 的生成算法为：base64(appKey:masterSecret)，即:对 appKey 加上冒号，加上 masterSecret 拼装起来的字符串，再做 base64 转换。appKey、masterSecret 可以在控制台应用设置中查看。

创建模板 API

功能说明

• 创建短信模板

调用地址

• POST https://api.sms.jpush.cn/v1/templates

请求示例

curl --insecure -X POST -v https://api.sms.jpush.cn/v1/templates -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" -d \
'{
    "template": "您好，您的验证码是{{code}}，2分钟内有效！",
    "type": 1,
    "ttl": 120,
    "remark": "此模板用于用户注册"
}'

参数

返回示例

请求成功

{"temp_id": 37582}

请求失败

{
    "error": {
        "code": *****,
        "message": "*****"
    }
}

修改模板 API

功能说明

• 修改审核不通过的模板，并再次提交审核

调用地址

• PUT https://api.sms.jpush.cn/v1/templates/{temp_id}

请求示例

curl --insecure -X PUT -v https://api.sms.jpush.cn/v1/templates/37582 -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" -d \
'{
    "temp_id": 37582,
    "template": "您好，您的验证码是{{code}}，5分钟内有效！",
    "type": 1,
    "ttl": 300,
    "remark": "此模板用于用户注册"
}'

参数

返回示例

请求成功

{"temp_id": 37582}

请求失败

{
    "error": {
        "code": *****,
        "message": "*****"
    }
}

查询模板 API

功能说明

• 查询短信模板

调用地址

• GET https://api.sms.jpush.cn/v1/templates/{temp_id}

请求示例

curl --insecure -X GET -v https://api.sms.jpush.cn/v1/templates/37582 -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"

返回示例

请求成功

{
    "temp_id": 37582,
    "template": "您好，您的验证码是{{code}}，5分钟内有效！",
    "type": 1,
    "ttl": 300,
    "remark": "此模板用于用户注册",
    "status": 1     // 状态，0为审核中，1为审核通过，2为审核不通过
}

请求失败

{
    "error": {
        "code": *****,
        "message": "*****"
    }
}

删除模板 API

功能说明

• 删除短信模板

调用地址

• DELETE https://api.sms.jpush.cn/v1/templates/{temp_id}

请求示例

curl --insecure -X DELETE -v https://api.sms.jpush.cn/v1/templates/37582 -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"

返回示例

请求成功

HTTP/1.0 200
  Content-Type: application/json
  Content-Length: 0

请求失败

{
    "error": {
        "code": *****,
        "message": "*****"
    }
}

返回码