Mixvoip logo
API docs by Redocly

Integration API Documentation (1.0.0)

Download OpenAPI specification:Download

URL: https://api.voxbi.com

This documentation aims to assist Mixvoip customers in configuring integrations. The integrations currently supported include api, crm-odoo and crm-zoho.

Users - API Integration

List API Integrations

Returns an array of API Integrations from a specific user.

Authorizations:
MixvoipBearerAuth
path Parameters
user_id
required
integer
Example: 1

The id of the user.

Responses

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

API Integration

Click-to-Dial

Click-to-Dial is a feature that allows users to initiate a phone call by clicking a link or button in a web application or software interface. It provides a convenient way to initiate calls without manual dialing.

Authorizations:
APIIntegrationBearerAuth
Request Body schema: application/json
from
required
string

The phone number, extension number, or email from which the call should be made.

to
required
string

The destination number of the call.

Responses

Request samples

Content type
application/json

Ensure to replace the from and to phone numbers with the appropriate values.

{
  • "from": "+352661223344",
  • "to": "+352661112233"
}

Click-to-Answer

Click-to-Answer is a feature that allows users to answer incoming calls by clicking a button or link in a web-based or software-based communication interface. It provides a streamlined call answering process and a convenient way for users to respond to incoming calls.

Authorizations:
APIIntegrationBearerAuth
Request Body schema: application/json
from
string

The phone number, extension number, or email address to which the call should be accepted.

Responses

Request samples

Content type
application/json
Example

Replace the from field with the phone number from which the call should be answered.

{
  • "from": "+352661223344"
}

Click-to-Hangup

Click-to-Hangup is a feature that allows users to end or terminate an ongoing call by clicking a button or link in a web-based or software-based communication interface. It provides a convenient and intuitive way for users to disconnect or end a call without requiring complex steps or manual actions.

Authorizations:
APIIntegrationBearerAuth
Request Body schema: application/json
from
required
string

The phone number, extension number, or email address from which the call should be ended.

Responses

Request samples

Content type
application/json
Example

Replace the from field with the phone number from which the call should be ended.

{
  • "from": "+352661223344"
}

CDRs

Calls History

This endpoint makes an HTTP GET request to retrieve call detail records (CDRs) for a specific extension and start time. The start_time parameter specifies the date and time from which the CDRs should be retrieved, and the extension parameter specifies the extension for which the CDRs are requested.

Request Parameters

  • start_time (string): The date and time from which the CDRs should be retrieved.
  • extension (string): The specific extension for which the CDRs are requested.

Extra FIlters

call_type => 'incoming', 'outgoing', 'internal'
extension_id => Unique ID for extsnion registered in PBX
start_time => Its like dateTime string "2023-12-04 00:04:16" you can use it to tell the system give me records from this date and time to onward
end_time => Same like start time pass the dateTime string to tell system give me results equal or before this dateTime.
extension => its the number of extension for whome you need data
date => fetch data for specific date only

Response

The response to this request will contain the call detail records (CDRs) based on the specified parameters.

Pagination

Refer to example response to see how the pagination works in order to get results for specific page.

Use query param => page={page_number}

Default page size is 100 entries per page

Authorizations:
None
path Parameters
CDRS_API_VERSION
required
string
query Parameters
start_time
string
Example: start_time=2023-12-18 00:04:16
extension
integer
Example: extension=2039

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "data": [
    ],
  • "pagination": {}
}