You need to enable JavaScript to run this app.
导航

查询呼叫记录

最近更新时间2023.08.17 21:02:13

首次发布时间2023.02.28 20:31:39

根据通话id查询通话详情

  • 请求地址:https://cloud-vms.volcengineapi.com

  • 请求方式:POST

1. 请求参数
参数数据类型是否必填示例值描述
X-DateString20201103T104027Z鉴权字段。请参考文档中心-火山引擎

Authorization

String

HMAC-SHA256 Credential***

鉴权字段。请参考文档中心-火山引擎

ServiceNameStringvms服务名称。该接口是vms
RegionStringcn-north-1区域名称,固定值cn-north-1

Content-Type

String

application/x-www-form-urlencoded

Query

参数参数类型是否必选示例值描述
ActionStringQueryCallRecordMsg接口名称。该接口固定值为QueryCallRecordMsg
VersionString2022-01-01接口版本。接口版本为2022-01-01,注意与旧版服务不同

Body

参数参数类型是否必选示例值描述

CallIdList

String

NM12345,Dcc12345

通话id列表,以英文逗号间隔。
单次最大查询量为100条

2. 请求示例
curl --location --request POST 'https://cloud-vms.volcengineapi.com?Action=QueryCallRecordMsg&Version=2022-01-01' \
--header 'ServiceName: vms' \
--header 'Region: cn-north-1' \
--header 'X-Date: 20201103T104027Z' \
--header 'Authorization: HMAC-SHA256 Credential=***' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'CallIdList=NM12345,Dcc12345'
3. 响应消息
参数数据类型描述
ResponseMetadataResponseMetadata响应公共参数。
ResultResult响应业务参数。

ResponseMetadata

参数数据类型描述
RequestIdstring请求 ID。
Actionstring请求的接口名称。
Versionstring请求的版本号。
Servicestring请求的服务名称。
Regionstring请求的区域。
ErrorError错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见错误码部分。

Result

参数数据类型描述
话单数组Array话单,根据不同子服务类型返回不同字段,参考呼叫记录

备注:新版接口与旧版接口的区别在于时间字段使用了不同的序列化方式,新版使用unix时间戳(毫秒),旧版使用ISO8601格式(yyyy-MM-dd'T'HH:mm:ss.SSSZ)

Error

参数数据类型描述
Codestring错误码。
Messagestring错误信息。

错误码

火山引擎网关的公共错误码,请参见火山引擎网关公共错误码

CodeMessage说明处理建议
RequestParametersErrorUnexpected Parameters参数异常检查请求通话id数量是否超过100
SystemErrorThe system meets an error while executing your request, contact us please服务异常,可能是遇到了网络抖动可重试请求
4. 响应实例
{
    "ResponseMetadata": {
        "RequestId": "2021011918400501022510703413004E18",
        "Action": "QueryCallRecordMsg",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1"
    },
    "Result": [
        {
            "callId": "NM12345",
            "callerCityCode": "025",
            "serviceType": 100,
            "callDuration": 3,
            "calleeProvinceCode": "310000",
            "ringTime": 1657536036000,
            "userData": "",
            "numberPoolNo": "NP123",
            "callee": "13688888888",
            "callerProvinceCode": "320000",
            "calleeCountryIsoCode": "CN",
            "beginCallTime": 1657536036000,
            "callType": 1,
            "accountId": "2000000001",
            "caller": "13888888888",
            "subServiceType": 101,
            "releaseType": 0,
            "startTime": 1657536036000,
            "callerCountryIsoCode": "CN",
            "endTime": 1657536039000,
            "callResult": 1,
            "audioRecordFlag": 1,
            "calleeCityCode": "021",
            "outId":"2342434654"
        }
    ]
}