### Start Agent Consult

Source: https://app.3c.plus/api/v1/swagger.json

Initiates a consultation with another agent. This feature is available only for users with 'agent' or 'manager' roles.

```APIDOC
## POST /agent/consult

### Description
Starts a consult with another agent. This endpoint is only available for users with the agent or manager roles.

### Method
POST

### Endpoint
/agent/consult

### Parameters
#### Request Body
- **consultedId** (integer) - Required - The consulted agent id.

### Response
#### Success Response (204)
- No Content

#### Error Response (400)
- **Error** - The agent or consulted is offline.
```

--------------------------------

### Start Consult for Receptive Queue

Source: https://app.3c.plus/api/v1/swagger.json

Initiates a consultation with a receptive queue. This feature is available only for users with 'agent' or 'manager' roles.

```APIDOC
## POST /agent/consult/queue

### Description
Starts a consult for a receptive queue. This endpoint is only available for users with the agent or manager roles.

### Method
POST

### Endpoint
/agent/consult/queue

### Parameters
#### Request Body
- **queueId** (integer) - Required - The receptive queue id.

### Response
#### Success Response (204)
- No Content

#### Error Response (400)
- **Error** - The agent is offline.
```

--------------------------------

### Start Transfer

Source: https://app.3c.plus/api/v1/swagger.json

Initiates a transfer of a consultation to another agent. This feature is available only for users with 'agent' or 'manager' roles.

```APIDOC
## POST /agent/consult/transfer

### Description
Starts a transfer. This endpoint is only available for users with the agent or manager roles.

### Method
POST

### Endpoint
/agent/consult/transfer

### Parameters
#### Request Body
- **consultedId** (integer) - Required - The consulted agent id.

### Response
#### Success Response (204)
- No Content

#### Error Response (400)
- **Error** - The agent is offline.
```

--------------------------------

### GET /receptive_queues/active

Source: https://app.3c.plus/api/v1/swagger.json

Lists active receptive queues.

```APIDOC
## GET /receptive_queues/active

### Description
Lists active receptive queues.

### Method
GET

### Endpoint
/receptive_queues/active

### Parameters
None

### Responses
#### Success Response (200)
- **receptiveQueues** (object) - All active receptive queues paginated

#### Error Response (default)
- **error** (object) - Unexpected error
```

--------------------------------

### Connect to Realtime Events with Socket.IO

Source: https://app.3c.plus/api/v1/swagger.json

Use a Socket.IO client to connect to the real-time events server. Ensure you have the 'socket.io-client' package installed.

```javascript
  const io = require('socket.io-client')
  const socket = io("{{ env('SOCKET_SERVER_ADDR') }}", { transports: ['websocket'], query: { token: "token-da-api" } })
```

--------------------------------

### Get Campaign Feedback Statistics CSV

Source: https://app.3c.plus/api/v1/swagger.json

Downloads feedback statistics for a given campaign as a CSV file. Requires start and end dates. Only available for users with the manager role.

```http
GET /feedbacks/{campaign-id}/total/csv?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD&manager_id=1
```

--------------------------------

### API Field Selection

Source: https://app.3c.plus/api/v1/swagger.json

Use the `fields` GET parameter to specify which fields to retrieve from a resource.

```http
?fields=id,name
```

--------------------------------

### Get Statistics by Agent (CSV)

Source: https://app.3c.plus/api/v1/swagger.json

Generates and provides statistics by agent in CSV format. Requires start and end dates, a campaign ID, and a webhook URL for notification. Only available for 'manager' role users.

```APIDOC
## GET /agents/statistics/by_agent/csv

### Description
Gets statistics by agent in CSV format. This endpoint is only available for users with the manager role.

### Method
GET

### Endpoint
/agents/statistics/by_agent/csv

### Parameters
#### Query Parameters
- **start_date** (string) - Required - Filter by start date.
- **end_date** (string) - Required - Filter by end date.
- **campaign_id** (string) - Required - Filter by campaign_id.
- **webhook_url** (string) - Required - A HTTP URL where we can send a POST request to notify about the completion of your report. The body of the request will contain a HTTPS url that you can use to download your report.

### Response
#### Success Response (204)
- A generated CSV is returned.
```

--------------------------------

### Start a manual call

Source: https://app.3c.plus/api/v1/swagger.json

Initiates a manual call. Requires a phone number and optionally accepts a schedule ID. Available to agents and managers.

```APIDOC
## POST /agent/manual_call/dial

### Description
Starts a manual call. This endpoint is restricted to users with agent or manager roles.

### Method
POST

### Endpoint
/agent/manual_call/dial

### Parameters
#### Form Data Parameters
- **phone** (integer) - Required - The phone number
- **shedule_id** (string) - Optional - The schedule id

### Responses
#### Success Response (200)
- **ManualCall** (object) - The created manual call details

#### Error Response (default)
Unexpected error
```

--------------------------------

### Example of a Single Mailing

Source: https://app.3c.plus/api/v1/swagger.json

This JSON object represents a single mailing with phone number, an optional identifier, and additional data.

```json
[{"phone": "2012345678", "identifier": "28394", "data": { "name": "John Doe", "address": "xxx" } }]
```

--------------------------------

### Get Total Receptive Metrics

Source: https://app.3c.plus/api/v1/swagger.json

Retrieves all receptive metrics for the company. This operation is only available for users with the manager role.

