# PEOPL APIs

This documentation provides an overview of the system's APIs and its architecture. It explains how each component interacts to deliver core functionalities.


---

## Restart Server (USE WITH CAUTION)

#### Remove Scheduled Messages
1. Log in to [MongoDB](https://account.mongodb.com/account/login) with contacto account.
2. Find cluster0 and collections tab
3. Select the collection of your server (peopl, peopl_sales, peopl_assitant).
4. Delete the table scheduledMessages in the selected collection.

#### Deploy the server
1. Log in to [Heroku](https://id.heroku.com/login) with contacto account.
2. Find the application of your server (peopl, peopl_sales, peopl_assitant).
3. Go to the deploy tab.
4. Find manual deploy and execute the deploy in the default branch.

---

## Base URLs

- **PEOPL API:** `https://peopl-660c92ba0c89.herokuapp.com`
- **PEOPL Sales API:** `https://peopl-sales-7c6128fcf4b5.herokuapp.com`
- **PEOPL Assistant API:** `https://peopl-assistant-5c83f6850119.herokuapp.com`
- **URUS API:** `https://urus.peopl.health`
- **SIENNA API:** `https://sienna.peopl.health`

---

## Message Management

### Send Messages

URL = "{Base URL}/send-message"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      'code': [CODE],
      'message': [MESSAGE],
      (optional) 'hidePreview': true | false, # the default is false
      (optional) 'fileType': "document" | "image",
      (optional) 'fileUrl': [URL],
      (optional) 'sendTime': [TIME], # e.g. "2024-09-06 15:05"
      (optional) 'timeZone': [TIMEZONE], 
      # e.g. "America/Lima", "America/Mexico_City"
      (optional) 'delayed': false # e.g.true | false, default. false
    })
}

##### How to get an API KEY?
Ask the owner of the service to give a key

##### Which is my code?
It depends:

- To send a message to an specific number:

    CODE = "[country code][phone number]@s.whatsapp.net"
    Example = "[e-mail]"

- To send a message to a group look into Group table inside General base (Airtable):

    CODE = "[group_id]"
    Example = "[e-mail]

##### What kinf of text can go inside the message?
Anything that can be written with ascii, including special characters and emojis.

##### Can I send media?
Only images (png) and documents (pdf)

##### Which is the format for timezones?
Only [IANA - TZ identifier](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) format is accepted.

---

### Send Bulk Messages

#### Option 1: Send a generic message to a set of codes (individual/group)

URL = "{Base URL}/send-bulk-message"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      'codes': [CODE1, CODE2, ...],
      'message': [MESSAGE],
      (optional) 'hidePreview': true | false, # the default is false
      (optional) 'fileType': "document" | "image",
      (optional) 'fileUrl': [URL],
      (optional) 'sendTime': [TIME], # e.g. "2024-09-06 15:05"
      (optional) 'timeZone': [TIMEZONE], # e.g. "America/Lima"
      (optional) 'delayed': false # e.g.true | false, default. false
    })
}

#### Option 2: Send a custom message to a set of individuals based on information in Airtable

URL = "{Base URL}/send-bulk-message-airtable"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      'message': [MESSAGE],
      (optional) 'hidePreview': true | false, # the default is false
      (optional) 'fileType': "document" | "image",
      (optional) 'fileUrl': [URL],
      'baseId': [BASEID],
      'tableName': [TABLENAME],
      'columnPhone': [COLUMNPHONE],
      (optional) 'condition': [CONDITION],
      (optional) 'sendTime': [TIME], # e.g. "2024-09-06 15:05"
      (optional) 'timeZone': [TIMEZONE], # e.g. "America/Lima"
      (optional) 'delayed': false # e.g.true | false, default. false
    })
}

---

## Poll Management

### Create Polls

URL = "{Base URL}/create-poll"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      'code': [CODE], # e.g. "[e-mail]"
      'question': [QUESTION], # e.g. "Que opción eliges?"
      'options': [OPTION1, OPTION2, ...], # e.g. ["A", "B", "C"]
      'multipleAnswers': true | false
    })
}

---

## Group Management

### Create Groups

URL = "{Base URL}/create-group"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      "name": [NAME],
      "description": [DESCRIPTION] (can be empty),
      "message": [MESSAGE] (optional),
      "admins": [CODE1, CODE2, ...],
      "members": [CODE1, CODE2, ...]
    })
}

