Get Started
API backend
API system
More information

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 System.String
Password
sent in body
Password System.String
PasswordHash
sent in body
Password hash System.String
Provider
sent in body
Provider type System.String
AccessToken
sent in body
Provider access token System.String
SerializedProfile
sent in body
Serialized user profile System.String
Code
sent in body
Two-factor authentication code System.String
CodeOAuth
sent in body
Code for getting a token System.String
Session
sent in body
Session based authentication or not System.Boolean
ConfirmData
sent in body
Confirmation data ASC.Web.Api.ApiModel.RequestsDto.ConfirmData
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"
  }
}
Returns

Authentication data

Example Response

application/json

{
  "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"
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <Token>some text</Token>
    <Expires>2008-04-10T06-30-00.000Z</Expires>
    <Sms>True</Sms>
    <PhoneNoise>some text</PhoneNoise>
    <Tfa>True</Tfa>
    <TfaKey>some text</TfaKey>
    <ConfirmUrl>some text</ConfirmUrl>
  </response>
</result>