loginProtectSendSMS — Sending SMS

This method allows you to send an SMS message to a user for the two-factor authentication (2FA).

The API endpoint is: https://api.sitelock.com/v1/partner

Request format

SiteLockOnlineRequest: This element is used to delineate the full API request.
- authentication: The partner’s username, password, and branding.
  - username: The partner’s API username.
  - password: The partner’s API password.
- loginProtectSendSMS: The method name.
  - site_id: The site ID for which to send the SMS message.
  - email: The user’s email address to whom the SMS message will be sent.
  - text: The SMS message’s content to be sent.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>User</user>
        <password>Password</password>
    </authentication>
    <loginProtectSendSMS>
        <site_id>1234</site_id>
        <email>[email protected]</email>
        <text>Your verification code is 123456</text>
    </loginProtectSendSMS>
</SiteLockOnlineRequest>

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- loginProtectSendSMS: The method name.
  - success: Specifies whether the SMS message was sent successfully.
  - message: A message providing additional information about the result of the request.
  - error: An error element containing an error code and an error message.

Example response

<SiteLockOnlineResponse>
    <loginProtectSendSMS>
        <success>ok</success>
        <message>ok</message>
    </loginProtectSendSMS>
</SiteLockOnlineResponse>

Example error response

<SiteLockOnlineResponse>
    <loginProtectSendSMS>
       <error code="NNNN">Error Msg…XXXX</error>
    </loginProtectSendSMS>
</SiteLockOnlineResponse>