```APIDOC
## GET /total_receptive_metrics

### Description
Retrieves all receptive metrics for the company. Only available for users with the manager role.

### Method
GET

### Endpoint
/total_receptive_metrics

### Parameters
None

### Response
#### Success Response (200)
- **TotalReceptiveMetricList** (object) - A list of metrics for all receptive queues.

#### Response Example
{
  "total_calls_received": 1000,
  "total_calls_answered": 800
}
```

--------------------------------

### Start a manual call in ACW

Source: https://app.3c.plus/api/v1/swagger.json

Initiates a manual call while in ACW mode. Requires a phone number. Accessible by agents and managers.

```APIDOC
## POST /agent/manual_call_acw/dial

### Description
Starts a manual call in ACW mode. This endpoint is restricted to users with agent or manager roles.

### Method
POST

### Endpoint
/agent/manual_call_acw/dial

### Parameters
#### Form Data Parameters
- **phone** (integer) - Required - The phone number

### Responses
#### Success Response (200)
- **ManualCall** (object) - The created manual call details

#### Error Response (default)
Unexpected error
```

--------------------------------

### GET /calls/{call-id}/recording_consult

Source: https://app.3c.plus/api/v1/swagger.json

Downloads the consult recording for a given call ID. This is applicable if the call involved a transfer.

```APIDOC
## GET /calls/{call-id}/recording_consult

### Description
Downloads the consult recording for the specified call ID. This endpoint is applicable if the call involved a transfer.

### Method
GET

### Endpoint
/calls/{call-id}/recording_consult

### Parameters
#### Path Parameters
- **call-id** (string) - Required - The ID of the call.

### Responses
#### Success Response (200)
- **recording file** - The recording file, if the call is a transfer.
  - **Content-type** (string) - audio/mpeg, audio/wave, or audio/gsm
  - **Content-Disposition** (string) - attachment; filename=filename.mp3

#### Error Response (default)
- **code** (integer) - Error code.
- **message** (string) - Error message.
```

--------------------------------

### GET /records/{year}/{month}/{day}

Source: https://app.3c.plus/api/v1/swagger.json

Downloads a zip archive containing all call recordings for a specified date. Note: Downloading large date ranges (e.g., months or years) may result in network interruptions.

```APIDOC
## GET /records/{year}/{month}/{day}

### Description
Downloads a zip archive containing all call recordings for the specified date. Please be aware that downloading large timestamps, such as entire months or years, may lead to network interruptions.

### Method
GET

### Endpoint
/records/{year}/{month}/{day}

### Parameters
#### Path Parameters
- **year** (string) - Required - The four-digit year (e.g., 2019).
- **month** (string) - Required - The two-digit month (e.g., 09).
- **day** (string) - Optional - The two-digit day (e.g., 05).

### Responses
#### Success Response (200)
- **zip archive** - A zip archive containing all call recordings for the specified date.

#### Error Response (default)
- **code** (integer) - Error code.
- **message** (string) - Error message.
```

--------------------------------

### Get Receptive Metrics by Queue

Source: https://app.3c.plus/api/v1/swagger.json

Retrieves receptive metrics, grouped by queue. This operation is only available for users with the manager role.

```APIDOC
## GET /receptive_metrics

### Description
Retrieves receptive metrics, grouped by queue. Only available for users with the manager role.

### Method
GET

### Endpoint
/receptive_metrics

### Parameters
None

### Response
#### Success Response (200)
- **ReceptiveMetricList** (object) - A list of metrics for receptive queues.

#### Response Example
{
  "metrics": [
    {
      "queue": "queue1",
      "calls_received": 100,
      "calls_answered": 80
    }
  ]
}
```

--------------------------------

### Start spying an agent in call

Source: https://app.3c.plus/api/v1/swagger.json

Initiates spying on an agent who is currently in a call. This operation is available for users with both manager and agent roles.

```APIDOC
## POST /spy/{agent-id}/start

### Description
Initiates spying on an agent who is currently in a call. This operation is available for users with both manager and agent roles.

### Method
POST

### Endpoint
/spy/{agent-id}/start

### Parameters
#### Path Parameters
- **agent-id** (string) - Required - The agent to spy on

### Responses
#### Success Response (204)
No Content

#### Error Response (404)
The agent is not logged in

#### Error Response (409)
The user is already spying another agent

#### Error Response (default)
Unexpected error
```

--------------------------------

### GET /receptive_queues

Source: https://app.3c.plus/api/v1/swagger.json

Lists receptive queues that belong to the company of the authenticated user. This endpoint is only available for users with the manager role.

```APIDOC
## GET /receptive_queues

### Description
Lists receptive queues that belongs to the company of the authenticated user.

### Method
GET

### Endpoint
/receptive_queues

### Parameters
None

### Responses
#### Success Response (200)
- **receptiveQueues** (object) - All receptive queues paginated

#### Error Response (default)
- **error** (object) - Unexpected error
```

--------------------------------

### GET /calls/{call-id}/recording_amd

Source: https://app.3c.plus/api/v1/swagger.json

Downloads the AMD (Answering Machine Detection) recording for a given call ID. An optional query parameter can be used to retrieve the original recording without conversion.

