Skip to content

Developer Tools (1.0.0)

APIs for partners building integrations with the Altegio platform. Base URL: https://api.alteg.io/api

Available Methods

Marketplace — Manage your marketplace applications: list connected locations, configure tariffs, handle billing, process installation/uninstallation callbacks. Webhooks — Configure event notifications for your integrations. Receive real-time updates when appointments, clients, or other entities change. VoIP Integration — Connect telephony systems to match incoming calls with client records and log call history. Dictionaries — Reference data for building forms and validations: countries, cities, business types.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Altegio API Agreement
Terms of Service
Languages
Servers
Mock server
https://developer.alteg.io/_mock/en/developers/openapi/
Production
https://api.alteg.io/api/v1/

Marketplace

Marketplace application management, billing, and installation.

Operations

Webhooks

Event subscription and webhook configuration.

Operations

VoIP Integration

Telephony integration endpoints.

Operations

VoIP events

Request

Enable integration

To use the api and activate access to the settings in the user interface, you need to activate the integration by sending the "Enable integration" request. After a successful connection, access to the section with routing settings will be opened in the chain user interface.

Disable integration

To disable the integration, you can use the "Disable integration" method. After the integration is disabled, access to the user interface settings section is closed, the requests "Call notification" and "Call information saving" are not processed.

Call notification

To display notifications about an incoming call, the "Call notification" method is used, the call type ("incoming", "outgoing", "internal") is specified in the parameters, but currently notifications are displayed only for the "incoming" value. Notifications are displayed for users defined based on routing settings. When specifying the "user" and "diversion" parameters at the same time, "user" is the priority when searching for routes.

Saving call information

The information about the call is automatically saved to the chain history and to the history of chain locations in accordance with the call routing settings.

Security
BearerPartner
Headers
Acceptstringrequired

e.g. application/vnd.api.v2+json

Example: application/vnd.api.v2+json
Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token

Bodyapplication/jsonrequired

Request bodies

Any of:

Connect integration

commandstringrequired

Operation type: 'setup'

Example: "setup"
crm_tokenstringrequired

CRM-token from the VoIP Integration in the client's chain section

Example: "7cf262d6-1656-43f9-86ac-2826bdc125d2"
typestringrequired

Operation type, in this case 'enable'

Example: "enable"
curl -i -X POST \
  https://developer.alteg.io/_mock/en/developers/openapi/voip/integration \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "command": "setup",
    "type": "enable",
    "crm_token": "7cf262d6-1656-43f9-86ac-2826bdc125d2"
  }'

Responses

Accepted

Bodyapplication/json
successboolean

Success status (true)

Example: true
datastring

Contains null

metaobject

Metadata (contain an "Accepted" message)

Example: {"message":"Accepted"}
Response
application/json
{
  "success": true,
  "meta": {
    "message": "Accepted"
  }
}

Get Location's Call List

Request

This endpoint is designed to get a list of calls in a location, taking into account filters and pagination

Security
BearerPartnerUser
Headers
Acceptstringrequired

e.g. application/vnd.api.v2+json

Example: application/vnd.api.v2+json
Bodyapplication/json
salon_idnumberrequired

Location ID.

Example: 615243
date_fromstringrequired

Start date.

Example: "2026-01-01"
date_tostringrequired

End date.

Example: "2026-02-01"
phonestring

Phone number.

Example: "+13155550175"
typesArray of strings

Call types list

Items Enum"incoming""outgoing""internal"
Example: ["incoming","internal"]
statusesArray of strings

Call statuses list

Items Enum"success""missed""cancel""busy""notallowed""notavailable""notfound"
Example: ["success","cancel"]
pagenumber

Page number

Example: 1
limitnumber<= 1000

Amount of elements on page

Example: 25
curl -i -X GET \
  https://developer.alteg.io/_mock/en/developers/openapi/voip/integration/calls \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "salon_id": 615243,
    "date_from": "2026-01-01",
    "date_to": "2026-02-01",
    "phone": "+13155550175",
    "types": [
      "incoming",
      "internal"
    ],
    "statuses": [
      "success",
      "cancel"
    ],
    "page": 1,
    "limit": 25
  }'

Responses

Calls list

Bodyapplication/json
successboolean(response_success_true_object)

Response status.

Example: true
dataArray of objects

Calls list

Example: [{"id":8923525,"client_id":51342134,"caller_phone":"+13155550175","record_link":"https://records.example.com/somelink.mp3","duration":244,"status":"success","type":"outgoing","call_date":"2026-01-17T23:52:21-05:00"},{"id":66795308,"client_id":0,"caller_phone":"+13155550175","record_link":"","duration":0,"status":"missed","type":"incoming","call_date":"2026-01-17T12:31:12-05:00"}]
metaArray of objects or arrays or object(response_meta_empty_object)

Additional response data (empty object or empty array)

Response
application/json
{
  "success": true,
  "data": [
    { … },
    { … }
  ]
}

Dictionaries

Reference data (countries, cities, business types).

Operations