REST ClientChatResource

createToken

View as MarkdownOpen in Claude

Chat API namespace — token creation.

Request

ttlintegerRequired1-43200
The maximum time, in minutes, that the access token will be valid for. Between 1 and 43,200 (30 days).
channelsobjectRequired
User-defined channel names with read/write permissions. Max of 500 channels. Channel names cannot start with the reserved prefix `sw_` and can be up to 250 characters.
member_idstringOptional<=250 characters
The unique identifier of the member. Up to 250 characters. If not specified, a random UUID will be generated.
stateobjectOptional
An arbitrary JSON object available to store stateful application information in. Must be valid JSON and have a maximum size of 2,000 characters.

Response

tokenstringRequired
The generated Chat Token.

Response Example

Response
1{
2  "token": "eyJ0eXAiOiJWUlQiLCJhbGciOiJIUzUxMiJ9.eyJpYXQiOjE2MjIxMjAxMjMsI...wMCwicnNlIjo5MDB9-BqG-DqC5LhpsdMWEFjhVkTBpQ"
3}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient();
4const result = await client.chat.createToken({ channels: ['general'] });
5console.log(result);