```APIDOC
## GET /calls/{call-id}/recording_amd

### Description
Downloads the AMD (Answering Machine Detection) recording for the specified call ID. An optional query parameter `original` can be used to retrieve the original recording without conversion.

### Method
GET

### Endpoint
/calls/{call-id}/recording_amd

### Parameters
#### Path Parameters
- **call-id** (string) - Required - The ID of the call.

#### Query Parameters
- **original** (boolean) - Optional - If true, returns the original recording without conversion.

### Responses
#### Success Response (200)
- **recording file** - The recording file.
  - **Content-type** (string) - audio/mpeg, audio/wave, or audio/gsm
  - **Content-Disposition** (string) - attachment; filename=filename.ext

#### Error Response (default)
- **code** (integer) - Error code.
- **message** (string) - Error message.
```

--------------------------------

### GET /receptive_number_settings

Source: https://app.3c.plus/api/v1/swagger.json

Lists receptive settings that belong to the company of the authenticated user. This endpoint is only available for users with the manager role.

```APIDOC
## GET /receptive_number_settings

### Description
Lists receptive Settings that belongs to the company of the authenticated user.

### Method
GET

### Endpoint
/receptive_number_settings

### Parameters
None

### Responses
#### Success Response (200)
- **receptiveNumberSettings** (object) - All receptive Settings paginated

#### Error Response (default)
- **error** (object) - Unexpected error
```

--------------------------------

### Example of a Mailing to Delete

Source: https://app.3c.plus/api/v1/swagger.json

This JSON object represents a mailing to be deleted from a campaign, including phone number and an optional identifier.

```json
{"phone": "2012345678", "identifier": "28394" }
```

--------------------------------

### API Field Selection with Relations

Source: https://app.3c.plus/api/v1/swagger.json

Filter fields from related resources by using dot notation in the `fields` GET parameter.

```http
?fields=id,some_relation.relation_field_one
```

--------------------------------

### GET /calls/{call-id}/recording

Source: https://app.3c.plus/api/v1/swagger.json

Downloads the recording for a given call ID. An optional query parameter can be used to retrieve the original recording without conversion.

```APIDOC
## GET /calls/{call-id}/recording

### Description
Downloads the recording for the specified call ID. An optional query parameter `original` can be used to retrieve the original recording without conversion.

### Method
GET

### Endpoint
/calls/{call-id}/recording

### Parameters
#### Path Parameters
- **call-id** (string) - Required - The ID of the call.

#### Query Parameters
- **original** (boolean) - Optional - If true, returns the original recording without conversion.

### Responses
#### Success Response (200)
- **recording file** - The recording file.
  - **Content-type** (string) - audio/mpeg, audio/wave, or audio/gsm
  - **Content-Disposition** (string) - attachment; filename=filename.ext

#### Error Response (default)
- **code** (integer) - Error code.
- **message** (string) - Error message.
```

--------------------------------

### Get Statistics by Agent

Source: https://app.3c.plus/api/v1/swagger.json

Retrieves statistics aggregated by agent. Requires start and end dates, and a campaign ID. This endpoint is restricted to 'manager' role users.

```APIDOC
## GET /agents/statistics/by_agent

### Description
Gets statistics by agent. This endpoint is only available for users with the manager role.

### Method
GET

### Endpoint
/agents/statistics/by_agent

### Parameters
#### Query Parameters
- **start_date** (string) - Required - Filter by start date.
- **end_date** (string) - Required - Filter by end date.
- **campaign_id** (string) - Required - Filter by campaign_id.

### Response
#### Success Response (200)
- **schema** - A list of all statistics by agent, defined by '#/definitions/AgentStatisticsByAgentList'.

#### Response Example
(Response structure defined by '#/definitions/AgentStatisticsByAgentList')
```

--------------------------------

### Get Campaign Feedback Statistics

Source: https://app.3c.plus/api/v1/swagger.json

Retrieves statistical feedback data for a campaign. Requires start and end dates for filtering. This endpoint is only available for users with the manager role.

```APIDOC
## GET /feedbacks/{campaign-id}/total

### Description
Retrieves statistical feedback data for a campaign. Requires start and end dates for filtering. This endpoint is only available for users with the manager role. The response includes statistics based on agents, with each object detailing agent ID, name, criterion feedback, and total feedbacks.

### Method
GET

### Endpoint
/feedbacks/{campaign-id}/total

### Parameters
#### Path Parameters
- **campaign-id** (string) - Required - The Campaign ID.

#### Query Parameters
- **start_date** (string) - Required - The start date to filter in Y-m-d format.
- **end_date** (string) - Required - The end date to filter in Y-m-d format.
- **manager_id** (integer) - Optional - The manager ID to filter.

### Response
#### Success Response (200)
- **Feedback** - The feedback statistics for the Campaign.
(Schema reference: #/definitions/Feedback)

#### Error Response (default)
- **Error** - Unexpected error.
(Schema reference: #/definitions/Error)
```

--------------------------------

### Export Campaign Feedback Statistics to CSV

Source: https://app.3c.plus/api/v1/swagger.json

Exports feedback statistics for a given campaign to a CSV file. This endpoint requires start and end dates to be provided in the query string and is accessible only to users with the manager role.

```APIDOC
## GET /feedbacks/{campaign-id}/total/csv

### Description
Retrieves the statistics for a campaign and exports them as a CSV file. The start_date and end_date must be provided in the query string. This endpoint is only available for users with the manager role.

### Method
GET

### Endpoint
/feedbacks/{campaign-id}/total/csv

### Parameters
#### Path Parameters
- **campaign-id** (string) - Required - The current Campaign of the Agent

#### Query Parameters
- **start_date** (string) - Required - The start date to filter in Y-m-d format
- **end_date** (string) - Required - The end date to filter in Y-m-d format
- **manager_id** (integer) - Optional - The manager id to filter

### Response
#### Success Response (200)
- **No Content**
```

