Refresh an Access Token

To ensure secure and seamless communication between Yeastar Workplace and third-party application, you need to refresh the access token before it expires.

Request URL

POST {base_url}/services/openapi/v1.0/authentication/refresh_token

Request parameters

Body parameters


Parameter	Required	Type	Description
client_id	Yes	String	Client ID.
client_secret	Yes	String	Client secret.
refresh_token	Yes	String	The latest `refresh_token` value.

Response parameters


Parameter	Type	Description
access_token	String	The new access token.
refresh_token	String	The new refresh token.
expires_in	Integer	The remaining validity period of the access token (Unit: second).

Examples

Request example

Refresh an access token.

POST /services/openapi/v1.0/authentication/refresh_token HTTP/1.1
Host: workplace.yeastar.com
Content-Type: application/x-www-form-urlencoded

client_id=79568aa0-xxxx-xxxx-xxxx-79a16d73472a&client_secret=rLZN4Uocxxxxd5ZVyQgS4GcAbZD1&refresh_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsiL29wZW5hcGkvIl0sImF0aSI6ImM4MDRkM2E3LWZhZTYtNGZhZC1iYTEyLWQ0NDQwYmNjMGIyMyIsImVudGVycHJpc2VfaWQiOjEwMDQzMywicmVnaW9uIjoiR0wiLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI2ZDRkMGFhMi0wYWY4LTQ5NTctOWFkYS1hOWM4ZmFhMDc4ODciLCJjbGllbnRfaWQiOiI3OTU2OGFhMC0wYjBkLTQyZjYtOGRiNC03OWExNmQ3MzQ3MmEiLCJ0cyI6MTY4OTczNjk1NCwiZXhwX2luIjo4NjQwMH0._ifT5MqC0Fvl1hIeLeTUZCowYYa8goQjzBYXLu8mbfY

Response example

HTTP/1.1 200 OK
{
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsiL29wZW5hcGkvIl0sImF0aSI6ImM4MDRkM2E3LWZhZTYtNGZhZC1iYTEyLWQ0NDQwYmNjMGIyMyIsImVudGVycHJpc2VfaWQiOjEwMDQzMywicmVnaW9uIjoiR0wiLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI2ZDRkMGFhMi0wYWY4LTQ5NTctOWFkYS1hOWM4ZmFhMDc4ODciLCJjbGllbnRfaWQiOiI3OTU2OGFhMC0wYjBkLTQyZjYtOGRiNC03OWExNmQ3MzQ3MmEiLCJ0cyI6MTY4OTczNzUxOSwiZXhwX2luIjo4NjM5OX0.6lXYzOwgWbjzOLGECXxw_wvLCN3SBwHIIX9NB_R78B4",
    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsiL29wZW5hcGkvIl0sImF0aSI6IjEyNGFmMGI3LWNjMzgtNGEwZC1hZWIwLTEyNWYxNzIwZWRmYyIsImVudGVycHJpc2VfaWQiOjEwMDQzMywicmVnaW9uIjoiR0wiLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI2ZDRkMGFhMi0wYWY4LTQ5NTctOWFkYS1hOWM4ZmFhMDc4ODciLCJjbGllbnRfaWQiOiI3OTU2OGFhMC0wYjBkLTQyZjYtOGRiNC03OWExNmQ3MzQ3MmEiLCJ0cyI6MTY4OTczNzUxOSwiZXhwX2luIjo4NjM5OX0.dn_Zf1MuHaNQWuSpe7wIbPM2c9xGO2z5qaYmTsVvDTo",
    "expires_in": 86399
}