获取 PSTN 活动会话列表

最近更新时间:2024-04-22 01:09:31

我的收藏

1. 接口描述

接口请求域名: ccc.tencentcloudapi.com 。

获取当前正在通话的会话列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribePSTNActiveSessionList。
Version String 公共参数,本接口取值:2020-02-10。
Region String 公共参数,此参数为可选参数。
SdkAppId Integer 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc
示例值:1400000000
Offset Integer 数据偏移
示例值:0
Limit Integer 返回的数据条数,最大 25
示例值:25

3. 输出参数

参数名称 类型 描述
Total Integer 列表总条数
示例值:1
Sessions Array of PSTNSessionInfo 列表内容
示例值:[{"sessionId":"123456789","roomId":"9876","caller":"John","callee":"Alice","protectedCaller":"+1234567890","protectedCallee":"+9876543210","startTimestamp":"1600007226","ringTimestamp":"1600007240","acceptTimestamp":"1600007250","staffUserId":"staff123","staffNo":"S123","sessionStatus":"Active","callType":"callin"},{"sessionId":"987654321","roomId":"1234","caller":"Alice","callee":"John","startTimestamp":"1400753150","ringTimestamp":"1400753160","acceptTimestamp":"1400753170","staffUserId":"staff456","staffNo":"S456","sessionStatus":"Completed","callType":"callout"}]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取 PSTN 活动会话列表示例

输入示例

https://ccc.tencentcloudapi.com/?Action=DescribePSTNActiveSessionList
&SdkAppId=1400000000
&Offset=0
&Limit=25
&<公共请求参数>

输出示例

{
    "Response": {
        "Total": 1,
        "RequestId": "53bccf04-0870-4520-8614-f4bdddfd68df",
        "Sessions": [
            {
                "Direction": 1,
                "AcceptTimestamp": "1607702329",
                "ProtectedCaller": "",
                "RoomID": "32929373",
                "StartTimestamp": "1607702199",
                "Caller": "00864009282737",
                "ProtectedCallee": "",
                "StaffNumber": "1007",
                "SessionID": "0cf5be1b-de75-4445-a0c4-8dff3fa4b68b",
                "StaffEmail": "foo@tencent.com",
                "RingTimestamp": 1607702299,
                "Callee": "00864001783747",
                "SessionStatus": "inProgress"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.PermissionDenied 权限不足。
InternalError 内部错误。
LimitExceeded.OutOfCountLimit 超出数量限制。