短信签名 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/sign

请求示例

请注意，content-type为multipart/form-data的方式。

curl -X POST \
  https://api.sms.jpush.cn/v1/sign \
  -u '7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1' \
  -H 'content-type: multipart/form-data' \
  -F 'sign=申请的签名'
  -F 'type=签名类型'
  -F 'remark=申请说明'

参数

返回示例

请求成功

{"sign_id": 37582}

请求失败

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

修改签名 API

功能说明

• 修改审核不通过的签名，并再次提交审核

调用地址

• POST https://api.sms.jpush.cn/v1/sign/{sign_id}

请求示例

curl -X POST \
  https://api.sms.jpush.cn/v1/sign/37582 \
  -u '7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1' \
  -H 'content-type: multipart/form-data' \
  -F 'sign=修改的签名'
  -F 'type=签名类型'
  -F 'remark=业务场景说明'

参数

返回示例

请求成功

{"sign_id": 37582}

请求失败

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

查询签名 API

功能说明

• 查询短信签名

调用地址

• GET https://api.sms.jpush.cn/v1/sign/{sign_id}

请求示例

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

返回示例

请求成功

{
    "sign_id": 37582,
    "sign": "极光推送",
    "status": 1, //签名审核状态,1为通过，2为未通过
    "is_default": 1, //签名使用状态，1为默认签名
    "use_status": 1 //签名使用状态，1为使用中，0为未使用
}

请求失败

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

删除签名 API

功能说明

• 删除短信签名

调用地址

• DELETE https://api.sms.jpush.cn/v1/sign/{sign_id}

请求示例

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

返回示例

请求成功

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

请求失败

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

返回码