Set a mobile phone

POST /api/2.0/authentication/setphone

Request

Sets a mobile phone for the user with the name specified in the request.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

userNamestring

User name or email

passwordstring

Password

providerstring

Social media provider type

accessTokenstring

Provider token

mobilePhonestring

New mobile phone

Examples

POST /api/2.0/authentication/setphone HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request POST \
  --url https://example.com/api/2.0/authentication/setphone \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Authentication data: authentication by SMS or not, phone number, SMS expiration time

Tokenstring
Expiresstring
Smsboolean
PhoneNoisestring
Tfaboolean
TfaKeystring

Get Help

  • If you have any questions about ONLYOFFICE Workspace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).