添加签名
更新时间:2024-01-15
1.功能说明
1.1.该接口可以添加自定义签名,实现和自己业务系统无缝对接。
1.2.建议采用Post方法提交请求。
1.3.接口调用地址:http(s)://api.guoyangyun.com/api/smssign/add.htm
1.4.汉字字符集:UTF-8,请注意参数的大小写。
1.5.如果入参里面有图片或者文件(包含参数:licenseFile、authorizedFile、attachmentFiles),建议放在请求body里面传输,以免请求超长失败。
1.2.建议采用Post方法提交请求。
1.3.接口调用地址:http(s)://api.guoyangyun.com/api/smssign/add.htm
1.4.汉字字符集:UTF-8,请注意参数的大小写。
1.5.如果入参里面有图片或者文件(包含参数:licenseFile、authorizedFile、attachmentFiles),建议放在请求body里面传输,以免请求超长失败。
2.输入参数
参数 | 名称 | 类型 | 必须 | 描述 |
公共参数 | 公共参数 | — | 是 | 详见《公共参数和配置》文档 |
signName | 签名名称 | String | 是 |
1. 签名长度2~15字/字符; 2. 签名一般为:公司名简称、产品名、商城名称、网站名称、APP名称、系统名称、公众号、小程序名称等等。不可以是纯数字、电话号码或者无意义的签名,如:【温馨提示】【测试】【你好】等; 3. 个人身份实名认证账户,一般使用姓名,或者绑定个人身份的业务名称作为签名; 4. 签名如果非自用,需要获得使用方的授权委托书:模板下载 |
usageType | 签名用途 | Int | 是 | 签名用途: 1:自用; 2:他用 |
sceneType | 签名来源 | Int | 是 | 签名来源途径,请尽量选择准确,有助于为您加快审核: 1:企事业单位名 2:已备案网站 3:已上线APP 4:公众号或小程序 5:电商平台店铺名 6:已注册商标名 7:已申请软著名称 8:其他能证明的签名 |
sceneDomain | 来源说明 | String | 是 | 签名来源的详细证明材料,与签名来源对应如下: 1. 企业官网链接、已备案网址等; 2. 已备案网址、企业应用链接、H5链接等; 3. APP下载链接、任一应用商店展示页链接等; 4. 公众号、小程序全称、或者小程序[基本设置]全屏截图等; 5. 任一电商店铺展示页链接等; 6. 商标查询链接、商标授权书等; 7. 软著查询链接等; 8. 其他签名证明材料查看链接,或者资料可单独发送客服邮箱也可以 |
sceneRemark | 场景说明 | String | 否 | 具体使用场景说明,如:官网注册验证码使用等。 |
licenseFile | 企业资质 | object | 否 | 资质一般为:企业营业执照、社会信用代码证书、事业单位法人证书等。部分场景下,申请签名需要上传证明文件。入参格式(JSON字符串):{"content":"Base64文件字符串","suffix":"文件格式如:jgp"} |
content | 资质文件 | String | 否 | 签名的资质证明文件经base64编码后的字符串。图片不超过3MB。示例值:R0lGODlhHAAmAKI**** |
suffix | 文件格式 | String | 否 | 签名的证明文件格式。示例值:jpg |
authorizedFile | 授权委托书 | object | 否 | 签名所属主体非本账户实名主体,用途为他用时,需要上传授权委托书。入参格式(JSON字符串):{"content":"Base64文件字符串","suffix":"文件格式如:jgp"} |
content | 资质文件 | String | 否 | 签名的授权委托书文件经base64编码后的字符串。图片不超过3MB。示例值:R0lGODlhHAAmAKI**** |
suffix | 文件格式 | String | 否 | 签名的证明文件格式。示例值:jpg |
attachmentFiles | 更多资料 | array object | 否 | 更多资料文件列表(最多支持20个)。可根据签名来源上传对应文件: 1. 已备案网站:ICP备案、或者域名证书全屏截图 2. 已上线APP:应用商店APP管理后台全屏截屏 3. 公众号小程序:基本信息页面、管理页面全屏截图 4. 店铺名称:店铺基本信息、管理页面全屏截图 5. 软著商标:商标注册证书、商标软著权 6. 其他证明:登录注册页面、后台页面、协议补充、业务经营许可证等 入参格式(JSON数组字符串):[{"content":"Base64文件字符串1","suffix":"文件格式如:jgp"},{"content":"Base64文件字符串2","suffix":"文件格式如:jgp"}] |
content | 资质文件 | String | 否 | 签名的更多资料文件经base64编码后的字符串。文件不超过3MB。示例值:R0lGODlhHAAmAKI**** |
suffix | 文件格式 | String | 否 | 签名的证明文件格式。示例值:jpg |
3.调用示例
http(s)://api.guoyangyun.com/api/smssign/add.htm?appkey=您的appkey&appsecret=您的appsecret&signName=签名名称&usageType=签名用途&sceneType=签名来源&sceneDomain=来源说明&sceneRemark=场景说明
特别提醒:需对url中的参数进行URLEncode编码,以免出现中文内容乱码、被截断等异常错误。
4.Json返回
4.1.返回参数
参数 | 名称 | 类型 | 描述 |
code | 返回码 | Int | 请求返回结果。0:表示成功,其他:失败。(状态码详见:《公共错误代码定义》) |
msg | 信息提示内容 | String | 返回成功/错误详细描述信息。 |
sign | 签名信息 | List | 返回签名创建详细信息 |
created | 创建时间 | String | 签名的创建时间 |
modified | 修改时间 | String | 签名最近一次修改时间 |
primaryName | 主账户名 | String | 主账户的登录名称 |
username | 账户名称 | String | 账户登录名称 |
code | 签名ID | String | 签名ID(对应发送接口参数:smsSignId) |
signName | 签名名称 | String | 签名名称(短信前缀名称) |
status | 签名状态 | Int | 状态说明: 1:正常; 2:禁用; 3:等待审核; 4:审核拒绝 |
reason | 说明 | String | 签名相关说明(如:审核说明、禁用说明等) |
usageType | 签名用途 | Int | 签名用途,详见请求参数说明。 |
sceneType | 签名来源 | Int | 签名来源,详见请求参数说明。 |
sceneDomain | 来源说明 | String | 签名来源证明资料,详见请求参数说明。 |
sceneRemark | 使用场景 | String | 签名的使用场景描述 |
4.2.调用成功样例
{
"msg":"成功",
"code":"0",
"sign":{
"created":"2023-08-02 14:25:55", //模板创建时间
"modified":"2023-08-02 14:25:55", //模板修改时间
"primaryName":"a123456", //主账户名
"username":"a123456", //账户名
"signName":"abc", //签名名称
"status":3, //签名状态
"code":"83711fa89c6343a2b", //签名ID
"reason":null, //审核说明
"usageType":1, //签名用途
"sceneType":1, //签名来源
"sceneDomain":null, //来源说明
"sceneRemark":null //使用场景说明
}
}
4.3.调用失败样例
{
"code":"XXXX",
"msg":"错误提示内容"
}