--------------------------------

### Application version

Source: https://app.3c.plus/api/v1/swagger.json

Returns information about the current application version.

```APIDOC
## GET /version

### Description
Returns information about the current application version.

### Method
GET

### Endpoint
/version

### Parameters

### Request Example

### Response
#### Success Response (200)
- **The app version** (object) - Description

#### Response Example

```

--------------------------------

### List IVR After Call Options

Source: https://app.3c.plus/api/v1/swagger.json

Lists all available IVR after-call options with pagination. Only available for users with the manager role.

```http
GET /ivr_after_call
```

--------------------------------

### Get Qualification Statistics

Source: https://app.3c.plus/api/v1/swagger.json

Retrieves qualification statistics. Requires start and end dates, with optional filters for campaign and agent IDs. This endpoint is restricted to 'manager' role users.

```APIDOC
## GET /qualification/statistics

### Description
Gets qualification statistics. This endpoint is only available for users with the manager role.

### Method
GET

### Endpoint
/qualification/statistics

### Parameters
#### Query Parameters
- **start_date** (string) - Required - Filter by start date (format Y-m-d).
- **end_date** (string) - Required - Filter by end date (format Y-m-d).
- **campaign_id** (string) - Optional - Filter by campaign_id.
- **agent_id** (string) - Optional - Filter by agent_id.

### Response
#### Success Response (200)
- **schema** - A list of all statistics, defined by '#/definitions/QualificationStatistics'.

#### Response Example
(Response structure defined by '#/definitions/QualificationStatistics')
```

--------------------------------

### List All Routes

Source: https://app.3c.plus/api/v1/swagger.json

Lists all routes belonging to the authenticated user's company. This operation is only available for users with the manager role.

```APIDOC
## GET /routes

### Description
Lists all routes belonging to the authenticated user's company. Only available for users with the manager role.

### Method
GET

### Endpoint
/routes

### Parameters
None

### Response
#### Success Response (200)
- **Routes** (object) - The routes available for the company.

#### Response Example
{
  "routes": [
    {
      "id": "route1",
      "name": "Main Route"
    }
  ]
}
```

--------------------------------

### Get Agent Statistics

Source: https://app.3c.plus/api/v1/swagger.json

Retrieves connected calls statistics for agents. Requires start and end dates, with optional filters for campaign and agent IDs. Only available for 'manager' role users.

```APIDOC
## GET /agent/statistics

### Description
Gets connected calls statistics. This endpoint is only available for users with the manager role.

### Method
GET

### Endpoint
/agent/statistics

### Parameters
#### Query Parameters
- **start_date** (string) - Required - Filter by start date (format Y-m-d).
- **end_date** (string) - Required - Filter by end date (format Y-m-d).
- **campaign_id** (string) - Optional - Filter by campaign_id.
- **agent_id** (string) - Optional - Filter by agent_id.

### Response
#### Success Response (200)
- **schema** - A list of all statistics, defined by '#/definitions/AgentStatistics'.

#### Response Example
(Response structure defined by '#/definitions/AgentStatistics')
```

--------------------------------

### GET /campaigns/{campaign-id}/agents/qualifications/csv

Source: https://app.3c.plus/api/v1/swagger.json

Generates a CSV report of qualification counts per agent within a specified time interval. This endpoint is restricted to users with the manager role.

```APIDOC
## GET /campaigns/{campaign-id}/agents/qualifications/csv

### Description
Generate a csv with the qualifications count per agent during the specified time interval.
Only available for users with the manager role.

### Method
GET

### Endpoint
/campaigns/{campaign-id}/agents/qualifications/csv

### Parameters
#### Path Parameters
- **campaign-id** (string) - Required - The campaign id

#### Query Parameters
- **startDate** (string) - Required - Start date
- **endDate** (string) - Required - End date
- **webhook_url** (string) - Required - A HTTP URL where we can send a POST request to notify about the completion of your report.

#### Response
#### Success Response (204)
- A generated CSV

#### Error Response (default)
- **Error** (schema) - Unexpected error
```

--------------------------------

### Get Agent Feedback Statistics for Campaign

Source: https://app.3c.plus/api/v1/swagger.json

Retrieves statistical feedback data for an agent within a campaign. Requires start and end dates for filtering. Available to users with agent or manager roles.

```APIDOC
## GET /feedbacks/{campaign-id}/agent/stats

### Description
Retrieves statistical feedback data for an agent within a campaign. Requires start and end dates for filtering. This endpoint is available to users with the agent or manager role.

### Method
GET

### Endpoint
/feedbacks/{campaign-id}/agent/stats

### Parameters
#### Path Parameters
- **campaign-id** (string) - Required - The current Campaign of the Agent.

#### Query Parameters
- **start_date** (string) - Required - The start date to filter in Y-m-d format.
- **end_date** (string) - Required - The end date to filter in Y-m-d format.
- **manager_id** (integer) - Optional - The manager ID to filter.

### Response
#### Success Response (200)
- **Feedback Statistics** - The feedback statistics for the Agent and Campaign.

#### Error Response (default)
- **Error** - Unexpected error.
(Schema reference: #/definitions/Error)
```

