短信签名 API
最近更新:2021-12-15
展开全部

短信签名 API

  • 支持创建、修改、查询和删除短信签名

HTTP 验证

使用 HTTP Basic Authentication 的方式做访问授权。这样整个 API 请求可以使用常见的 HTTP 工具来完成,比如:curl,浏览器插件等;

HTTP Header(头)里加一个字段(Key/Value 对):

Authorization: Basic base64_auth_string
          Authorization: Basic base64_auth_string

        
此代码块在浮窗中显示

其中 base64_auth_string 的生成算法为:base64(appKey:masterSecret),即:对 appKey 加上冒号,加上 masterSecret 拼装起来的字符串,再做 base64 转换。appKey、masterSecret 可以在控制台应用设置中查看。


创建签名 API

功能说明

  • 创建短信签名

调用地址

请求示例

请注意,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=申请说明'
          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=申请说明'

        
此代码块在浮窗中显示

参数

KEY REQUIRE DESCRIPTION
sign TRUE 签名内容
仅支持中英文、数字组成,长度为 2~8 个字
无须添加【】、[]、()等符号。范例:极光推送
type FALSE 签名类型,填写数字代号即可
1、公司名称全称或简称:需提供签名所属主体的营业执照复印件图片及对应法人代表的身份证正反面复印件图片,均需加盖公章
2、工信部备案的网站全称或简称:需提供签名所属的已备案的 icp 备案截图复印件图片、主办单位的营业执照复印件图片及对应法人代表的身份证正反面复印件图片,均需加盖公章
3、APP 应用名称或简称:需提供签名所属的任意应用商店的下载链接、APP 软著证明复印件图片及开发者的营业执照复印件图片、对应法人代表的身份证正反面复印件图片,均需加盖公章
4、公众号小程序全称或简称:需提供签名所属的公众号小程序含主体的页面截图、开发者主体营业执照复印件图片、对应法人代表的身份证正反面复印件图片,均需加盖公章
5、商标名称全称或简称:需提供签名所属商标注册证书复印件图片及商标主体营业执照复印件图片、对应法人代表身份证正反面复印件图片,均需加盖公章
6、其他:申请的签名与所属主体不一致或涉及第三方权益时,需提供第三方授权委托书、第三方签名相关资质(详见类型 1-5), 授权委托书格式参考文档
  • 如果用户 A 创建自用签名,签名归属主体属于 A,则不涉及第三方权益。
  • 如果用户 A 替公司 B 创建签名,签名归属主体属于公司 B,则涉及第三方权益,需要公司 B 给予 A 授权委托书。公司 B 为授权方,A 为被授权方,并需要加盖公司 B 的公章。
  • image0 FALSE 请提供签名相关的资质证件图片 1(文件支持 PNG、JPG、JPEG 格式,且大小不超过 2M)
    image1 FALSE 请提供签名相关的资质证件图片 2(文件支持 PNG、JPG、JPEG 格式,且大小不超过 2M)
    remark FALSE 请简略描述您的业务使用场景,不超过 100 个字

    返回示例

    请求成功

    { "sign_id": 37582 }
              { "sign_id": 37582 }
    
            
    此代码块在浮窗中显示

    请求失败

    { "error": { "code": *****, "message": "*****" } }
              {
        "error": {
            "code": *****,
            "message": "*****"
        }
    }
    
            
    此代码块在浮窗中显示

    修改签名API

    功能说明

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

    调用地址

    请求示例

    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=业务场景说明'
              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=业务场景说明'
    
            
    此代码块在浮窗中显示

    参数

    KEY REQUIRE DESCRIPTION
    sign TRUE 签名内容
    仅支持中英文、数字组成,长度为 2~8 个字
    无须添加【】、[]、()等符号。范例:极光推送
    type FALSE 签名类型,填写数字代号即可
    1、公司名称全称或简称:需提供签名所属主体的营业执照复印件图片及对应法人代表的身份证正反面复印件图片,均需加盖公章
    2、工信部备案的网站全称或简称:需提供签名所属的已备案的 icp 备案截图复印件图片、主办单位的营业执照复印件图片及对应法人代表的身份证正反面复印件图片,均需加盖公章
    3、APP 应用名称或简称:需提供签名所属的任意应用商店的下载链接、APP 软著证明复印件图片及开发者的营业执照复印件图片、对应法人代表的身份证正反面复印件图片,均需加盖公章
    4、公众号小程序全称或简称:需提供签名所属的公众号小程序含主体的页面截图、开发者主体营业执照复印件图片、对应法人代表的身份证正反面复印件图片,均需加盖公章
    5、商标名称全称或简称:需提供签名所属商标注册证书复印件图片及商标主体营业执照复印件图片、对应法人代表身份证正反面复印件图片,均需加盖公章
    6、其他:申请的签名与所属主体不一致或涉及第三方权益时,需提供第三方授权委托书、第三方签名相关资质(详见类型 1-5), 授权委托书格式参考文档
  • 如果用户 A 创建自用签名,签名归属主体属于 A,则不涉及第三方权益。
  • 如果用户 A 替公司 B 创建签名,签名归属主体属于公司 B,则涉及第三方权益,需要公司 B 给予 A 授权委托书。公司 B 为授权方,A 为被授权方,并需要加盖公司 B 的公章。
  • image0 FALSE 请提供签名相关的资质证件图片 1(图片支持 PNG、JPG、JPEG 格式,且大小不超过 2M)
    image1 FALSE 请提供签名相关的资质证件图片 2(图片支持 PNG、JPG、JPEG 格式,且大小不超过 2M)
    remark FALSE 请简略描述您的业务使用场景,不超过 100 个字

    返回示例

    请求成功

    { "sign_id": 37582 }
              { "sign_id": 37582 }
    
            
    此代码块在浮窗中显示

    请求失败

    { "error": { "code": *****, "message": "*****" } }
              {
        "error": {
            "code": *****,
            "message": "*****"
        }
    }
    
            
    此代码块在浮窗中显示

    查询签名API

    功能说明

    • 查询短信签名

    调用地址

    请求示例

    curl --insecure -X GET -v https://api.sms.jpush.cn/v1/sign/37582 -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"
              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为未使用 }
              {
      "sign_id": 37582,
      "sign": "极光推送",
      "status": 1, //签名审核状态,1为通过,2为未通过
      "is_default": 1, //签名使用状态,1为默认签名
      "use_status": 1 //签名使用状态,1为使用中,0为未使用
    }
    
            
    此代码块在浮窗中显示

    请求失败

    { "error": { "code": *****, "message": "*****" } }
              {
        "error": {
            "code": *****,
            "message": "*****"
        }
    }
    
            
    此代码块在浮窗中显示

    删除签名 API

    功能说明

    • 删除短信签名

    调用地址

    请求示例

    curl --insecure -X DELETE -v https://api.sms.jpush.cn/v1/sign/37582 -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"
              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
              HTTP/1.0 200
      Content-Type: application/json
      Content-Length: 0
    
            
    此代码块在浮窗中显示

    请求失败

    { "error": { "code": *****, "message": "*****" } }
              {
        "error": {
            "code": *****,
            "message": "*****"
        }
    }
    
            
    此代码块在浮窗中显示

    返回码

    点击查看返回码说明

    文档内容是否对您有帮助?

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

    在文档中心打开