租户实例串流前获取设备的device_token
功能介绍
租户实例串流前获取设备的device_token, 调用此api的前提条件是租户需要先购买koophone云手机实例。 调用该接口获取云机实例的device_token后作为鉴权信息,并携带云机实例的device_id去调用反参中的信令地址(signaling_url)。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/instances/{instance_id}/auth
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
instance_id |
是 |
String |
实例id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
x-auth-token |
是 |
String |
租户的iam token信息 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
data |
data object |
反参全部信息 |
error_code |
String |
错误码, 0表示成功 |
error_msg |
String |
错误信息 |
参数 |
参数类型 |
描述 |
---|---|---|
sdk |
sdk object |
sdk信息 |
rtc |
rtc object |
rtc信息 |
device_id |
String |
设备id |
kp_id |
String |
云机实例Id,如whklpuo1 |
参数 |
参数类型 |
描述 |
---|---|---|
address |
String |
内网ip地址 |
aport |
String |
音频端口 |
atype |
String |
音频类型 |
address_ipv6 |
String |
ipv6地址 |
参数 |
参数类型 |
描述 |
---|---|---|
address |
String |
外网eip地址 |
aport |
Integer |
音频端口 |
atype |
Integer |
音频类型 |
address_ipv6 |
String |
外网ipv6地址 |
参数 |
参数类型 |
描述 |
---|---|---|
signaling_url |
String |
信令服务访问地址 |
expired_time |
String |
streaming时长。单位秒 |
ice_servers |
Array of strings |
ICE 服务器 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
响应码,错误码规范KOOPHONE.API.0001,数字递增 error_code为0时表示成功 |
error_msg |
String |
响应描述 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
响应码,错误码规范KOOPHONE.API.0001,数字递增 error_code为0时表示成功 |
error_msg |
String |
响应描述 |
请求示例
post接口,请求url中携带租户自己购买的koophone实例和租户的token直接调用
/v1/instances/Q39YyZvI/auth
响应示例
状态码: 200
实例鉴权接口返回设备信息
{ "data" : { "resource" : { "sdk" : { "internal" : { "address" : null, "aport" : null, "atype" : null, "address_ipv6" : null }, "external" : { "address" : "10.xx.xx.xxx", "aport" : 10030, "atype" : 1, "address_ipv6" : null } }, "rtc" : { "ice_signaling" : { "signaling_url" : "http://xxxxxxxxxx", "expired_time" : null, "ice_servers" : [ ] } }, "device_id" : "7b0cd026df8d495b8a65d628d7bec433", "kp_id" : "Q39YyZvI" }, "device_token" : "dee5081f40c83ddea3ded91c387351e9" }, "error_code" : "0", "error_msg" : "ok" }
状态码: 400
请求错误
{ "error_code" : "string", "error_msg" : "string" }
状态码: 500
内部错误
{ "error_code" : "string", "error_msg" : "string" }
状态码
状态码 |
描述 |
---|---|
200 |
实例鉴权接口返回设备信息 |
400 |
请求错误 |
500 |
内部错误 |
错误码
请参见错误码。