文档

QueryCallDetailByCallId - 查询指定通话的呼叫详情

更新时间:

查询指定通话的呼叫详情。

接口说明

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

QPS 限制

单用户调用频率:100 次/秒。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dyvms:QueryCallDetailByCallIdRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
CallIdstring

通话的唯一识别 ID。

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

    产品 ID。取值:

    • 11000000300006:语音通知。
    • 11010000138001:语音验证码。
    • 11000000300005:语音 IVR 向指定号码发起交互式语音通话。
    • 11000000300009:语音 SIP。
    • 11030000180001:智能外呼。
    11000000300006
    QueryDatelong

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

    说明 查询指定时间点对应的 24 小时的记录。例如您输入 2022.11.21 20:00:01,系统会查询 2022.11.21 20:00:01~2022.11.22 20:00:01 时间段内指定 callid 的呼叫记录。
    1671552000000

    返回参数

    名称类型描述示例值
    object

    返回数据。

    Codestring

    请求状态码。

    • 返回 OK 代表请求成功。
    • 其他错误码,请参见 API 错误码
    OK
    Messagestring

    状态码的描述。

    OK
    Datastring

    呼叫详情。JSON 格式。

    • caller:主叫号码。
    • startDate:通话开始时间。
    • stateDesc:通话状态描述。
    • duration:通话时长。单位:秒。0:用户未接通。
    • callerShowNumber:主叫显号。
    • gmtCreate:通话请求的接收时间。
    • state:通话状态。通话状态是运营商实时返回的,更多状态信息,请参见运营商回执错误码
    • endDate:通话结束时间。
    • calleeShowNumber:被叫显号。
    • callee:被叫号码。
    • aRingTime:a 路响铃开始时间。格式:yyyy-MM-dd HH:mm:ss。
    • aEndTime:a 路响铃结束时间。格式:yyyy-MM-dd HH:mm:ss。
    • bRingTime:b 路响铃开始时间。格式:yyyy-MM-dd HH:mm:ss。
    • bEndTime:b 路响铃结束时间。格式:yyyy-MM-dd HH:mm:ss。
    {"caller":"18767****","startDate":"","stateDesc":"502","duration":0,"callerShowNumber":"05344****","gmtCreate":"2017-11-27 20:09:06","state":"502","endDate":"","calleeShowNumber":"053447****","bRingTime":"2022-01-01 12:02:00","bEndTime":"2022-01-01 12:02:28","callee":"1373546****"}
    RequestIdstring

    请求 ID。

    A90E4451-FED7-49D2-87C8-00700A8C4D0D

    示例

    正常返回示例

    JSON格式

    {
      "Code": "OK",
      "Message": "OK",
      "Data": "{\"caller\":\"18767****\",\"startDate\":\"\",\"stateDesc\":\"502\",\"duration\":0,\"callerShowNumber\":\"05344****\",\"gmtCreate\":\"2017-11-27 20:09:06\",\"state\":\"502\",\"endDate\":\"\",\"calleeShowNumber\":\"053447****\",\"bRingTime\":\"2022-01-01 12:02:00\",\"bEndTime\":\"2022-01-01 12:02:28\",\"callee\":\"1373546****\"}",
      "RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D"
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史
    • 本页导读 (1)
    文档反馈