SMS Sending API

短信发送 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.

Sending SMS with Text Verification Code API

Function Description

• Send SMS with text verification code

Call Address

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

Request Example

curl --insecure -X POST -v https://api.sms.jpush.cn/v1/codes -H "Content-Type: application/json" \
-u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" -d '{"mobile":"xxxxxxxxxxx","temp_id":*}'

Parameters

Return Example

Sent successfully

{"msg_id": "288193860302"}

Failed to send

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

Sending SMS with Voice Verification Code API

Function Description

• Send SMS with voice verification code

Call Address

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

Request Example

curl --insecure -X POST -v https://api.sms.jpush.cn/v1/voice_codes -H "Content-Type: application/json" \
-u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" -d '{"mobile":"xxxxxxxxxxxxxx", "ttl":60}'

Parameters

Return Example

Sent successfully

{"msg_id": "288193860302"}

Failed to send

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

Verification Code Verifying API

Function Description

• Verify whether the verification code is valid

Call Address

• POST https://api.sms.jpush.cn/v1/codes/{msg_id}/valid (Note: msg_id is the return value of the calling verification code API)

Request Example

curl --insecure -X POST -v https://api.sms.jpush.cn/v1/codes/288193860302/valid -H "Content-Type: application/json" \
-u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" -d '{"code":"123456"}'

Parameters

Return Example

Verification Passed

{
    "is_valid": true
}

Verification Failed

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

Sending Single Template SMS API

Function Description

• Send single template SMS

Call Address

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

Request Example

curl --insecure -X POST -v https://api.sms.jpush.cn/v1/messages -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" \
-d '{"mobile":"xxxxxxxxxxxxxx","temp_id":1,"temp_para":{"xxxx":"xxxx"}}'

Parameters

Return Example

Sent Successfully

{"msg_id": 288193860302}

Failed to Send

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

Sending Bulk Template SMS API

Function Description

• Send bulk template SMS

Call Address

• POST https://api.sms.jpush.cn/v1/messages/batch

Request Example

curl --insecure -X POST -v https://api.sms.jpush.cn/v1/messages/batch -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" -d \
'{
    "temp_id": 1250,
    "recipients": [
        {
            "mobile": "13812345678",
            "temp_para": {
                "number": "741627"
            }
        },
        {
            "mobile": "18603050709",
            "temp_para": {
                "number": "147721"
            }
        }
    ]
}'

Parameters

Return Example

Sent Successfully

{
    "success_count": 1,
    "failure_count": 1,
    "recipients": [
        {
            "msg_id": "274887115920",
            "mobile": "13812345678"
        },
        {
            "error_code": "50006",
            "error_message": "invalid mobile",
            "msg_id": "275421247364",
            "mobile": "18603050709",
            "temp_para": {
                "number": "147721"
            }
        }
    ]
}

Failed to Send

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

Return Code