Create Client Token to join a room.
POST/rooms/:room_id/actions/generate_join_client_token
Synchronously create an Client Token to join a Room. Client Token is necessary to join a Telnyx Room. Client Token will expire after token_ttl_secs
, a Refresh Token is also provided to refresh a Client Token, the Refresh Token expires after refresh_token_ttl_secs
.
Request
Path Parameters
The unique identifier of a room.
- application/json
Body
required
Parameters that can be defined during Room Client Token creation.
Possible values: >= 10
and <= 3600
Default value: 600
The time to live in seconds of the Client Token, after that time the Client Token is invalid and can't be used to join a Room.
Possible values: >= 60
and <= 86400
Default value: 3600
The time to live in seconds of the Refresh Token, after that time the Refresh Token is invalid and can't be used to refresh Client Token.
Responses
201: Create room client token response.
- application/json
403: Forbidden
- application/json