Skip to main content

Ice Servers v1.0

Operations supporting ice servers necessary for establishing video calls and conferences

info

You are viewing REST API documentation. This documentation is auto-generated from a swagger specification which itself is generated from annotations in the source code of the project. It is possible that this documentation includes bugs and that code samples are incomplete or wrong.

Authentication

IceSupport

Ice Servers Controller

Obtains iceServers for use by WebRTC peers

GET https://auvious.video:443/rtc-api/iceServers/v2 HTTP/1.1
Host: auvious.video:443
Accept: application/json

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKIceServersResultV2
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
Examples

200 Response

{
"stun": "string",
"ttl": 0,
"turn": "string",
"turnPassword": "string",
"turnUsername": "string"
}
caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

curl -X GET https://auvious.video:443/rtc-api/iceServers/v2 \
-H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'

Schemas

IceServer

{
"credential": "string",
"urls": [
"string"
],
"username": "string"
}

IceServer

Properties

NameTypeRequiredRestrictionsDescription
credentialstringfalsenonenone
urls[string]falsenonenone
usernamestringfalsenonenone

IceServersResult

{
"iceServers": [
{
"credential": "string",
"urls": [
"string"
],
"username": "string"
}
],
"ttl": 0
}

IceServersResult

Properties

NameTypeRequiredRestrictionsDescription
iceServers[IceServer]falsenonenone
ttlinteger(int32)falsenonenone

IceServersResultV2

{
"stun": "string",
"ttl": 0,
"turn": "string",
"turnPassword": "string",
"turnUsername": "string"
}

IceServersResultV2

Properties

NameTypeRequiredRestrictionsDescription
stunstringfalsenonenone
ttlinteger(int32)falsenonenone
turnstringfalsenonenone
turnPasswordstringfalsenonenone
turnUsernamestringfalsenonenone