短信签名 API
最近更新:2025-09-18
展开全部

短信签名 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=1' \ -F 'idCardImage=@/path/to/idcard.jpg' \ -F 'businessLicenseImage=@/path/to/business_license.jpg'
          curl -X POST \
  https://api.sms.jpush.cn/v1/sign \
  -u '7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1' \
  -H 'content-type: multipart/form-data' \
  -F 'sign=极光推送' \
  -F 'type=1' \
  -F 'idCardImage=@/path/to/idcard.jpg' \
  -F 'businessLicenseImage=@/path/to/business_license.jpg'

        
此代码块在浮窗中显示
#### 参数 | KEY | REQUIRE | DESCRIPTION | | ------ | ------- | ----------- | | sign | TRUE | 签名内容<br>仅支持中英文、数字组成,长度为 2~8 个字<br>无须添加【】、[]、()等符号。范例:极光推送 | | type | TRUE | 签名类型,填写数字代号即可<br>**支持的类型值:**<br>• 公司名称全称或简称(需要营业执照图片):**1**<br>• APP应用全称或简称(需要ICP备案APP截图):**3**<br>• 品牌名称全称或简称(需要商标注册证图片):**6**<br>• 其他类型(需要第三方授权委托书图片):**7** | | legalPersonName | FALSE | 法人姓名<br>可选参数,如果提供会进行验证 | | legalPersonIdNumber | FALSE | 法人身份证号码<br>可选参数,如果提供必须为有效的18位身份证号码 | | idCardImage | TRUE | 法人身份证图片<br>文件支持 PNG、JPG、JPEG 格式,且大小不超过 2M | | socialCreditCode | FALSE | 统一社会信用代码<br>可选参数,如果提供必须为有效的18位统一社会信用代码 | | thirdPartyCompanyName | FALSE | 第三方公司名称 | | businessLicenseImage | 条件必填 | 营业执照图片<br>type=1时必填<br>文件支持 PNG、JPG、JPEG 格式,且大小不超过 2M | | icpAppScreenshot | 条件必填 | ICP备案APP截图<br>type=2时必填<br>文件支持 PNG、JPG、JPEG 格式,且大小不超过 2M | | trademarkImage | 条件必填 | 商标注册证图片<br>type=3时必填<br>文件支持 PNG、JPG、JPEG 格式,且大小不超过 2M | | thirdPartyAuthImage | 条件必填 | 第三方授权委托书图片<br>type=4时必填<br>文件支持 PNG、JPG、JPEG 格式,且大小不超过 2M | | otherImage | FALSE | 其他相关图片<br>文件支持 PNG、JPG、JPEG 格式,且大小不超过 2M | | remark | FALSE | 申请说明<br>请简略描述您的业务使用场景,不超过 100 个字 | ### 返回示例 #### 请求成功 ```json { "sign_id": 37582 }
          
#### 参数