--------------------------------

### Create IVR After Call

Source: https://app.3c.plus/api/v1/swagger.json

Creates a new IVR after-call configuration. Requires uploading audio files for different stages and setting timing parameters. Only available for users with the manager role.

```http
POST /ivr_after_call
Content-Type: multipart/form-data

name=My IVR
audio_start=@start.mp3
audio_null_key=@null_key.mp3
audio_invalid_key=@invalid_key.mp3
audio_end=@end.mp3
max_wait_time=5
attempt_number=3
```

--------------------------------

### Create Campaign

Source: https://app.3c.plus/api/v1/swagger.json

Creates a new campaign with specified details. This endpoint is available for users with the manager role.

```APIDOC
## POST /campaigns

### Description
Creates a new campaign.

### Method
POST

### Endpoint
/campaigns

### Parameters
#### Form Data Parameters
- **name** (string) - Required - The campaign's name
- **extension_number** (integer) - Required - The campaign's extension number
- **start_time** (string) - Required - The time for the start of the campaign. Must be in 09:00 format
- **end_time** (string) - Required - The time for the end of the campaign. Must be in 09:00 format
- **qualification_list** (string) - Required - The qualification id list
- **caller_id** (string) - Optional - The campaign's caller id
- **route_landline_id** (string) - Optional - The Route landline id
- **route_mobile_id** (string) - Optional - The Route mobile id
- **check_amd** (boolean) - Optional - True to enable the amd, false disable
- **copy_identifier** (boolean) - Optional - If true, copy the identifier of the connected call
- **active_list_notify** (boolean) - Optional - True to enable the completed list nofication, false disable
- **limit_call_per_agent** (integer) - Optional - The call limit per agent
- **limit_call_time** (integer) - Optional - The limit call time
- **work_break_group_id** (string) - Optional - The work_break_group_id id list
- **ivr_after_call_id** (string) - Optional - The ivr_after_call_id id list
- **recalls** (integer) - Optional - The amount recalls, Within 1 to 10
- **call_time** (integer) - Optional - The call time (seconds), Within 20 to 50 seconds
- **wait_time** (integer) - Optional - The wait time (seconds) Within 3 to 20 seconds
- **ura_limit** (integer) - Optional - The number of channels that ivr should dial

### Response
#### Success Response (200)
- **Campaign** - The created campaign

#### Response Example
(Schema reference: #/definitions/Campaign)
```

--------------------------------

### Initiate Click to Call

Source: https://app.3c.plus/api/v1/swagger.json

Initiates a manual call to a specified phone number from an agent's extension. This feature is only available for users with the 'manager' role.

```APIDOC
## POST /click2call

### Description
Starts a manual call if the agent is idle. This endpoint is only available for users with the manager role.

### Method
POST

### Endpoint
/click2call

### Parameters
#### Request Body
- **extension** (integer) - Required - The agent extension.
- **phone** (integer) - Required - The phone number.

### Response
#### Success Response (200)
- **ManualCall** - The created manual call

#### Error Response (422)
- **Error** - The agent is not idle.
```

--------------------------------

### Get Authenticated User

Source: https://app.3c.plus/api/v1/swagger.json

Retrieves the profile information of the currently authenticated user.

```APIDOC
## GET /me

### Description
Returns the profile of the authenticated user.

### Method
GET

### Endpoint
/me

### Parameters
None

### Responses
#### Success Response (200)
- **user** (User) - The profile object of the authenticated user.

#### Response Example
{
  "example": "{\"id\": \"user123\", \"name\": \"John Doe\", \"email\": \"john.doe@example.com\", \"extension_number\": 101, \"timezone\": \"America/New_York\"}"
}

#### Error Response (default)
- **error** (Error) - An error object detailing the problem.

```

--------------------------------

### Get Campaign

Source: https://app.3c.plus/api/v1/swagger.json

Retrieves a specific campaign by its ID. This endpoint is available for users with the manager role.

```APIDOC
## GET /campaigns/{campaign-id}

### Description
Get a campaign.

### Method
GET

### Endpoint
/campaigns/{campaign-id}

### Parameters
#### Path Parameters
- **campaign-id** (string) - Required - The campaign id

### Response
#### Success Response (200)
- **Campaign** - The campaign

#### Response Example
(Schema reference: #/definitions/Campaign)
```

--------------------------------

### Get agent campaigns

Source: https://app.3c.plus/api/v1/swagger.json

Retrieves a list of campaigns that the agent belongs to. This endpoint is available to agents.

```APIDOC
## GET /agent/campaigns

### Description
Gets the campaigns the agent belongs to. By default, this endpoint lists all campaigns.

### Method
GET

### Endpoint
/agent/campaigns

### Parameters
None

### Responses
#### Success Response (200)
(Response details not fully specified in source)

#### Error Response (default)
Unexpected error
```

--------------------------------

### Create Qualification List

Source: https://app.3c.plus/api/v1/swagger.json

Creates a new qualification list within the authenticated user's company. This operation requires the manager role.

```APIDOC
## POST /qualification_lists

### Description
Creates a new qualification list in the user's company. This operation is only available for users with the manager role.

### Method
POST

### Endpoint
/qualification_lists

### Parameters
#### Form Data Parameters
- **name** (string) - Required - The qualification list's name

### Responses
#### Success Response (200)
- **qualificationList** (QualificationList) - The created qualification list.

#### Response Example
{
  "id": "string",
  "name": "string",
  "company_id": "string"
}
```

