---
updatedAt: 2025-04-03T21:29:45.000Z
agentTools:
  projectIndex: https://docs.dimensionlabs.io/llms.txt
---

# Avaya Cloud

Avaya Cloud Office is a comprehensive unified communications platform designed to streamline business communications with advanced features such as voice, video, messaging, and collaboration tools.

Welcome to the Slack documentation for Dimension! Integrating Dimension into your Slack bot is quick and easy.

If you have any questions, comments, or suggestions, please feel free to [contact us](mailto:support@dashbot.io).

### [Avaya Cloud API Key](https://documentation.avaya.com/bundle/IPOfficeWorkplaceInstall/page/Obtaining_the_Domain_API_Key_and_Key_Secret.html)

1. Login to Avaya Cloud Services at [https://accounts.avayacloud.com](https://accounts.avayacloud.com/).
2. Click on **Manage Companies** and click on the existing company name.
3. Select the **API** tab.
   * If there is an existing key with its **Role** set to IPOFFICE key:
     * Click **View/Edit** and use the menu controls to either download the values as a CSV file, or to copy and paste the values to a temporary document on your PC.
   * If there is no existing key with its **Role** set to IPOFFICE key:
     * Click **Add API key+**. Set the role to **IPOFFICE** and click **Add API key**.
     * Click **View/Edit** and use the menu controls to either download the values as a CSV file, or to copy and paste the values to a temporary document on your PC.

### Get Messages from Avaya Cloud

To retrieve messages from Avaya Cloud, you'll use the "List SMS" API endpoint. Here's a basic example of how to do this:

1. **Endpoint**: `https://docs.avayacloud.com/aspx/rest#list-sms`
2. **Method**: GET
3. **Headers**:
   * `Authorization`: `Bearer {Your_Avaya_API_Key}`
4. **Parameters**: Customize your request based on the query parameters supported by the Avaya API, such as `startDate`, `endDate`, or `phoneNumber`.

Example Request to Avaya Cloud:

```python
import requests

url = "<https://api.avayacloud.com/messaging/v1/sms>"
headers = {
    "Authorization": "Bearer {Your_Avaya_API_Key}"
}
response = requests.get(url, headers=headers)
messages = response.json()
```

### Post Messages to Dimension

After retrieving messages from Avaya Cloud, you can forward them to Dimension using its Universal REST API.

1. **Endpoint**: `https://tracker.dashbot.io/track?platform=universal&v=11.1.0-rest&type=incoming&apiKey={Your_Dimension_API_Key}`
2. **Method**: POST
3. **Headers**:
   * `Content-Type`: `application/json`
4. **Body**: The body of the request should include the messages retrieved from Avaya Cloud, formatted according to Dimension's requirements. You'll likely need to transform the Avaya Cloud message format to match what Dimension expects.

### Example Request to Dimension

```python
dimensionlabs_url = "https://tracker.dimensionlabs.io/track"
params = {
    "platform": "universal",
    "v": "11.1.0-rest",
    "type": "incoming",
    "apiKey": "{Your_Dimension_API_Key}"
}
# Example payload - transform this based on the actual message format and Dimension requirements
payload = {
    "text": "Hello from Avaya Cloud!",
    "userId": "user123"
}

response = requests.post(dimensionlabs_url, params=params, json=payload)
print(response.status_code)

```

### **Example JSON Payload to Dimension**

When you have extracted the data from Avaya, here is how you might format the JSON payload for Dimension:

```json
{
  "text": "Hello, how can I assist you today?",
  "userId": "user123456"
}
```