查询资质列表--语音服务-火山引擎

文档中心

导航

查询资质列表

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

请求方式：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	是	application/json	指定请求消息体的结构化格式。

Query

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

Body

字段名	英文名	类型	是否必填	备注	例子
资质编号列表	QualificationNoList	list	否		[QUA164664762128220429, QUA164664754228227262]
审核状态	ApprovalStatus	Integer	否	审核中 1 审核通过 2 审核失败 3	111
偏移量	Offset	Integer	否	默认0 （偏移量不是页数）	0
大小	Limit	Integer	否	默认20	20

2. 返回参数

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

ResponseMetadata

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

Result

名称	英文名	类型	备注
资质主体信息	QualificationMainInfoVO	QualificationMainInfoVO
管理员信息	QualificationAdminInfoVO	QualificationAdminInfoVO
资质场景	QualificationAdminInfoVOList	QualificationScenarioInfoVO	列表

QualificationMainInfoVO

名称	英文名	类型	备注	例子
资质ID	QualificationId	int		54545
资质编号	QualificationNo	String		QUA164664762128220429
资质主体	QualificationEntity	String		XXX公司
账号id	AccountId	String		2100042822
三证是否合一	CertificateThreeInOne	int	是 1 否 0	1
企业地址	EnterpriseAddress	String		北京市海淀区
法人代表姓名	LegalRepresentativeName	String		张三
法人代表身证件号 (加密存储)	LegalRepresentativeId	String		1221454542457
法人身份证	LegalRepresentativeFrontIDPhotoURL	String	相对路径	/volc/configure/qualification/file/download?fileCode=fdsfjisaji
入网信息：号码申请公函下载URL	DocOfNumberApplyPhotoURL	String
入网信息：入网承诺书下载URL	CommitmentLetterOfNetAccessPhotoURL	String
三证合一时统一社会信用代码	UnitSocialCreditCode	String		HUHUHUJKKLHFGG
三证合一时证明文件为营业执照下载URL	ThreeInOneBusinessLicensePhotoURL	String
非三证合一：组织机构代码（加密存储）	CodeOfOrganizationCertificateURL	String
非三证合一：企业法人营业执照下载URL	BusinessLicensePhotoURL	String
非三证合一：组织机构代码证下载URL	CertificateOfOrganizationCodesPhotoURL	String
非三证合一：税务登记证下载URL	CertificateOfTaxationRegistrationPhotoURL	String
审核状态	ApprovalStatus	int	审核中 1 审核通过 2 审核失败 3	1
审核结果说明	ApprovalDoneReason	String
创建时间	CreateTime	String
修改时间	UpdateTime	String

QualificationAdminInfoVO

名称	英文名	类型	例子
管理员姓名	Name	String	李四
管理员联系方式	ContactNumber	String	13111112222
管理员身份证号码	IdCardNumber	String	14254675125
管理员身份证照片下载URL	IdCardFrontPhotoURL	String
管理员手持身份证照片下载URL	IdCardPhotoWithPeopleURL	String

QualificationScenarioInfoVO

名称	英文名	类型
使用场景	SceneType	int	22
场景描述	Description	String	针对代充用户外呼调研，调研出代充的充值渠道，以及店铺名称
外呼话术	ScenarioOfCalling	String	“我在微信上/淘宝上进行充值的啊” ——好的，先生/女士，那您能告知客服，您充值抖币经常使用的具体公众号名称/淘宝店铺名称吗？ “你问那么详细是要做什么呢？”

Error

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

3. 示例

请求示例

curl --location --request POST '[地址]' \
--header 'ServiceName: vms' \
--header 'Region: cn-north-1' \
--form 'Action="QueryQualification"' \
--form 'Version="2022-01-01"' \
--form 'QualificationNoList=["xxxx"]' \
--form 'ApprovalStatus="1"' \
--form 'Offset="0"'\
--form 'Limit="10"'\

返回示例

{
    "ResponseMetadata":{
    "RequestId":"20210114163805010225092059070005F4",
    "Action":"QueryQualification",
    "Version":"2022-01-01",
    "Service":"vms",
    "Region":"cn-north-1"
    },
    "Result": {
    "Total": 1000,
    "Limit": 20,
    "Offset": 0,
    "Records": [{如下所示}]
    }
}

{
    "QualificationMainInfoVO": {
        "AccountId": "11111",
        "QualificationId": 1111, //资质主体ID 编辑时传此ID
        "QualificationEntity": "北京字节跳动网络技术有限公司",
        "CertificateThreeInOne": 1,
        "EnterpriseAddress": "北京市海淀区xxx",
        "LegalRepresentativeName": "张三",
        "LegalRepresentativeId": "4112548561222411",
        "UnitSocialCreditCode": "JFKKWQ5542254",
        "CodeOfOrganizationCertificate": "JIJHGJKK",
        
        "LegalRepresentativeFrontIDPhotoURL": "/volc/configure/qualification/file/download?fileCode=fdsjfiasjfiji", //相对路径
        "DocOfNumberApplyPhotoURL": "",
        "CommitmentLetterOfNetAccessPhotoURL": "",
        "ThreeInOneBusinessLicensePhotoURL": "",
        "BusinessLicensePhotoURL": "",
        "CertificateOfOrganizationCodesPhotoURL": "",
        "CertificateOfTaxationRegistrationPhotoURL": "",
        
        "ApprovalStatus": 1, //审核状态
        "ApprovalDoneReason": "xxxxx",
        "CreateTime": "2021-01-01 12:00:00",
        "UpdateTime": "2021-01-01 12:00:00"
     },
    "QualificationAdminInfoVO": {
        "Name": "李四",
        "ContactNumber": "18811221425",
        "IdCardNumber": "4112548561222411",
        "IdCardFrontPhotoURL": "",
        "IdCardBackPhotoURL": "",
        "IdCardBackPhotoWithPeopleURL": "",    
     },
    "QualificationScenarioInfoVOList": [
            {
            "SceneType": 11,
            "Description": "xxxx",
            "ScenarioOfCalling": "xxxxxxxxxxx"
            },
            {
            "SceneType": 11,
            "Description": "xxxx",
            "ScenarioOfCalling": "xxxxxxxxxxx"
            }
     ] 
}