POST api/2.0/authentication/setphone

Description

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

Parameters

Name	Description	Type	Example
userName sent in body	User name or email	string	some text
password sent in body	Password	string	some text
provider sent in body	Social media provider type	string	some text
accessToken sent in body	Provider token	string	some text
mobilePhone sent in body	New mobile phone	string	some text

Example

POST api/2.0/authentication/setphone
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "userName": "some text",
  "password": "some text",
  "provider": "some text",
  "accessToken": "some text",
  "mobilePhone": "some text"
}

Returns

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

Example Response

application/json

{
  "status": 0,
  "response": {
    "Token": "abcde12345",
    "Expires": "2020-11-24T05:36:20.4206897Z",
    "Sms": true,
    "PhoneNoise": "8(999)999-99-99",
    "Tfa": true,
    "TfaKey": "123dwa"
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <Token>abcde12345</Token>
    <Expires>2020-11-24T05:36:20.4206897Z</Expires>
    <Sms>True</Sms>
    <PhoneNoise>8(999)999-99-99</PhoneNoise>
    <Tfa>True</Tfa>
    <TfaKey>123dwa</TfaKey>
  </response>
</result>

POST api/2.0/authentication/setphone

Get information

Get help