### Get Group Members

URL = "{Base URL}/get-group-members"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      "groupIds": [GROUP_ID_1, GROUP_ID_2, ...]
    })
}

### Remove Group Members

URL = "{Base URL}/remove-members"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      "groupId": [GROUP_ID], # e.g. "[e-mail]"
      "codes": [CODE1, CODE2, ...], # e.g. [[e-mail]", ...]
    })
}

---

## Calendar Management

### Delete Calendar Event [USE WITH CAUTION]

URL = "{Base URL}/delete-event"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      "eventId": [EVENTID] # e.g. "14msi6l3hpsvmkv97gde0fgr97"
      "userEmail": [USEREMAIL] # e.g. "[e-mail]"
    })
}

---

# PEOPL Sales

## Messages

### Get Last Interaction

URL = "{Base URL}/get-last-interaction"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      "code": CODE, # e.g. "[e-mail]"
    })
}

## Groups

### Verify code

URL = "{Base URL}/verify-code"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      "code": CODE, # e.g. "[e-mail]"
    })
}
RESPONSE = {
    status: true,
    response: "[e-mail]" # e.g. null
}

## Assistant Management

### Create Assistant

URL = "{Base URL}/create-assistant"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      "assistant_id": ASSISTANT_ID,
      "codes": [CODE1, CODE2, ...], # e.g. [[e-mail]", ...]
      "instrucciones": [INSTRUCTION1, INSTRUCTION2, ...], 
      "messages": [MESSAGE1, MESSAGE2, ...], 
    })
}

### Add a Message to an Assistant

URL = "{Base URL}/add-msg-assistant"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      "assistant_id": ASSISTANT_ID,
      "codes": [CODE1, CODE2, ...], # e.g. [[e-mail]", ...] 
      "messages": [MESSAGE1, MESSAGE2, ...], 
    })
}

### Change active status of an Assistant

URL = "{Base URL}/active-assistant"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      "assistant_id": ASSISTANT_ID,
      "code": CODE, # e.g. "[e-mail]"
      "active": false | true, 
    })
}

---

# PEOPL Assistant

## Assistant Management

### Send Assistant

URL = "{Base URL}/create-assistant"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      "codes": [CODE1, CODE2, ...] # e.g. ["[e-mail]"]
      "instrucciones": [INSTRUCTION1, INSTRUCTION2, ...], 
      "messages": [MESSAGE1, MESSAGE2, ...], 
    })
}

### Add a Message to an Assistant

URL = "{Base URL}/add-msg-assistant"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      "code": CODE, # e.g. "[e-mail]"
      "messages": [MESSAGE1, MESSAGE2, ...], 
      (optional) "reply": true | false, # the default is false
    })
}

### Add a Instruction to an Assistant

URL = "{Base URL}/add-instruction-assistant"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      "code": CODE, # e.g. "[e-mail]"
      "instruction": INSTRUCTION # "Envia un saludo al paciente"
    })
}

### Change active status of an Assistant

URL = "{Base URL}/active-assistant"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      "code": CODE, # e.g. "[e-mail]"
      "active": false | true, 
    })
}

### Change stop status of an Assistant

URL = "{Base URL}/stop-assistant"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      "code": CODE, # e.g. "[e-mail]"
      "stop": false | true, 
    })
}

### Switch an Assistant

URL = "{Base URL}/switch-assistant"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      "code": CODE, # e.g. "[e-mail]"
      "assistant_id": ASSISTANT_ID, 
    })
}

## Meeting bot (SIENNA)

### Record a video

URL = "{Base URL}/record-meeting"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      "eventId": EVENTID,
    })
}

### Process video from drive

URL = "{Base URL}/process-recording-calendar"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      "eventId": EVENTID,
    })
}

## LLMs processing (URUS)

### Process images

URL = "{Base URL}/process-analysis"
JSON = {
    method: "POST",
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': [API KEY]
      },
    body: JSON.stringify({
      "url": [URL], # e.g. public URL
      "table": [TABLE], # e.g. estudios
      "nameCol": [NAME], # e.g. name
      "dateCol": [DATE], # e.g. date
      "descripCol": [DESCRIPTION], # e.g. description
      "recordId": [RECORD_ID] # e.g. rech5ZbIOZl9IfT4Y
    })
}