Retrieve Alias by ID

Request

Retrieve detailed information for a specific alias by providing its unique ID. This endpoint supports both public and authenticated access, including optional basic passcode and advanced JWT authentication mechanisms. It is typically used by clients or front-end applications to fetch alias configurations before joining a session or stream.

Endpoint:

GET /api/v1/alias/:id

URL:

https://link.api.datagram.network/organization/api/v1/alias/:id

Query Parameter

Path Parameters:

Name
Type
Description

id

string

The ID of the alias to retrieve.

Query Parameters

Name
Type
Description

passcode

string

The passcode of the alias to retrieve.

Example Request

GET /api/v1/alias/bf6oi HTTP/1.1
Host: link.api.datagram.network
Authorization: <token, optional>

Response

The request was successful, and the alias information was returned in the response body.

Body

id

string

Alias ID

type

string

Alias type ("live", "conference").

name

string

Alias name.

passcode

string

Alias passcode to basic authentication.

jwt_secret

string

Alias jwt secret to advanced authentication.

stream_key

string

Alias stream key.

expired_at

integer

Expired time unix timestamp in seconds.

inserted_at

integer

Inserted the time Unix timestamp in seconds.

{
  "data": {
    "id": "12345",
    "type": "conference",
    "name": "Alias Name",
    "passcode": null,
    "jwt_secret": null,
    "stream_key": null,
    "expired_at": 1737356308,
    "inserted_at": 1737456308
  }
}

Last updated