SMS Template API

HTTP Authentication

Use HTTP Basic Authentication to do access authorization. In this way, the entire API request can be completed by common HTTP tools such as curl, browser plugins, etc.

A field (Key/Value pair) is added in the HTTP Header：

Authorization: Basic base64_auth_string

The generation algorithm of base64_auth_string is: base64(appKey:masterSecret), that is: appKey plus a colon, plus string assembled by masterSecret, and then do a base64 conversion. appKey, masterSecret can be viewed in the application settings of console.

Create Template API

Function Description

• Create SMS template

Call Address

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

Request Example

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": "此模板用于用户注册"
}'

Parameters

Return Example

Successful Request

{"temp_id": 37582}

Failed Request

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

Modify Template API

Function Description

• Modify the template that failed the audit and submit the audit again

Call Address

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

Request Example

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": "此模板用于用户注册"
}'

Parameters

Return Example

Successful Request

{"temp_id": 37582}

Failed Request

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

Query Template API

Function Description

• Query SMS template

Call Address

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

Request Example

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

Return Example

Successful Request

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

Failed Request

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

Delete Template API

Function Description

• Delete SMS template

Call Address

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

Request Example

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

Return Example

Successful Request

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

Failed Request

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

Return Code