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

请求示例

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

参数

返回示例

发送成功

{"msg_id": "288193860302"}

发送失败

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

发送语音验证码短信 API

功能说明

• 发送语音验证码短信

调用地址

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

请求示例

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}'

参数

返回示例

发送成功

{"msg_id": "288193860302"}

发送失败

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

验证码验证 API

功能说明

• 验证验证码是否有效

调用地址

• POST https://api.sms.jpush.cn/v1/codes/{msg_id}/valid (注:msg_id为调用发送验证码API的返回值)

请求示例

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"}'

参数

返回示例

验证通过

{
    "is_valid": true
}

验证不通过

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

发送单条模板短信 API

功能说明

• 发送单条模板短信

调用地址

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

请求示例

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

参数

返回示例

发送成功

{"msg_id": 288193860302}

发送失败

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

发送批量模板短信 API

功能说明

• 发送批量模板短信

调用地址

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

请求示例

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

参数

返回示例

发送成功

{
    "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"
            }
        }
    ]
}

发送失败

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

返回码