Create Alias
Request
The Create Alias endpoint allows you to generate a new alias. This alias can be configured with specific parameters such as expiration time and authentication type (Basic or JWT), enabling secure and time-bound access control.
Endpoint:
POST /organization/api/v1/alias/create
URL:
https://link.api.datagram.network/organization/api/v1/alias/create
Body Parameters
type
string
âś… Yes
The type of alias. Valid values: “live”, “conference”.
conference
name
string
❌ No
Custom name for the alias.
WeeklySyncMeeting
passcode
string
❌ No
Optional passcode for basic authentication.
secure123
jwt_secret
string
❌ No
Optional JWT secret for advanced authentication.
eyJhbGciOi...
or null
stream_key
string
❌ No
Optional stream key used for streaming.
stream_4571AB
or null
expired_at
integer
âś… Yes
Expiry time for the alias in UNIX timestamp (seconds).
30
Example Request
POST /organization/api/v1/alias/create HTTP/1.1
Host: link.api.datagram.network
Authorization: Bearer <your_token>
Content-Type: application/json
{
"type": "live",
"name": "New Alias Name",
"passcode": "pass",
"jwt_secret": null,
"stream_key": null,
"expired_at": 1737456308
}
Responses
Alias successfully created.
Response Body Parameters
id
string
Unique identifier for the created alias.
xxyzx
type
string
Type of alias (“live” or “conference”).
"live"
name
string
Name of the alias.
DemoSessionAlias
passcode
string
Passcode for basic authentication.
demo1234
jwt_secret
string
JWT secret for advanced authentication. May be null if not provided.
eyJhbGciOi...
stream_key
string
Stream key associated with the alias. May be null if not used.
stream_XYZ123
expired_at
integer
Expiration time of the alias in UNIX timestamp format (seconds).
1737456308
Example
{
"data": {
"id": "xxyzx",
"type": "live",
"name": "New Alias Name",
"passcode": "pass",
"jwt_secret": null,
"stream_key": null,
"expired_at": 1737456308
}
}
Last updated