v4

latestSwagger 2.02026-07-13145.6 KB
Turn

Issue a configuration for an STUN/TURN server.

post/networkTraversal/:issueRelayConfiguration

Query parameters

api-versionstring required

Version of API to invoke.

Request body

idstring

An identity to be associated with telemetry for data relayed using the returned credentials. Must be an existing ACS user identity. If not provided, the telemetry will not contain an associated identity value.

routeType'any' | 'nearest'

The routing methodology to where the ICE server will be located from the client. "any" will have higher reliability while "nearest" will have lower latency. It is recommended to default to use the "any" routing method unless there are specific scenarios which minimizing latency is critical.

ttlinteger

The credential Time-To-Live (TTL), in seconds. The default value will be used if given value exceeds it.

Response

Success

expiresOnstring date-time required

The date for which the username and credentials are not longer valid. Will be 48 hours from request time.

All 1 operations