短信签名 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=申请的签名'

参数

KEY REQUIRE DESCRIPTION
sign TRUE 签名内容
image0 FALSE 签名审核附带图片
image1 FALSE 签名审核附带图片
image2 FALSE 签名审核附带图片
image3 FALSE 签名审核附带图片

返回示例

请求成功

{"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=修改的签名'

参数

KEY REQUIRE DESCRIPTION
sign TRUE 签名内容
image0 FALSE 签名审核附带图片
image1 FALSE 签名审核附带图片
image2 FALSE 签名审核附带图片
image3 FALSE 签名审核附带图片

返回示例

请求成功

{"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为未通过
    "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": "*****"
    }
}


返回码

HTTP CODE CODE MESSAGE DESC
200 50000 success 请求成功
400 50001 missing auth auth 为空
401 50002 auth failed auth 鉴权失败
400 50003 missing body body 为空
403 50007 invalid body body 无效
403 50008 no sms code auth 未开通短信业务
404 50016 api not found API 不存在
415 50017 media not supported 媒体类型不支持
405 50018 request method not support 请求方法不支持
500 50019 server error 服务端异常
403 50101 invalid image 非法的图片
403 50102 invalid sign id 非法的签名 ID
403 50103 other signatures in the audit 已经存在其他待审核的签名,不能提交
403 50104 invalid signature 非法签名内容
403 50105 the signature in use cannot be deleted 使用中签名不允许删除

Copyright 2011-2017, jiguang.cn, All Rights Reserved.
粤ICP备12056275号-13 深圳市和讯华谷信息技术有限公司

Documentation built with MkDocs.