> For the complete documentation index, see [llms.txt](https://docs.antbuddy.us/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.antbuddy.us/integration-document-guide/antbot/voice-otp.md).

# Voice OTP

#### Voice OTP

**Integration and Use of Voice OTP**

**Purpose**:\
Allows the use of Alice Voice OTP from a third-party provider.

**API Details**

All API requests to the Alice system are made via the domain:\
`https://alice.antbuddy.com/rest-api`

**Authorization Header (required)**:\
`Authorization: Bearer {access_token}`

***

**Get AccessToken**

* **Endpoint**: `/get-token/`
* **Method**: POST
* **Body**:

  ```json
  jsonCopyEdit{
    "username": "username",
    "password": "password"
  }
  ```
* **Description**:
  * **username**: Username or email registered with Antbuddy.
  * **password**: Password.

***

**Create OTP Call Request**

* **API to Create OTP Code Request for a Phone Number:**
* **View existing OTP calls**
  * **Endpoint**: `/voice-otp/`
  * **Method**: GET
* **Create OTP call**
  * **Endpoint**: `/voice-otp/`
  * **Method**: POST
  * **Body**:

    ```json
    jsonCopyEdit{
      "alarm_phonenumber": "0919273027",
      "otp": "123445",
      "maxretry": 0
    }
    ```
* **Description**:
  * **alarm\_phonenumber**: Phone number to receive the OTP code (required).
  * **otp**: OTP code to send to the phone number. If left blank or not provided, the system will automatically generate a random code for testing purposes.
  * **maxretry**: Number of retry attempts for the OTP reading. Default is `0`, which corresponds to one attempt.