--------------------------------

### Create Campaign

Source: https://app.3c.plus/api/v1/swagger.json

Creates a new campaign. Only available for users with the manager role.

```APIDOC
## POST /campaigns

### Description
Create a new campaign. Only available for users with the manager role.

### Method
POST

### Endpoint
/campaigns

### Parameters
#### Request Body
- **name** (string) - Required - The campaign's name.
- **extension_number** (integer) - Required - The campaign's extension number.
- **start_time** (string) - Required - The time for the start of the campaign. Must be in 09:00 format.
- **qualification_list** (string) - Required - The qualification id list.
- **end_time** (string) - Required - The time for the end of the campaign. Must be in 09:00 format.
- **allows_manual** (boolean) - Optional - True to enable the manual calls, false disable.
- **url** (string) - Optional - A valid url for the campaign.
- **acw_timeout** (string) - Optional - The ACW timeout before auto qualification.
```

--------------------------------

### Get URA by ID

Source: https://app.3c.plus/api/v1/swagger.json

Retrieves a specific URA by its ID. This endpoint is only available to users with the manager role.

```APIDOC
## GET /uras/{ura-id}

### Description
Gets the URA for a given ID. This endpoint is only available for users with the manager role.

### Method
GET

### Endpoint
/uras/{ura-id}

### Parameters
#### Path Parameters
- **ura-id** (string) - Required - The ura ID

### Request Example

### Response
#### Success Response (200)
- **Ura** (object) - The URA for the given ID.

#### Response Example

```

--------------------------------

### Get Feedback by ID

Source: https://app.3c.plus/api/v1/swagger.json

Retrieves a specific feedback entry by its ID. Only available for users with the manager role.

```http
GET /feedbacks/{id}
```

--------------------------------

### Create Campaign

Source: https://app.3c.plus/api/v1/swagger.json

Creates a new campaign with specified parameters. This endpoint is available for users with the manager role.

```APIDOC
## POST /campaigns

### Description
Creates a new campaign.

### Method
POST

### Endpoint
/campaigns

### Parameters
#### Form Data Parameters
- **name** (string) - Optional - The campaign's name
- **start_time** (string) - Optional - The time for the start of the campaign. Must be in 09:00 format
- **end_time** (string) - Optional - The time for the end of the campaign. Must be in 09:00 format
- **allows_manual** (boolean) - Optional - True to enable the manual calls, false disable
- **acw_timeout** (integer) - Optional - The ACW timeout in seconds before auto qualification. The number 0 means unlimited.
- **caller_id** (string) - Optional - The campaign's caller id
- **route_landline_id** (string) - Optional - The Route landline id
- **route_mobile_id** (string) - Optional - The Route mobile id
- **check_amd** (boolean) - Optional - True to enable the amd, false disable
- **copy_identifier** (boolean) - Optional - If true, copy the identifier of the connected call
- **active_list_notify** (boolean) - Optional - True to enable the completed list nofication, false disable
- **limit_call_per_agent** (integer) - Optional - The call limit per agent
- **limit_call_time** (integer) - Optional - The limit call time
- **work_break_group_id** (string) - Optional - The work_break_group_id id list
- **recalls** (integer) - Optional - The amount recalls, Within 1 to 10
- **call_time** (integer) - Optional - The call time (seconds), Within 20 to 50 seconds
- **wait_time** (integer) - Optional - The wait time (seconds) Within 3 to 20 seconds
- **ura_limit** (integer) - Optional - The number of channels that ivr should dial

### Responses
#### Success Response (200)
- **Campaign** (object) - The campaign details

#### Error Response (default)
- **Error** (object) - Unexpected error
```

--------------------------------

### GET /campaigns/{campaign-id}/agents/qualifications

Source: https://app.3c.plus/api/v1/swagger.json

Filters agent qualifications statistics based on a specified date range.

```APIDOC
## GET /campaigns/{campaign-id}/agents/qualifications

### Description
Filter agent qualifications statistics.

### Method
GET

### Endpoint
/campaigns/{campaign-id}/agents/qualifications

### Parameters
#### Path Parameters
- **campaign-id** (string) - Required - The campaign id

#### Query Parameters
- **start_date** (string) - Optional - The start date to filter. Format: Y-m-d
- **end_date** (string) - Optional - The end date to filter. Format: Y-m-d

#### Response
#### Success Response (200)
- **TotalQualificationStats** (schema) - The filtered qualification stats

#### Error Response (default)
- **Error** (schema) - Unexpected error
```

--------------------------------

### Create a new user

Source: https://app.3c.plus/api/v1/swagger.json

Creates a new user in the system. This endpoint is only available for users with the manager role.

```APIDOC
## POST /users

### Description
Creates a new user in the system. This endpoint is only available for users with the manager role.

### Method
POST

### Endpoint
/users

### Parameters
#### Request Body
- **name** (string) - Required - The user's name
- **extension_number** (integer) - Required - The user's extension number
- **email** (string) - Optional - The user's email. This field is required if the role of the user is manager
- **password** (string) - Required - The user's password
- **web_extension** (string) - Optional - If provided the web extension will be set to true, otherwise false will be used.
- **role** (string) - Required - The user's role. Must be agent or manager
- **timezone** (string) - Required - The user's timezone. Example: America/Sao_Paulo
- **date_format** (string) - Optional - A date format to be used for dates. Example: d-m-Y, Y/m/d
Default to d/m/Y
- **hour_format** (string) - Optional - A format to be used for hours. Example: H:i, h:i, H:i:s
Default to H:i:s
- **user_document** (string) - Optional - The user's CPF. Send 11 digits only numbers

### Responses
#### Success Response (200)
- **User** (schema) - The created user

#### Error Response (default)
- **Error** (schema) - Unexpected error
```

