Skip to main content
POST
Most integrations should generate a reusable personal access token in the Phonovation application. Use this OAuth compatibility endpoint when your integration requires an OAuth token lifecycle.

Body

application/x-www-form-urlencoded

OAuth credentials or a refresh token, encoded as form fields.

OAuth compatibility request that exchanges Phonovation user credentials for an access token and refresh token. Most integrations should use a UI-generated PAT instead.

client_id
enum<string>
default:messaging-api
required

OAuth client identifier. Use messaging-api.

Available options:
messaging-api
grant_type
enum<string>
required

Use password to exchange user credentials for OAuth tokens.

Available options:
password
username
string
required

Your Phonovation username.

password
string<password>
required
write-only

Your Phonovation password.

Response

OAuth tokens issued successfully.

OAuth tokens and their lifetimes.

access_token
string
required

OAuth access token to reuse in the Authorization header until it is close to expiry.

expires_in
integer<int32>
required

Access-token lifetime in seconds.

token_type
string
required

Authorization scheme for the access token.

Example:

"Bearer"

refresh_expires_in
integer<int32>

Refresh-token lifetime in seconds, when returned.

refresh_token
string

Token used to obtain a new access token without resending user credentials.

id_token
string

OpenID Connect ID token, when returned for the requested scope or flow.

not-before-policy
integer<int32>

Authentication not-before policy value, when returned.

session_state
string

Authentication session identifier, when returned.

scope
string

Space-separated OAuth scopes granted to the token, when returned.