Skip to main content

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

    room_id uuidrequired

    The unique identifier of a room.

Body

required

Parameters that can be defined during Room Client Token creation.

    token_ttl_secs integer

    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.

    refresh_token_ttl_secs integer

    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.

Schema

    data

    object

    token jwt
    token_expires_at datetime

    ISO 8601 timestamp when the token expires.

    refresh_token jwt
    refresh_token_expires_at datetime

    ISO 8601 timestamp when the refresh token expires.

403: Forbidden

Schema

    code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object
Loading...