调用CheckNumberAvaliable判断主被叫号码是否可用,主要是限制号码外呼频次。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CheckNumberAvaliable

系统规定参数。取值:CheckNumberAvaliable。

Callee String 18801341234

被叫号码

InstanceId String 9cfad875-6260-4a53-ab6e-b13e3fb31f7d

呼叫中心实例ID

Caller String 01012345678

呼叫中心主叫号码

返回数据

名称 类型 示例值 描述
CalleeAvaliable Struct

被叫号码相关信息

Avaliable Boolean true

是否可用

Reason String Instance Blacklist: Number 18801341234 can not be called from current instance

如果可用不返回,不可用返回原因,例:"Instance Blacklist: Number 18801341234 can not be called from current instance", "System Blacklist: Number 18801341234 can not be called from all ccc users", "System Blacklist: Number 18801341234 can not be called from current ccc user", "Outbound Control: Number 18801341234's call times beyonds limit, 3 times/h"

CallerAvaliable Struct

主叫号码的相关信息

Avaliable Boolean true

是否可用

Reason String Instance Blacklist: Number 18801341234 can not be called from current instance

如果可用不返回,不可用返回原因,例:"Instance Blacklist: Number 18801341234 can not be called from current instance", "System Blacklist: Number 18801341234 can not be called from all ccc users", "System Blacklist: Number 18801341234 can not be called from current ccc user", "Outbound Control: Number 18801341234's call times beyonds limit, 3 times/h"

Code String OK

响应码

HttpStatusCode Integer 200

HTTP状态码

Message String

响应信息

RequestId String 0630E5DF-CEB0-445B-8626-D5C7481181C3

请求ID

Success Boolean true

是否成功

示例

请求示例

http(s)://[Endpoint]/?Action=CheckNumberAvaliable
&Callee=18801341234
&InstanceId=9cfad875-6260-4a53-ab6e-b13e3fb31f7d
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>0630E5DF-CEB0-445B-8626-D5C7481181C3</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<CallerAvaliable>
    <Avaliable>true</Avaliable>
</CallerAvaliable>
<Code>OK</Code>
<Success>true</Success>
<CalleeAvaliable>
    <Avaliable>true</Avaliable>
</CalleeAvaliable>

JSON 格式

{
	"RequestId": "0630E5DF-CEB0-445B-8626-D5C7481181C3",
	"HttpStatusCode": 200,
	"CallerAvaliable": {
		"Avaliable": true
	},
	"Code": "OK",
	"Success": true,
	"CalleeAvaliable": {
		"Avaliable": true
	}
}

错误码

访问错误中心查看更多错误码。