数据结构定义¶

在服务器API中，用 JSON 对象格式记录各个实体的属性。

本章节使用面向对象语言类型定义的伪代码形式描述各个实体以及其属性的含义与数据类型。

注意

事件通知数据的结构定义不在本章，具体请参见通知 API

WebRTC 客户端¶

class sapi.WebRtcClient¶

该数据结构用于记录一个 WebRTC 客户端实例的相关信息。

id¶

客户端ID

返回类型:	str

project¶

该客户端所属的项目的 SID

返回类型:	str

wskey¶

客户端 WebSocket 连接关键字

返回类型:	str

class sapi.Call¶

id¶

呼叫ID

返回类型:	str

dir¶

呼叫方向

返回类型:	str

定义:

方向	表达式
呼入	incoming
呼出	outgoing

current_state¶

当前呼叫状态，详见呼入过程与呼出过程

返回类型:	str

定义:

prior_state¶

上一个呼叫状态，其属性值含义与 current_state 一致。

返回类型:	str

注解

当呼叫刚刚建立时，其当前状态 current_state 为 pending ，prior_state 值是 null 。

from¶

返回类型:	str

to¶

返回类型:	str