添加签名


HTTP 头信息:


Accept:application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;


请求


URL:`https://sms.yunpian.com/v2/sign/add.json`
注意:海外服务器地址 us.yunpian.com
访问方式:POST


请求参数

参数名

类型

是否必须

描述

示例

apikey

string

用户唯一标识,在账号设置-子帐号管理中查看

9b11127a9701975c734b8aee81ee3526

sign

string

签名内容

云片网

website

string

业务网址:建议填写签名对应的业务网址和场景

(平台为了规范审核,2021年9月8日起为必传项,请开发者提前完成对接)

https://www.yunpian.com,企业官网


notify

boolean

是否短信通知结果,默认 true

true

apply_vip

boolean

是否申请专用通道,默认 false

false

is_only_global

boolean

是否发国际短信,默认 false

false

industry_type

string

所属行业,默认“其它”

生产/加工/制造

prove_type

long

根据签名内容需要提供的证明文件类型,其中:

1:公司营业执照(签名是公司名称);

2:应用商店APP管理后台全屏截图(签名是APP名称);
3:ICP备案截图(签名是网站名称)

4:微信公众平台管理界面全屏截图(签名是公众号/小程序名称)

6:商标注册证书/商标软著权证明(签名是商标名称)

1

license_url

string

签名对应的营业执照或其他企业资质的图片文件 URL,URL 由请求方提供。(支持传多个证明文件,允许该参数出现多次,最多支持7次,单个文件大小限制10M以内。)

https://example.com/demo.png

license_base64

string

签名对应的资质图片进行 base64 编码格式转换后的字符串(编码后的参数需添加图片头data:image/jpg;base64, )。此参数和 license_url 您可以任选一种需要的方式进行传输。若两种参数都传,优先取 license_url。(支持传多个证明文件,允许该参数出现多次,最多支持7次,单个文件大小限制10M以内。)


参数说明


  1. sign
    1. 不能包含【】
    2. 不能是“云片网”
    3. 2-20 个字
    4. 支持中文、英文、数字和常用符号。
  1. apply_vip
    1. 仅发国际短信(is_only_global)的签名不能申请专用通道,此项(apply_vip)会被置为 false
  1. industry_type
    1. 可选项(必须完全一致,匹配失败自动转为“其它”):
    1. 枚举值:1. 游戏 2. 移动应用 3. 视频 4. IT/通信/电子服务 5. 电子商务 6. 金融 7. 网站 8. 商业服务 9. 房地产/建筑 10. 零售/租赁/贸易 11. 生产/加工/制造 12. 交通/物流 13. 文化传媒 14. 能源/电气 15. 政府企业 16. 农业 17. 物联网 18. 其它


响应

名称

类型

描述

code

int

错误号码,正确为 0

msg

string

示例“ok”

sign

json 数组

返回的签名 json 数组


sign 中具体示例:

名称

类型

描述

apply_state

string

当前审核状态

sign

string

签名

is_apply_vip

boolean

是否为专用通道

is_only_global

boolean

是否申请仅国际短信

industry_type

string

类型


Json 响应示例:


调用成功的返回值示例:


{
  "code": 0,
  "msg": "OK",
  "sign": {
    "apply_state": "CHECKING",
    "sign": "【云片网】",
    "is_apply_vip": false,
    "is_only_global": true,
    "industry_type": "IT/通信/电子服务"
  }
}


调用失败的返回值示例:


{
  "http_status_code": 400,
  "code": 2,
  "msg": "请求参数格式错误",
  "detail": "参数sign格式不正确,sign不能是'云片网'"
}