WebRTC 客户端管理 API¶
获取客户端列表¶
-
POST
/v0.1/sapi/Client/list
¶ 获取
sapi.Client
实例列表Request JSON Object: - page (int) – 要返回的页码。如果不指定,默认为0(从0开始)。
- per_page (int) – 每页长度。如果不指定,服务器采用其默认设置。
Response JSON Object: - current_page (int) – 当前返回结果的页码(从0开始)。
- per_page (int) – 每页长度。
- total_pages (int) – 总页数。
- total_entries (int) – 总条目数。
- entries (list) –
sapi.Client
对象列表。
举例
客户端调用:
POST /v0.1/sapi/Client/list HTTP/1.1
Host: api.linkrtc.com
Content-Type: application/json; charset=utf-8
Content-Length: xxx
{
"page": 1,
"per_page": 20
}
服务器回复:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: xxx
{
"current_page": 1,
"per_page": 20,
"total_pages": 3,
"total_entries": 57,
"entries": [
{"..": "...", "..": "...", "..": "..."},
{"..": "...", "..": "...", "..": "..."}
]
}
获取客户端详情¶
-
POST
/v0.1/sapi/Client/detail
¶ 获取指定 id (client_id) 的
sapi.Client
实例的详情Request JSON Object: - name (str) – 客户端的名称
Response JSON Object: - data (object) –
sapi.Client
对象
举例
客户端调用:
POST /v0.1/sapi/client/1001/detail HTTP/1.1 Host: api.linkrtc.com Content-Type: application/json; charset=utf-8 Content-Length: xxx {"name": "client-01"}
服务器回复:
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xxx { "data": { "id": "xxxxx", "name": "xxxxx", "...": "..." } }
新建客户端¶
-
POST
/v0.1/sapi/Client/create
¶ 新建一个
sapi.client
对象Request JSON Object: - name (str) – 要新建的
sapi.Client
对象的名称,对应sapi.Client.name
属性.
Response JSON Object: - data (object) – 新建的
sapi.Client
对象
- name (str) – 要新建的