Sign in
Subscriber Tokens

Create Subscriber guest token

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.

post/api/fabric/guests/tokens

Request body

allowed_addressesUuid[] required

List of up to 10 UUIDs representing the allowed Fabric addresses.

expire_atinteger

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'

region'us-central'

A routing override that controls which regional cluster the SDK connects to.

ch'us-central'

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

Example request

{
  "expire_at": 1725513600,
  "region": "us-central",
  "ch": "us-central"
}

Response

The request has succeeded and a new resource has been created as a result.

tokenstring jwt required
refresh_tokenstring jwt required

Changes

No changes found, but 3 of the 161 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.