--------------------------------

### Get Agent Campaigns

Source: https://app.3c.plus/api/v1/swagger.json

Retrieves a list of campaigns associated with an agent. This endpoint is available for users with the manager role.

```APIDOC
## GET /agents/{agentId}/campaigns

### Description
Retrieves a list of campaigns associated with a specific agent. This operation is restricted to users with the 'manager' role.

### Method
GET

### Endpoint
/agents/{agentId}/campaigns

### Parameters
#### Path Parameters
- **agentId** (integer) - Required - The ID of the agent whose campaigns are to be retrieved.

### Responses
#### Success Response (200)
- **AgentCampaigns** (array) - A list of agent campaigns.

#### Response Example
```json
[
  {
    "id": 1,
    "name": "Campaign Alpha",
    "paused": false
  }
]
```

#### Error Response (default)
- **Error** - An error object describing the issue.

#### Response Example
```json
{
  "code": "INTERNAL_ERROR",
  "message": "An internal error occurred."
}
```
```

--------------------------------

### List Receptive Queues with Agents

Source: https://app.3c.plus/api/v1/swagger.json

Lists receptive queues along with their associated agents that belong to the authenticated user's company. This endpoint is only available for users with the manager role.

```APIDOC
## GET /receptive_queues/agents

### Description
Lists receptive queues along with their associated agents that belong to the authenticated user's company.

### Method
GET

### Endpoint
/receptive_queues/agents

### Parameters

### Responses
#### Success Response (200)
- **ReceptiveQueues** (object) - A list of receptive queues with their agents.

#### Response Example
```json
{
  "example": "ReceptiveQueues schema"
}
```
```

--------------------------------

### List IVR After Call Configurations

Source: https://app.3c.plus/api/v1/swagger.json

Lists all configured IVR (Interactive Voice Response) after-call prompts with pagination. This endpoint is restricted to users with the manager role.

```APIDOC
## GET /ivr_after_call

### Description
Lists all IVR after call configurations with pagination. This endpoint is only available for users with the manager role.

### Method
GET

### Endpoint
/ivr_after_call

### Response
#### Success Response (200)
- **IvrAfterCall** (object) - A paginated list of IVR after call configurations. (Schema not detailed in source)
```

--------------------------------

### Get Agent Logged Campaign

Source: https://app.3c.plus/api/v1/swagger.json

Retrieves the campaign the agent is currently logged into. This is only available for users with the 'agent' role.

```APIDOC
## GET /agent/loggedCampaign

### Description
Gets the agent logged Campaign. This endpoint is only available for users with the agent role.

### Method
GET

### Endpoint
/agent/loggedCampaign

### Response
#### Success Response (200)
- **Campaign** - The campaign the agent is logged into.
```

--------------------------------

### List all users with pagination

Source: https://app.3c.plus/api/v1/swagger.json

Retrieves a paginated list of all users. This endpoint is only available for users with the manager role.

```APIDOC
## GET /users

### Description
Retrieves a paginated list of all users. This endpoint is only available for users with the manager role.

### Method
GET

### Endpoint
/users

### Parameters
#### Query Parameters
- **active** (string) - Optional - The user's 1 active, 0 inactive

### Responses
#### Success Response (200)
- **Users** (schema) - All users Paginated

#### Error Response (default)
- **Error** (schema) - Unexpected error
```

--------------------------------

### Get Agent Login History

Source: https://app.3c.plus/api/v1/swagger.json

Retrieves the login history for agents. This endpoint is intended for users with the 'manager' role.

```APIDOC
## GET /agents/login_history

### Description
Gets login history from agents. This endpoint is only available for users with the manager role.

### Method
GET

### Endpoint
/agents/login_history
```

--------------------------------

### Get Agent Campaigns

Source: https://app.3c.plus/api/v1/swagger.json

Retrieves a list of all campaigns the agent belongs to. Supports filtering by 'paused' or 'running' status.

```APIDOC
## GET /agent/campaigns

### Description
Retrieves a list of all campaigns the agent belongs to. You can filter the results by passing a parameter for 'paused' or 'running' campaigns.

### Method
GET

### Endpoint
/agent/campaigns

### Query Parameters
- **paused** (string) - Optional - If present, returns only paused campaigns.
- **running** (string) - Optional - If present, returns only running campaigns.

### Response
#### Success Response (200)
- **AgentCampaigns** (object) - A list of all campaigns the agent belongs to.

#### Error Response (default)
- **Error** (object) - Unexpected error.
```

--------------------------------

### Create a new callback

Source: https://app.3c.plus/api/v1/swagger.json

Creates a new callback entry for a given campaign. This operation is restricted to users with the manager role.

```APIDOC
## POST /campaigns/{campaign-id}/callbacks

### Description
Creates a new callback entry for a given campaign. This operation is restricted to users with the manager role.

### Method
POST

### Endpoint
/campaigns/{campaign-id}/callbacks

### Parameters
#### Path Parameters
- **campaign-id** (string) - Required - The campaign id

#### Request Body
- **did** (string) - Required - The did phone number.
```

