Scheduled SMS 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.

Single Scheduled SMS Submitting API

Function Description

• Submit sending tasks of single scheduled SMS

Call Address

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

Request Example

curl --insecure -X POST -v https://api.sms.jpush.cn/v1/schedule -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" -d \
'{
    "send_time": "2017-07-01 09:00:00",
    "mobile": "13812345678",
    "temp_id": 1250,
    "temp_para": {
        "number": "741627"
    }
}'

Parameters

Return Example

Successful Request

{"schedule_id": "1a886e7c-a267-49e6-9970-0d396ca5bb1e"}

Failed Request

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

Scheduled SMS Bulk Submitting API

Function Description

• Submit sending tasks of bulk scheduled SMS

Call Address

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

Request Example

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

Parameters

Return Example

Successful Request

{
    "schedule_id": "1a886e7c-a267-49e6-9970-0d396ca5bb1e",
    "success_count": 1,
    "failure_count": 1,
    "failure_recipients": [
        {
            "error_code": "50006",
            "error_message": "invalid mobile",
            "mobile": "18603050709",
            "temp_para": {
                "number": "147721"
            }
        }
    ]
}

Failed Request

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

Single Scheduled SMS Modifying API

Function Description

• Modify sending tasks of single scheduled SMS

Call Address

• PUT https://api.sms.jpush.cn/v1/schedule/{schedule_id}

Request Example

curl --insecure -X PUT -v https://api.sms.jpush.cn/v1/schedule/1a886e7c-a267-49e6-9970-0d396ca5bb1e -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" -d \
'{
    "send_time": "2017-07-01 09:00:00",
    "mobile": "13812345678",
    "temp_id": 1250,
    "temp_para": {
        "number": "741627"
    }
}'

Parameters

Return Example

Successful Request

{"schedule_id": "1a886e7c-a267-49e6-9970-0d396ca5bb1e"}

Failed Request

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

Scheduled SMS Bulk Modifying API

Function Description

• Modify sending tasks of bulk scheduled SMS

Call Address

• PUT https://api.sms.jpush.cn/v1/schedule/batch/{schedule_id}

Request Example

curl --insecure -X PUT -v https://api.sms.jpush.cn/v1/schedule/batch/1a886e7c-a267-49e6-9970-0d396ca5bb1e -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" -d \
'{
    "send_time": "2017-07-01 09:00:00",
    "temp_id": 1250,
    "recipients": [
        {
            "mobile": "13812345678",
            "temp_para": {
                "number": "741627"
            }
        },
        {
            "mobile": "18603050709",
            "temp_para": {
                "number": "147721"
            }
        }
    ]
}'

Parameters

Return Example

Successful Request

{
    "schedule_id": "1a886e7c-a267-49e6-9970-0d396ca5bb1e",
    "success_count": 1,
    "failure_count": 1,
    "failure_recipients": [
        {
            "error_code": "50006",
            "error_message": "invalid mobile",
            "mobile": "18603050709",
            "temp_para": {
                "number": "147721"
            }
        }
    ]
}

Failed Request

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

Scheduled SMS Querying API

Function Description

• Query sending tasks of scheduled SMS

Call Address

• GET https://api.sms.jpush.cn/v1/schedule/{schedule_id}

Request Example

curl --insecure -X GET -v https://api.sms.jpush.cn/v1/schedule/1a886e7c-a267-49e6-9970-0d396ca5bb1e -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"

Return Example

Successful Request

{
    "schedule_id": "1a886e7c-a267-49e6-9970-0d396ca5bb1e",
    "send_time": "2017-07-01 09:00:00",
    "temp_id": 1250,
    "recipients": [
        {
            "msg_id": "274887115920",
            "mobile": "13812345678",
            "temp_para": {
                "number": "741627"
            }
        }
    ]
}

Failed Request

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

Scheduled SMS Deleting API

Function Description

• Delete sending tasks of scheduled SMS

Call Address

• DELETE https://api.sms.jpush.cn/v1/schedule/{schedule_id}

Request Example

curl --insecure -X DELETE -v https://api.sms.jpush.cn/v1/schedule/1a886e7c-a267-49e6-9970-0d396ca5bb1e -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