Skip to navigation
Resource ManagementSubscribersSubscriber Tokens

Create Subscriber guest token

View as MarkdownOpen in Claude

Creates a temporary guest Subscriber token limited to the resource addresses in allowed_addresses. Call it from your server when a user without a full subscriber account needs scoped calling access. The token expires after two hours by default; authenticate this request with a project API token and give only the returned guest token to the client.

Use Create Subscriber token for a known subscriber, or Create guest embed token when exchanging a public Click-to-Call token.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, or Video.

Learn more about API scopes.

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

Request

This endpoint expects an object.
allowed_addresseslist of stringsRequired
List of up to 10 UUIDs representing the allowed Fabric addresses.
expire_atintegerOptional

A unixtime (the number of seconds since 1970-01-01 00:00:00) at which the token should no longer be valid. Defaults to 'two hours from now'

regionenumOptional
A routing override that controls which regional cluster the SDK connects to.
Allowed values:
chenumOptional

A direct routing override specifying the regional cluster endpoint, set as the ch claim in the SAT JWE header.

Allowed values:

Response

The request has succeeded and a new resource has been created as a result.
tokenstringformat: "jwt"
Guest Token
refresh_tokenstringformat: "jwt"
Refresh Token

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error