调用接口QueryCallStatus查询呼叫状态。

在业务中使用已创建的绑定关系之前,建议通过接口QueryCallStatus查询呼叫状态,以免呼叫关系异常,影响实际业务。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
PoolKey String FC123456

号码池Key。请登录号码隐私保护控制台,在号码池管理中查看号码池Key。

SubsId String 1000000768798832

绑定关系ID。

可以在控制台的号码管理 > 号码详情中查看绑定关系ID,或者在调用BindAxb等号码绑定API时查看返回参数中的SubsId

AccessKeyId String LTAIP00vvvvvvvvv

主账号AccessKey的ID。

Action String QueryCallStatus

系统规定参数。取值:QueryCallStatus

CallNo String 150000000

主叫号码。

返回数据

名称 类型 示例值 描述
Code String OK

请求状态码。

Message String OK

状态码的描述。

RequestId String E7F99446-8191-43C0-99B5-F58A6AEAD7D5

请求ID。

SecretCallStatusDTO

接口调用成功后返回的结构体。

CalledNo String 17000000000

被叫的号码,即X号码。

其中:

  • 当status =1时,calledNo为X号码。
  • 当status=2时,calledNo为重新分配的临时X号码。
  • 当status=3时为null,表示用户需要自行降级到真实主号。
Status Integer 4

当前的呼叫状态。其中:

  • 1:呼叫正常。
  • 2:当前绑定关系呼叫状态异常,平台重新分配了一个临时可用的X号码用于呼叫。
  • 3:当前绑定呼叫异常,且分配临时号码失败。建议用户降级为透传真实的被叫号码来继续呼叫。
  • 4:绑定关系已经过期。

示例

请求示例


http(s)://[Endpoint]/?SubsId=1000000768798832
&PoolKey=FC123456
&<公共请求参数>

正常返回示例

XML 格式

<QueryCallStatusResponse>
	  <Message>OK</Message>
	  <RequestId>E7F99446-8191-43C0-99B5-F58A6AEAD7D5</RequestId>
	  <SecretCallStatusDTO>
		    <Status>4</Status>
		    <CalledNo>17000000000</CalledNo>
	  </SecretCallStatusDTO>
	  <Code>OK</Code>
</QueryCallStatusResponse>

JSON 格式

{
	"Message":"OK",
	"RequestId":"E7F99446-8191-43C0-99B5-F58A6AEAD7D5",
	"SecretCallStatusDTO":{
		"Status":4,
		"CalledNo":"17000000000"
	},
	"Code":"OK"
}

错误码

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