文档

ListVoicemails - 获取语音信箱列表

更新时间:

调用ListVoicemails获取指定实例下语音信箱列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

呼叫中心实例 ID。

ccc-test
PageNumberinteger

分页序号,范围 1-100。

1
PageSizeinteger

分页大小,范围 1-100。

10
StartTimelong

获取的历史数据的起始时间,默认为当天的 0 时。

1532448000000
EndTimelong

获取的历史数据的终止时间,默认为当前时间。

1532707199000
ContactIdstring

通过指定的 contactId 来查询某一通电话的记录,contactId 可以通过软电话 SDK 发生通话时获取到。如果传入该参数,则自动忽略其他查询参数。

job-125152394144124921
Callerstring

主叫号码。

073xxxx7539
Namedeprecatedstring

语音信箱名称。

voicemail-test

返回参数

名称类型描述示例值
object

返回数据。

Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

响应信息。

RequestIdstring

请求 ID。

EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
Dataobject

数据。

PageNumberinteger

分页序号。

1
PageSizeinteger

分页大小。

10
TotalCountinteger

总条目数,只有 PageNumber 为 1 才会返回,其他都是 0。

11
Listobject []

语音信箱记录列表。

CdrStartTimelong

话务开始时间。

1532448000000,已废弃,请使用StartTime。
Callerstring

主叫号码。

073xxxx7539
ContactIdstring

通话 ID。

job-125152394144124921
RecordingDurationlong

留言时长,单位秒。

10,已废弃,请使用Duration
InstanceIdstring

呼叫中心实例 ID。

ccc-test
Namestring

语音信箱名称。

voicemail-test
Calleestring

被叫号码。

0533128****
StartTimestring

语音信箱开始时间。

1631440860000
Durationlong

留言时长,单位秒。

16

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 11,
    "List": [
      {
        "CdrStartTime": 0,
        "Caller": "073xxxx7539",
        "ContactId": "job-125152394144124921",
        "RecordingDuration": 0,
        "InstanceId": "ccc-test",
        "Name": "voicemail-test",
        "Callee": "0533128****",
        "StartTime": "1631440860000",
        "Duration": 16
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。

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

变更历史

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