--------------------------------

### Create IVR After Call Configuration

Source: https://app.3c.plus/api/v1/swagger.json

Creates a new IVR after-call configuration. This involves uploading audio files for different stages of the IVR flow and setting parameters like maximum wait time and attempt number. This endpoint is restricted to users with the manager role.

```APIDOC
## POST /ivr_after_call

### Description
Creates a new IVR after call configuration. This endpoint is only available for users with the manager role.

### Method
POST

### Endpoint
/ivr_after_call

### Parameters
#### Request Body
- **name** (string) - Required - The IVR after call name
- **audio_start** (file) - Required - The mp3 file with the audio for the start prompt
- **audio_null_key** (file) - Required - The mp3 file with the audio for the null key prompt
- **audio_invalid_key** (file) - Required - The mp3 file with the audio for the invalid key prompt
- **audio_end** (file) - Required - The mp3 file with the audio for the end prompt
- **max_wait_time** (integer) - Required - The maximum wait time in seconds for a key press
- **attempt_number** (integer) - Required - The number of attempts for the IVR
```

--------------------------------

### POST /receptive_queues

Source: https://app.3c.plus/api/v1/swagger.json

Creates a new receptive queue in the user's company. This endpoint is only available for users with the manager role.

```APIDOC
## POST /receptive_queues

### Description
Creates a new receptive queue in the user's company.

### Method
POST

### Endpoint
/receptive_queues

### Parameters
#### Form Data Parameters
- **name** (string) - Required - The receptive queue name
- **wait_time** (integer) - Required - The receptive queue wait time
- **acw_timeout** (integer) - Optional - The acw timeout from receptive queue
- **extension_number** (integer) - Required - The receptive queue extension number
- **qualification_list_id** (integer) - Required - The qualification id list
- **limit_call_time** (integer) - Optional - The limit call time
- **ivr_after_call_id** (integer) - Optional - The ivr after call id
- **agents[]** (array of integers) - Required - An array of agent ids
- **audio** (file) - Required - The mp3 file with the audio

### Responses
#### Success Response (200)
- **receptiveQueue** (object) - The created receptive queue

#### Error Response (default)
- **error** (object) - Unexpected error
```

--------------------------------

### List All Qualification Lists

Source: https://app.3c.plus/api/v1/swagger.json

Retrieves a paginated list of all qualification lists associated with the authenticated user's company. This endpoint is restricted to users with the manager role.

```APIDOC
## GET /qualification_lists

### Description
Lists all qualification lists that belong to the company of the authenticated user. This operation is only available for users with the manager role.

### Method
GET

### Endpoint
/qualification_lists

### Parameters

### Responses
#### Success Response (200)
- **qualificationLists** (QualificationLists) - All qualification lists paginated.

#### Response Example
{
  "qualificationLists": [
    {
      "id": "string",
      "name": "string",
      "company_id": "string"
    }
  ],
  "pagination": {
    "total": 0,
    "count": 0,
    "limit": 0,
    "offset": 0,
    "next": "string"
  }
}
```

--------------------------------

### Get the team for a given id

Source: https://app.3c.plus/api/v1/swagger.json

Retrieves the details of a specific team by its ID. This operation is only available for users with the manager role.

```APIDOC
## GET /teams/{team-id}

### Description
Retrieves the details of a specific team by its ID. This operation is only available for users with the manager role.

### Method
GET

### Endpoint
/teams/{team-id}

### Parameters
#### Path Parameters
- **team-id** (string) - Required - The user id

### Responses
#### Success Response (200)
The team for a given id

#### Error Response (default)
Unexpected error
```

--------------------------------

### SingleCampaignStatistics Object

Source: https://app.3c.plus/api/v1/swagger.json

Contains statistics for a single campaign snapshot.

```APIDOC
## SingleCampaignStatistics Object

### Description
Contains statistics for a single campaign snapshot, including the date and counts of various call outcomes.

### Properties

- **date** (string) - The timestamp of the statistics snapshot.
- **not_answered** (integer) - Amount of not answered calls.
- **answered** (integer) - Amount of answered calls.
- **abandoned** (integer) - Amount of abandoned calls.
- **abandoned_due_amd** (integer) - Amount of abandoned_due_amd calls.
- **failed** (integer) - Amount of failed calls.
```

--------------------------------

### Campaign Object

Source: https://app.3c.plus/api/v1/swagger.json

Represents a campaign with its configuration and status.

```APIDOC
## Campaign Object

### Description
Represents a campaign with its configuration and status, including ID, name, start/end times, pause status, caller ID, and more.

### Properties

- **id** (integer, int64) - The campaign id.
- **name** (string) - The campaign name.
- **start_time** (string) - The campaign start time.
- **end_time** (string) - The campaign end time.
- **paused** (boolean) - True if the campaign is paused, otherwise false.
- **acw_timeout** (integer, int64) - The campaign's acw timeout in seconds, 0 means no timeout.
- **limit_call_time** (integer, int64) - Limit call time.
- **is_on_active_time** (boolean) - True if the campaign is on its active time, otherwise false.
- **caller_id** (string) - The campaign caller id.
- **asr** (number, float) - The campaign asr.
- **amd_enabled** (boolean) - True if amd is enabled, false
```