调用接口QueryCallDetailByCallId查询指定通话的呼叫详情。

调用该接口前，请您注意：
  • 该接口为通用查询接口，可查询语音通知、语音验证码、语音IVR、语音双呼、智能语音交互呼入、智能语音交互呼出、智能外呼机器人呼叫记录。
  • 请将接口QueryCallDetailByCallId的调用频率限制在100次/分钟之内。

调试

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

请求参数

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

系统规定参数。取值：QueryCallDetailByCallId。

CallId String 是 116014888060^1028163130xx

通话的唯一识别ID。调用其他外呼接口发起通话后，返回参数中会携带CallId。

ProdId Long 是 11000000300006

产品ID。

  • 11000000300006：语音通知。
  • 11010000138001：语音验证码。
  • 11000000300005：语音IVR。
  • 11000000300004：语音双呼。
  • 11000000300009：语音SIP。
  • 11030000180001：智能外呼。
QueryDate Long 是 1553774465

指定通话发生的时间，格式为Unix时间戳，单位毫秒。会查询这个时间点对应的一整天的记录。

返回数据

名称 类型 示例值 描述
RequestId String A90E4451-FED7-49D2-87C8-00700A8C4D0D

请求ID。
Data String {“caller”:”18767xxxx”,”startDate”:””,”stateDesc”:”502”,”duration”:0,”callerShowNumber”:”05344xxxx”,”gmtCreate”:”2017-11-27 20:09:06”,”state”:”502”,”endDate”:””,”calleeShowNumber”:”053447xxxx”,”callee”:”1373546xxxx”}

呼叫详情。

  • caller：主叫号码。
  • startDate：呼叫开始时间。
  • stateDesc：通话状态描述。
  • duration：通话时长。
  • callerShowNumber：主叫显号。
  • gmtCreate：通话请求的接收时间。
  • state：通话状态。
  • endDate：呼叫结束时间。
  • calleeShowNumber：被叫显号。
  • callee：被叫号码。
Code String OK

请求状态码。
Message String OK

状态码的描述。

示例

请求示例

http(s)://[Endpoint]/?Action=QueryCallDetailByCallId
&CallId=116014888060^1028163130xx
&ProdId=11000000300006
&QueryDate=1553774465
&<公共请求参数>

正常返回示例

XML 格式 

<QueryCallDetailByCallIdResponse>
  <Code>OK</Code>
  <Data>{“caller”:”18767xxxx”,”startDate”:””,”stateDesc”:”502”,”duration”:0,”callerShowNumber”:”05344xxxx”,”gmtCreate”:”2017-11-27 20:09:06”,”state”:”502”,”endDate”:””,”calleeShowNumber”:”053447xxxx”,”callee”:”1373546xxxx”}</Data>
  <Message>OK</Message>
  <RequestId>A90E4451-FED7-49D2-87C8-00700A8C4D0D</RequestId>
</QueryCallDetailByCallIdResponse>

JSON 格式 

{
	"Code": "OK",
    "Data": "{“caller”:”18767xxxx”,”startDate”:””,”stateDesc”:”502”,”duration”:0,”callerShowNumber”:”05344xxxx”,”gmtCreate”:”2017-11-27 20:09:06”,”state”:”502”,”endDate”:””,”calleeShowNumber”:”053447xxxx”,”callee”:”1373546xxxx”}",
	"Message": "OK",
	"RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D"
}

错误码

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