POST api/2.0/authentication/sendsms This function requires authentication

Description

Sends SMS with an authentication code.

Parameters
Name Description Type Example
UserName
sent in body
Username / email string some text
Password
sent in body
Password string some text
PasswordHash
sent in body
Password hash string some text
Provider
sent in body
Provider type string some text
AccessToken
sent in body
Provider access token string some text
SerializedProfile
sent in body
Serialized user profile string some text
Code
sent in body
Two-factor authentication code string some text
CodeOAuth
sent in body
Code for getting a token string some text
Session
sent in body
Session based authentication or not Bool value true
ConfirmData
sent in body
Confirmation data ASC.Web.Api.ApiModel.RequestsDto.ConfirmData
RecaptchaResponse
sent in body
reCAPTCHA response string some text
Example
POST api/2.0/authentication/sendsms
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "UserName": "some text",
  "Password": "some text",
  "PasswordHash": "some text",
  "Provider": "some text",
  "AccessToken": "some text",
  "SerializedProfile": "some text",
  "Code": "some text",
  "CodeOAuth": "some text",
  "Session": true,
  "ConfirmData": {
    "Email": "some text",
    "Module": "some text",
    "Key": "some text"
  },
  "RecaptchaResponse": "some text"
}
Returns

Authentication data

Example Response
{
  "status": 0,
  "response": {
    "Token": "some text",
    "Expires": "2008-04-10T06-30-00.000Z",
    "Sms": true,
    "PhoneNoise": "some text",
    "Tfa": true,
    "TfaKey": "some text",
    "ConfirmUrl": "some text"
  }
}