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

使用说明

此接口为通用查询接口,可查询语音通知、语音验证码、语音IVR、语音双呼、智能语音交互呼入、智能语音交互呼出、智能外呼机器人呼叫记录。

QPS限制

  • 单用户调用频率:100次/秒。
  • API频率:500次/秒。
说明 如果多个用户的总调用超过API频率也会触发流控。

调试

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

请求参数

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

系统规定参数。取值:QueryCallDetailByCallId

CallId String 116014888060^10281631****

通话的唯一识别ID。

说明
  • 调用其他外呼接口发起通话后,返回参数中会携带CallId。
  • CallId与QueryDate必须是同一天。
  • CallId必须与产品ProdId相匹配。
ProdId Long 11000000300006

产品ID。取值:

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

指定通话发生的时间。格式为Unix时间戳,单位:毫秒。

说明 会查询这个时间点对应的一整天的记录。

返回数据

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

请求状态码。

  • 返回OK代表请求成功。
  • 其他错误码,请参见错误码列表
Message String OK

状态码的描述。

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

呼叫详情。JSON格式。

  • caller:主叫号码。
  • startDate:通话开始时间。
  • stateDesc:通话状态描述。
  • duration:通话时长。单位:秒。0:用户未接通。
  • callerShowNumber:主叫显号。
  • gmtCreate:通话请求的接收时间。
  • state:通话状态。通话状态是运营商实时返回的,更多状态信息,请参见运营商回执错误码
  • endDate:通话结束时间。
  • calleeShowNumber:被叫显号。
  • callee:被叫号码。
RequestId String A90E4451-FED7-49D2-87C8-00700A8C4D0D

请求ID。

示例

请求示例

http(s)://dyvmsapi.aliyuncs.com/?Action=QueryCallDetailByCallId
&CallId=116014888060^10281631****
&ProdId=1100000030****
&QueryDate=1553774465000
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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