| KEY | REQUIRE | DESCRIPTION |
| ------ | ------- | ----------- |
| sign | TRUE | 签名内容<br>仅支持中英文、数字组成,长度为 2~8 个字<br>无须添加【】、[]、()等符号。范例:极光推送 |
| type | TRUE | 签名类型,填写数字代号即可<br>**支持的类型值:**<br>• 公司名称全称或简称(需要营业执照图片):**1**<br>• APP应用全称或简称(需要ICP备案APP截图):**3**<br>• 品牌名称全称或简称(需要商标注册证图片):**6**<br>• 其他类型(需要第三方授权委托书图片):**7** |
| legalPersonName | FALSE | 法人姓名<br>可选参数,如果提供会进行验证 |
| legalPersonIdNumber | FALSE | 法人身份证号码<br>可选参数,如果提供必须为有效的18位身份证号码 |
| idCardImage | TRUE | 法人身份证图片<br>文件支持 PNG、JPG、JPEG 格式,且大小不超过 2M |
| socialCreditCode | FALSE | 统一社会信用代码<br>可选参数,如果提供必须为有效的18位统一社会信用代码 |
| thirdPartyCompanyName | FALSE | 第三方公司名称 |
| businessLicenseImage | 条件必填 | 营业执照图片<br>type=1时必填<br>文件支持 PNG、JPG、JPEG 格式,且大小不超过 2M |
| icpAppScreenshot | 条件必填 | ICP备案APP截图<br>type=2时必填<br>文件支持 PNG、JPG、JPEG 格式,且大小不超过 2M |
| trademarkImage | 条件必填 | 商标注册证图片<br>type=3时必填<br>文件支持 PNG、JPG、JPEG 格式,且大小不超过 2M |
| thirdPartyAuthImage | 条件必填 | 第三方授权委托书图片<br>type=4时必填<br>文件支持 PNG、JPG、JPEG 格式,且大小不超过 2M |
| otherImage | FALSE | 其他相关图片<br>文件支持 PNG、JPG、JPEG 格式,且大小不超过 2M |
| remark | FALSE | 申请说明<br>请简略描述您的业务使用场景,不超过 100 个字 |

### 返回示例

#### 请求成功

```json
{ "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=1' \ -F 'idCardImage=@/path/to/new_idcard.jpg' \ -F 'businessLicenseImage=@/path/to/new_business_license.jpg' \ -F 'legalPersonName=张三' \ -F 'legalPersonIdNumber=110101199001011234' \ -F 'socialCreditCode=91110000000000000A' \ -F 'thirdPartyCompanyName=修改后的公司名称' \ -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=1' \
  -F 'idCardImage=@/path/to/new_idcard.jpg' \
  -F 'businessLicenseImage=@/path/to/new_business_license.jpg' \
  -F 'legalPersonName=张三' \
  -F 'legalPersonIdNumber=110101199001011234' \
  -F 'socialCreditCode=91110000000000000A' \
  -F 'thirdPartyCompanyName=修改后的公司名称' \
  -F 'remark=修改后的业务说明'

        
此代码块在浮窗中显示

参数

KEY REQUIRE DESCRIPTION
sign TRUE 签名内容
仅支持中英文、数字组成,长度为 2~8 个字
无须添加【】、[]、()等符号。范例:极光推送
type TRUE 签名类型,填写数字代号即可
支持的类型值:
• 公司名称全称或简称(需要营业执照图片):1
• APP应用全称或简称(需要ICP备案APP截图):3
• 品牌名称全称或简称(需要商标注册证图片):6
• 其他类型(需要第三方授权委托书图片):7
legalPersonName FALSE 法人姓名
可选参数,如果提供会进行验证
legalPersonIdNumber FALSE 法人身份证号码
可选参数,如果提供必须为有效的18位身份证号码
idCardImage TRUE 法人身份证图片
文件支持 PNG、JPG、JPEG 格式,且大小不超过 2M
socialCreditCode FALSE 统一社会信用代码
可选参数,如果提供必须为有效的18位统一社会信用代码
thirdPartyCompanyName FALSE 第三方公司名称
businessLicenseImage 条件必填 营业执照图片
type=1时必填
文件支持 PNG、JPG、JPEG 格式,且大小不超过 2M
icpAppScreenshot 条件必填 ICP备案APP截图
type=2时必填
文件支持 PNG、JPG、JPEG 格式,且大小不超过 2M
trademarkImage 条件必填 商标注册证图片
type=3时必填
文件支持 PNG、JPG、JPEG 格式,且大小不超过 2M
thirdPartyAuthImage 条件必填 第三方授权委托书图片
type=4时必填
文件支持 PNG、JPG、JPEG 格式,且大小不超过 2M
otherImage FALSE 其他相关图片
文件支持 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-2025, jiguang.cn, All Rights Reserved. 粤ICP备12056275号-13 深圳市和讯华谷信息技术有限公司

在文档中心打开