新增主叫白名单 - CreateVcWhitelist

接口功能

用户通过该接口新增主叫白名单。

使用说明

仅限授权用户调用此接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限管理。

URI

POST /v1.0/voicecall/caller-number/whitelist

请求参数

表1 请求Headers参数说明
参数名称	是否必选	参数类型	默认值	说明
Content-Type	否	String	无	参数解释：消息体的类型（格式）。约束限制：不涉及。取值范围：固定填写为application/json;charset=UTF-8。默认取值：不涉及。
X-Auth-Token	是	String	无	用户Token。请参考Token认证获取用户Token。说明： Token的有效期为24小时，到期后请重新获取。

表2 请求Body参数说明
参数名称	是否必选	参数类型	默认值	说明
caller_number_whitelist_list	是	CallerNumberWhitelist[]	无	主叫白名单号码，一次最多可携带1000个号码。说明：如果存在重复主叫白名单号码，系统支持自动剔除重复号码。

表3 CallerNumberWhitelist结构
参数名称	是否必选	参数类型	默认值	说明
caller_number	是	String(1-32)	无	主叫号码。说明：号码格式：完整的11位手机号码，不带+86；如果携带+86，系统会自动去除。
report_type	是	String(1-128)	无	报备对象类型，枚举如下： ENTERPRISE：企业
report_object	是	String(1-128)	无	报备对象。说明： “报备对象类型”为“ENTERPRISE（企业）”，“报备对象”请携带“企业ID”。

响应参数

表4 响应结果参数
参数名称	是否必选	参数类型	默认值	说明
error_code	是	String	无	错误码。
error_msg	是	String	无	错误描述。
error_number_list	否	ErrorNumber	无	操作失败的号码列表。说明：操作号码时，操作成功会保存成功记录，操作失败则返回失败号码信息。

表5 ErrorNumber结构
参数名称	是否必选	参数类型	默认值	说明
caller_number	是	String(1-32)	无	主叫号码。
report_object	是	String(1-128)	无	报备对象。说明： “报备对象类型”为“ENTERPRISE（企业）”，“报备对象”为“企业ID”。
description	是	String(0-255)	无	添加失败描述信息。

结果码说明

表6 响应结果码
响应码	error_code	error_msg	说明
200	0	Operation success.	成功。
200	VC.0032	The list of caller numbers that fail to be operated exists.	存在操作失败主叫号码列表。
400	VC.0001	Internal server error.	系统内部错误。
	VC.0002	Invalid Parameter.	无效参数。
	VC.0005	Order does not exist.	订单不存在。
	VC.0014	The operation is forbidden because tenant has been frozen.	租户已被冻结，不能进行该操作。
	VC.0015	The operation is forbidden because tenant has been restricted.	租户受限，不允许操作。
	VC.0017	Operation failed.	系统操作失败。
403	VC.0003	Request unauthorized.	请求鉴权未通过。

接口示例

请求示例

POST  /v1/voicecall/caller-number/whitelist
{
    "caller_number_whitelist_list": [
        {
            "caller_number": "130*****000",
            "report_type": "ENTERPRISE",
            "report_object": "ENTERPRISE_ID"
        }
    ]
}

响应示例

成功：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
    "error_code": "0",
    "error_msg": "Operation success."
}

全部失败：
HTTP/1.1 400
Content-Type: application/json;charset=UTF-8
{
    "error_code": "VC.0017",
    "error_msg": "Operation failed."
}

存在失败记录：
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
    "error_code": "VC.0032",
    "error_msg": "The list of caller numbers that fail to be operated exists.",
    "error_number_list": [
        {
            "caller_number": "130*****000",
            "report_object": "ENTERPRISE_ID",
            "description": "该记录已存在"
        }
    ]
}

父主题： 主叫白名单报备API

上一篇：主叫白名单报备API

下一篇：删除主叫白名单-DeleteVcWhitelist