Skip to navigation

Refresh Subscriber token

View as MarkdownOpen in Claude

Exchanges a valid refresh token for a new Subscriber Access Token (SAT) and a new refresh token. Call it from your server to continue a known subscriber’s session without issuing a token from profile data again. The new access token is valid for 2 hours, and the new refresh token is valid for 2 hours and 5 minutes.

This operation consumes the refresh_token returned by Create Subscriber token. A Browser SDK client with a fingerprint-bound sat:refresh token can refresh through the client flow instead.

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.
refresh_tokenstringRequiredformat: "jwt"
The refresh token previously issued alongside a subscriber access token. This token is used to request a new access token.

Response

The request has succeeded and a new resource has been created as a result.
tokenstringformat: "jwt"
A newly generated subscriber access token, valid for 2 hours.
refresh_tokenstringformat: "jwt"
A new refresh token, valid for 2 hours and 5 minutes.

Errors

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