资质相关图片上传接口--语音服务-火山引擎

文档中心

导航

资质相关图片上传接口

最近更新时间：2023.08.17 22:02:36首次发布时间：2023.02.28 20:31:39

请求方式：POST
接口地址：https://cloud-vms.volcengineapi.com

1. 请求参数

Header

参数	数据类型	是否必填	示例值	描述
X-Date	String	是	20201103T104027Z	鉴权字段。请参考文档中心-火山引擎。
Authorization	String	是	HMAC-SHA256 Credential***	鉴权字段。请参考文档中心-火山引擎。
ServiceName	String	是	vms	服务名称。语音服务的服务名称为`vms`。
Region	String	是	cn-north-1	区域名称。
Content-Type	String	是	multipart/form-data	指定请求消息体的结构化格式。

Query

参数	数据类型	是否必填	示例值	描述
Action	String	是	UploadQualificationFile	接口名称。该接口固定值为UploadQualificationFile。
Version	String	是	2022-01-01	接口版本。该接口版本为2022-01-01

Body

字段名	英文名	类型	备注	例子
文件类型	fileType	FileType		LegalRepresentativeFrontIDPhoto
图片文件	file	MultipartFile	文件	0

FileType枚举

字段名	英文名
法人身份证	LegalRepresentativeFrontIDPhoto
入网信息：号码申请公函	DocOfNumberApplyPhoto
入网信息：入网承诺书	CommitmentLetterOfNetAccessPhoto
三证合一时证明文件为营业执照下载URL	ThreeInOneBusinessLicensePhoto
非三证合一：企业法人营业执照下载URL	BusinessLicensePhoto
非三证合一：组织机构代码证下载URL	CertificateOfOrganizationCodesPhoto
非三证合一：税务登记证下载URL	CertificateOfTaxationRegistrationPhoto
管理员身份证正面照片下载URL	IdCardFrontPhoto
管理员身份证反面照片下载URL	IdCardBackPhoto
管理员手持身份证照片下载URL	IdCardPhotoWithPeople

2. 返回参数

参数	数据类型	描述
ResponseMetadata	ResponseMetadata	响应公共参数。包含的参数说明请参见 ResponseMetadata。
Result	Result	响应业务参数。包含的参数说明请参见 Result。

ResponseMetadata

参数	数据类型	描述
RequestId	String	请求 ID。
Action	String	请求的接口名称。
Version	String	请求的版本号。
Service	String	请求的服务名称。
Region	String	请求的区域。
Error	Error	错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见 Error。

Result

Tos文件名

Error

参数	数据类型	描述
Code	String	错误码。
Message	String	错误信息。

3. 示例

请求示例

curl --location --request POST '[地址]' \
--header 'ServiceName: vms' \
--header 'Region: cn-north-1' \
--header 'X-Date: 20201103T104027Z' \
--header 'Authorization: HMAC-SHA256 Credential=***' \
--form 'Action="UploadQualificationFile"' \
--form 'Version="2022-01-01"' \
--form 'FileType="LegalRepresentativeFrontIDPhoto"' \
--form 'File="xxxx"' \

返回示例

{
    "ResponseMetadata":{
    "RequestId":"20210114163805010225092059070005F4",
    "Action":"UploadQualificationFile",
    "Version":"2022-01-01",
    "Service":"vms",
    "Region":"cn-north-1"
    },
    "Result": "xxxx" //Tos文件名（fileCode）
}