Zadarma API

https://zadarma.com/en/support/api/
Admin
Zadarma API is a comprehensive telecommunications platform providing VoIP calling, SMS, virtual...
Tokens:65,268
Snippets:416
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /v1/esim/devices/

Source: https://zadarma.com/en/support/api

Retrieves a list of supported devices for eSIM.

```APIDOC
## GET /v1/esim/devices/

### Description
List of supported devices for eSIM.

### Method
GET

### Endpoint
/v1/esim/devices/

### Response
#### Success Response (200)
- **status** (string) - Success status indicator.
- **devices** (object) - A list of devices grouped by brand.

#### Response Example
{
    "status": "success",
    "devices": {
        "acer": ["ACER Swift 3", "ACER Swift 7"],
        "asus": ["ASUS Mini Transformer T103HAF", "ASUS NovaGo TP370QL", "ASUS Vivobook Flip 14 TP401NA"],
        "xiaomi": ["Xiaomi 12T Pro", "Xiaomi 13 Lite"]
    }
}
```

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

### GET /v1/esim/packages/

Source: https://zadarma.com/en/support/api

Retrieves a list of all available eSIM packages.

```APIDOC
## GET /v1/esim/packages/

### Description
Retrieves a list of all available eSIM packages.

### Method
GET

### Endpoint
/v1/esim/packages/

### Response
#### Success Response (200)
- **status** (string) - Status of the request
- **packages** (object[]) - List of available packages
  - **duration** (integer) - eSIM validity period
  - **countries** (object[]) - List of countries where eSIM service is available
  - **networks** (object[]) - List of networks where mobile internet is available
  - **region** (string) - Region where eSIM is available
  - **id** (string) - Internal identifier of the eSIM
  - **price** (float) - eSIM price
  - **data** (integer) - Available data volume
  - **duration_unit** (string) - Unit of measurement for duration
  - **data_unit** (string) - Unit of measurement for data
  - **top_up** (boolean) - Availability for top-up
  - **kyc_verify** (boolean) - Document verification requirement
  - **activation_policy** (string) - Activation policy (first-usage or installation)
  - **price_multi_currency** (object) - Prices in various currencies
  - **activation_limit_days** (integer) - Days to activate after connection

#### Response Example
{
  "status": "success",
  "packages": [
    {
      "duration": 7,
      "countries": [{"iso2": "cn", "name": "China", "aliases": []}],
      "networks": [{"iso2": "CN", "network": "China Unicom", "type": "LTE"}],
      "region": null,
      "id": "1-cn-7days-1gb",
      "price": 5,
      "data": 1,
      "duration_unit": "days",
      "data_unit": "GB",
      "top_up": true,
      "kyc_verify": false,
      "activation_policy": "first-usage",
      "activation_limit_days": null,
      "price_multi_currency": {"eur": 5, "usd": 5, "gbp": 4, "pln": 19, "kzt": 2000, "uah": 200}
    }
  ]
}
```

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

### GET /v1/pbx/ivr/scenario/

Source: https://zadarma.com/en/support/api

Retrieves a list of IVR scenarios.

```APIDOC
## GET /v1/pbx/ivr/scenario/

### Description
Retrieves a list of IVR scenarios.

### Method
GET

### Endpoint
/v1/pbx/ivr/scenario/

### Parameters
#### Query Parameters
- **user_id** (string) - Optional - Only available for use for reseller and users created by them.
- **menu_id** (integer) - Required - Menu ID/IVR.

### Response
#### Success Response (200)
- **status** (string) - Status of the request.
- **scenarios** (array) - List of IVR scenarios.
```

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

### GET /v1/info/lists/currencies/

Source: https://zadarma.com/en/support/api

Retrieves a list of supported currencies.

```APIDOC
## GET /v1/info/lists/currencies/

### Description
Returns a list of currencies available in the system.

### Method
GET

### Endpoint
/v1/info/lists/currencies/

### Response
#### Success Response (200)
- **status** (string) - Status of the request
- **currencies** (array) - List of currency codes
```

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

### GET /v1/pbx/ivr/

Source: https://zadarma.com/en/support/api

Retrieves the list of IVR configurations.

```APIDOC
## GET /v1/pbx/ivr/

### Description
Retrieves the list of IVR configurations, including menu settings and auto-responder schedules.

### Method
GET

### Endpoint
/v1/pbx/ivr/

### Parameters
#### Query Parameters
- **user_id** (string) - Optional - Available only to resellers for users they have created.

### Response
#### Success Response (200)
- **status** (string) - Status of the request.
- **pbx_id** (integer) - The PBX identifier.
- **ivrs** (array) - List of IVR configurations.
```

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

### GET /v1/info/lists/tariffs/

Source: https://zadarma.com/en/support/api

Retrieves a list of available price plans.

```APIDOC
## GET /v1/info/lists/tariffs/

### Description
Returns a list of price plans and package tariffs.

### Method
GET

### Endpoint
/v1/info/lists/tariffs/

### Parameters
#### Query Parameters
- **currency** (string) - Optional - The currency to filter tariffs by.

### Response
#### Success Response (200)
- **status** (string) - Status of the request
- **currency** (string) - The currency used for the tariffs
- **tariffs** (array) - List of standard tariffs
- **package_tariffs** (array) - List of package-based tariffs
```

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

### Create PBX Extension

Source: https://zadarma.com/en/support/api

Response example for creating new PBX extensions.

```json
                                    {
    "status": "success",
    "numbers": [
        {
            "number": 200,
            "password": "PASSWORD"
        },
        {
            "number": 201,
            "password": "PASSWORD"
        }
    ]
}
```

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

### GET /v1/pbx/webhooks/

Source: https://zadarma.com/en/support/api

Retrieves the current PBX webhook settings.

```APIDOC
## GET /v1/pbx/webhooks/

### Description
Retrieves the current webhook settings and URL for the PBX.

### Method
GET

### Endpoint
/v1/pbx/webhooks/

### Parameters
#### Query Parameters
- **user_id** (string) - Optional - Only available for use for reseller and users created by them.

### Response
#### Success Response (200)
- **status** (string) - The status of the request.
- **url** (string) - The configured webhook URL.
- **hooks** (object) - The current status of various webhook notifications.
```

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

### GET /v1/webrtc/

Source: https://zadarma.com/en/support/api

Retrieves information about the current WebRTC widget integration.

```APIDOC
## GET /v1/webrtc/

### Description
WebRTC widget integration information.

### Method
GET

### Endpoint
/v1/webrtc/

### Parameters
#### Query Parameters
- **user_id** (string) - Optional - Only available for use for reseller and users created by them

### Response
#### Success Response (200)
- **status** (string) - Status of the request
- **is_exists** (boolean) - Whether the integration exists
- **domains** (array) - List of associated domains
- **settings** (object) - Current widget settings
```

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

### Retrieve labels list response

Source: https://zadarma.com/en/support/api

Example response structure for the GET /v1/zcrm/customers/labels endpoint.

```json
{
  "totalCount": 5,
  "labels": [
    {
      "id": 12,
      "label": "Best clients",
      "count": 14
    }
  ]
}
```

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

### GET /v1/reseller/users/list/

Source: https://zadarma.com/en/support/api

Retrieves a paginated list of reseller users.

```APIDOC
## GET /v1/reseller/users/list/

### Description
List of reseller users displayed per page (50 pc).

### Method
GET

### Endpoint
/v1/reseller/users/list/

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number.

### Response
#### Success Response (200)
- **status** (string) - Status of the request.
- **total** (integer) - Total number of users.
- **total_pages** (integer) - Total number of pages.
- **page** (integer) - Current page number.
- **users** (array) - List of user objects.
```

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

### GET /v1/reseller/account/info/

Source: https://zadarma.com/en/support/api

Retrieves reseller account information.

```APIDOC
## GET /v1/reseller/account/info/

### Description
Retrieves reseller account information including balance and fees.

### Method
GET

### Endpoint
/v1/reseller/account/info/

### Response
#### Success Response (200)
- **status** (string) - Status of the operation.
- **balance** (number) - Current balance.
- **credit** (number) - Available credit.
- **currency** (string) - Currency code.
- **reseller_fee** (number) - Reseller fee percentage.
- **user_fee** (number) - User fee percentage.

### Response Example
{
    "status": "success",
    "balance": 123,
    "credit": 0,
    "currency": "USD",
    "reseller_fee": 10,
    "user_fee": 10
}
```

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

### Get Currency List

Source: https://zadarma.com/en/support/api

Retrieves the list of supported currencies.

```json
                                    {
    "status": "success",
    "currencies": [
        "USD",
        "EUR",
        "GBP",
        "PLN"
    ]
}
```

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

### Create SIP Number

Source: https://zadarma.com/en/support/api

Response example for the creation of a new SIP number.

```json
{
    "status": "success",
    "sip": "123456"
}
```

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

### GET /v1/info/balance/

Source: https://zadarma.com/en/support/api

Retrieves the current user balance and currency.

```APIDOC
## GET /v1/info/balance/

### Description
Retrieves the current user balance and currency.

### Method
GET

### Endpoint
/v1/info/balance/

### Response
#### Success Response (200)
- **status** (string) - Status of the request
- **balance** (number) - Current balance amount
- **currency** (string) - Currency code
```

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

### GET /v1/pbx/internal/

Source: https://zadarma.com/en/support/api

Retrieves the list of PBX extensions associated with the user.

```APIDOC
## GET /v1/pbx/internal/

### Description
Displays the PBX extensions.

### Method
GET

### Endpoint
/v1/pbx/internal/

### Response
#### Success Response (200)
- **status** (string) - Success status
- **pbx_id** (integer) - The user's PBX ID
- **numbers** (array) - The list of extensions
```

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

### GET /v1/request/callback/

Source: https://zadarma.com/en/support/api

Initiates a callback request between two numbers.

```APIDOC
## GET /v1/request/callback/

### Description
Initiates a callback request between your phone/SIP number and the destination number.

### Method
GET

### Endpoint
/v1/request/callback/

### Parameters
#### Query Parameters
- **from** (string) - Required - Your phone/SIP number, the PBX extension or the PBX scenario, to which the CallBack is made.
- **to** (string) - Required - The phone or SIP number that is being called.
- **sip** (string) - Optional - SIP user's number or the PBX extension used to make the call.
- **predicted** (boolean) - Optional - If specified, the request is predicted.

### Response
#### Success Response (200)
- **status** (string) - Status of the request.
- **from** (integer) - The source number.
- **to** (integer) - The destination number.
- **time** (integer) - Timestamp of the request.
```

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

### GET /v1/pbx/internal/<PBXSIP>/info/

Source: https://zadarma.com/en/support/api

Retrieves detailed configuration information for a specific PBX extension.

```APIDOC
## GET /v1/pbx/internal/<PBXSIP>/info/

### Description
Retrieves detailed information about a PBX extension.

### Method
GET

### Endpoint
/v1/pbx/internal/<PBXSIP>/info/

### Parameters
#### Path Parameters
- **PBXSIP** (string) - Required - The PBX extension number

### Response
#### Success Response (200)
- **status** (string) - Success status
- **pbx_id** (integer) - PBX ID
- **number** (integer) - PBX extension
- **name** (string) - Displayed name
- **caller_id** (string) - CallerID
- **caller_id_app_change** (string) - CallerID change from the app (true|false)
- **caller_id_by_direction** (string) - CallerID by destination (true|false)
- **lines** (string) - Number of lines
- **ip_restriction** (string) - Access restrictions by IP
- **record_store** (string) - Call recording storage setting
- **record_email** (string) - Email for sending call recordings
- **supervisor_status** (integer) - Supervisor status
```

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

### NOTIFY_OUT_START

Source: https://zadarma.com/en/support/api

Event triggered at the start of an outgoing call from the PBX.

```APIDOC
## NOTIFY_OUT_START

### Description
This event notifies the system about the start of an outgoing call from the PBX.

### Parameters
- **event** (string) - Required - The event name (NOTIFY_OUT_START)
- **call_start** (string) - Required - The call start time
- **pbx_call_id** (string) - Required - The call ID
- **destination** (string) - Required - The phone number that was called
- **internal** (string) - Optional - The extension number
```

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

### GET /v1/pbx/callinfo/

Source: https://zadarma.com/en/support/api

Retrieves the current PBX call information settings.

```APIDOC
## GET /v1/pbx/callinfo/

### Description
Retrieves the current PBX call information settings.

### Method
GET

### Endpoint
/v1/pbx/callinfo/

### Parameters
#### Query Parameters
- **user_id** (string) - Optional - Only available for use for reseller and users created by them.
```

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

### GET /v1/pbx/ivr/sounds/list

Source: https://zadarma.com/en/support/api

Retrieves a list of voice greeting files uploaded for IVR.

```APIDOC
## GET /v1/pbx/ivr/sounds/list

### Description
Returns a list of all voice greeting files currently uploaded for the IVR system.

### Method
GET

### Endpoint
/v1/pbx/ivr/sounds/list
```

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

### NOTIFY_INTERNAL

Source: https://zadarma.com/en/support/api

Notifies the system of the start of an incoming call to a PBX extension.

```APIDOC
## NOTIFY_INTERNAL

### Description
Notifies the start of an incoming call to the PBX extension.

### Parameters
- **event** (string) - Required - The event name (NOTIFY_INTERNAL)
- **call_start** (string) - Required - The call start time
- **pbx_call_id** (string) - Required - The call ID
- **caller_id** (string) - Required - The caller's phone number
- **called_did** (string) - Required - The phone number that was called
- **internal** (string) - Optional - Extension
- **transfer_from** (string) - Optional - Transfer initiator, extension
- **transfer_type** (string) - Optional - Transfer type

### Signature Verification (PHP)
```php
$signatureTest = base64_encode(hash_hmac('sha1', 
    $_POST['caller_id'] . $_POST['called_did'] . 
    $_POST['call_start'], API_SECRET));
```
```

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

### Get PBX Extension Information

Source: https://zadarma.com/en/support/api

Retrieve detailed configuration information for a specific PBX extension.

```json
                                    {
    "status": "success",
    "pbx_id": 12345,
    "number": 100,
    "name": "Extension 100",
    "caller_id": "+44000000000",
    "caller_id_app_change": "true",
    "caller_id_by_direction": "false",
    "lines": "3",
    "ip_restriction": "1.1.1.1",
    "record_store": "For automatic speech recognition",
    "record_email": "email@server.com",
    "supervisor_status": 1
}
```

```xml
                                    <?xml version="1.0"?>
<answer>
    <status>success</status>
    <pbx_id>12345</pbx_id>
    <number>100</number>
    <name>Extension 100</name>
    <caller_id>+44000000000</caller_id>
    <caller_id_app_change>true</caller_id_app_change>
    <caller_id_by_direction>false</caller_id_by_direction>
    <lines>3</lines>
    <ip_restriction>1.1.1.1</ip_restriction>
    <record_store>For automatic speech recognition</record_store>
    <record_email>email@server.com</record_email>
   <supervisor_status>1</supervisor_status>
</answer>
```

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

### GET /v1/info/lists/languages/

Source: https://zadarma.com/en/support/api

Retrieves a list of languages available in the personal account.

```APIDOC
## GET /v1/info/lists/languages/

### Description
Returns a list of languages available for use in the personal account.

### Method
GET

### Endpoint
/v1/info/lists/languages/

### Response
#### Success Response (200)
- **status** (string) - Status of the request
- **languages** (array) - List of language codes
```

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

### GET /v1/tariff/

Source: https://zadarma.com/en/support/api

Retrieves information about the user's current price plan.

```APIDOC
## GET /v1/tariff/

### Description
Retrieves information about the user's current price plan.

### Method
GET

### Endpoint
/v1/tariff/

### Response
#### Success Response (200)
- **status** (string) - Status of the request
- **info** (object) - Detailed tariff information including ID, name, activity status, cost, currency, and usage statistics
```

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

### Create new label response

Source: https://zadarma.com/en/support/api

Example response structure for the POST /v1/zcrm/customers/labels endpoint.

```json
{
  "id": 13,
  "label": "Very best clients",
  "count": 0
}
```

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

### Get PBX Webhooks Settings

Source: https://zadarma.com/en/support/api

Response format for retrieving current PBX webhook configurations.

```json
                                    {
    "status": "success",
    "url": "",
    "hooks": {
        "number_lookup": "true",
        "call_tracking": "false",
        "sms": "true",
        "speech_recognition": "true"
    }
}
```

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

### GET /v1/sip/redirection/

Source: https://zadarma.com/en/support/api

Displays current call forwarding settings for SIP numbers.

```APIDOC
## GET /v1/sip/redirection/

### Description
Retrieves the current call forwarding configuration for the user's SIP numbers.

### Method
GET

### Endpoint
/v1/sip/redirection/

### Parameters
#### Query Parameters
- **id** (string) - Optional - Selection of a specific SIP ID.

### Response
#### Success Response (200)
- **status** (string) - The status of the request.
- **info** (array) - List of forwarding configurations.

### Response Example
{
    "status":"success",
    "info": [
        {
            "sip_id":"00001",
            "status":"on",
            "condition":"always",
            "destination":"phone",
            "destination_value":"442037691880"
        }
    ]
}
```

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

### Retrieve CRM User Groups Response

Source: https://zadarma.com/en/support/api

Example JSON response structure for the get /v1/zcrm/users/groups endpoint.

```json
                                    {
  "totalCount": 4,
  "groups": [
    {
      "id": 45,
      "type": "manager",
      "title": "",
      "permissions": {
        "customers_create": true,
        "customers_edit": true,
        "customers_delete": true,
        "customers_import_export": true,
        "customers_view_all": false,
        "calendar_other_users_access": false,
        "calls_other_users_access": false,
        "leads_view": false,
        "leads_edit": false,
        "leads_delete": false,
        "leads_import_export": false,
        "team_add": false,
        "team_edit": false
      }
    }
  ]
}
```

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

### POST /v1/pbx/create/

Source: https://zadarma.com/en/support/api

Creates a new PBX instance.

```APIDOC
## POST /v1/pbx/create/

### Description
Creates a new PBX instance for the user.

### Method
POST

### Endpoint
/v1/pbx/create/

### Parameters
#### Request Body
- **sip_id** (string) - Optional - SIP number for PBX connection.
- **password** (string) - Required - Password for the first PBX number '100'.
- **user_id** (string) - Optional - Only available for use for reseller and users created by them.

### Response
#### Success Response (200)
- **status** (string) - The status of the request.
- **stop_datetime** (string) - The stop date and time for the PBX.
```

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

### POST /v1/webrtc/create/

Source: https://zadarma.com/en/support/api

Creates a new WebRTC widget integration.

```APIDOC
## POST /v1/webrtc/create/

### Description
WebRTC widget integration creation.

### Method
POST

### Endpoint
/v1/webrtc/create/

### Parameters
#### Request Body
- **user_id** (string) - Optional - Only available for use for reseller and users created by them
- **domain** (string) - Required - Domain name.
```

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

### Retrieve Users List Response

Source: https://zadarma.com/en/support/api

Example JSON response structure returned by the GET /v1/zcrm/users endpoint.

```json
{
  "totalCount": 2,
  "users": [
    {
      "id": 234,
      "email": "john@example.com",
      "name": "John Beam",
      "group_id": 653,
      "is_superadmin": 1,
      "enabled": 1,
      "created_at": "2020-04-27 01:01:31",
      "avatar": 2457,
      "role": "",
      "status": "",
      "language": "en",
      "color": "220",
      "color_hex": "5678BD",
      "internal_number": "100",
      "timezone": "Europe/London",
      "first_day": 1,
      "device": "webphone",
      "phone_widget_location": "right",
      "phones": [
        {
          "phone": "+44123456789",
          "type": "work"
        }
      ],
      "contacts": [
        {
          "type": "email_work",
          "value": "ivanov@example.com"
        }
      ]
    }
  ]
}
```

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

### GET /v1/pbx/redirection/

Source: https://zadarma.com/en/support/api

Retrieves the current call forwarding parameters for a specific PBX extension.

```APIDOC
## GET /v1/pbx/redirection/

### Description
Retrieves call forwarding parameters on the PBX extension.

### Method
GET

### Endpoint
/v1/pbx/redirection/

### Parameters
#### Query Parameters
- **pbx_number** (string) - Required - PBX extension, for example 100.

### Response
#### Success Response (200)
- **status** (string) - Status of the request.
- **current_status** (string) - Current forwarding status (e.g., on).
- **pbx_id** (string) - PBX ID.
- **pbx_name** (string) - PBX extension name.
- **type** (string) - Forwarding type.
- **destination** (string) - Forwarding destination number.
- **condition** (string) - Forwarding condition (e.g., noanswer).
```

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

### POST /v1/esim/order/create/

Source: https://zadarma.com/en/support/api

Connects an eSIM package to the user account.

```APIDOC
## POST /v1/esim/order/create/

### Description
Connects an eSIM package to the user account.

### Method
POST

### Endpoint
/v1/esim/order/create/

### Parameters
#### Request Body
- **package_id** (string) - Required - package ID for connection, packages.*.id from the method /v1/esim/packages/
- **user_id** (integer) - Optional - User ID for connection. This is only available for use by dealers and only for users that have been created by them. By default, the current user ID will be used.

### Response
#### Success Response (200)
- **status** (string) - Status of the request
- **order** (object) - Data about the connected package

#### Response Example
{
    "status": "success",
    "order": {
        "iccid": "8937204016150824154",
        "activation_code": "LPA:1$smdp.io$K2-1UYQA7-Z8B3BF",
        "status": "inactive",
        "packages": [
            {
                "iccid": "8937204016150824154",
                "price": 11.01,
                "currency": "EUR",
                "countries": [
                    {
                        "iso2": "us",
                        "name": "США",
                        "aliases": []
                    }
                ],
                "duration": 30,
                "data": 0,
                "data_remaining": 0,
                "top_up": true,
                "type": "one-off",
                "region": "change",
                "created_at": 1720700977,
                "auto_prolong": false,
                "activated_at": null,
                "expired_at": null,
                "reference_id": null,
                "id": "3-change-30days-0gb"
            }
        ],
        "created_at": 1720700977,
        "title": null,
        "msisdn": null
    }
}

#### Error Response
- **status** (string) - Status of the request
- **message** (string) - Error message

#### Error Example
{
  "status": "error",
  "message": "Not enough money on your account"
}
```

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

### Retrieve CRM event task details

Source: https://zadarma.com/en/support/api

Example JSON response structure returned by the GET /v1/zcrm/events/<event_id> endpoint.

```json
{
  "id": 40,
  "type": "task",
  "title": "Create text for Good Company",
  "description": "",
  "start": "2020-05-26 09:00:00",
  "end": "2020-05-26 12:30:00",
  "allDay": false,
  "created_by": 234,
  "responsible_user": 234,
  "phone": "",
  "call_done": 0,
  "completed": 0,
  "completed_comment": "",
  "members": [234, 235],
  "customers": [
    {
      "id": 3486,
      "name": "Good Company",
      "status": "company",
      "type": "client",
      "lead_source": "manual",
      "lead_status": "not_processed",
      "contact_type": "customer"
    }
  ]
}
```

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

### POST /v1/pbx/internal/create/

Source: https://zadarma.com/en/support/api

Creates one or more new PBX extensions.

```APIDOC
## POST /v1/pbx/internal/create/

### Description
Creates a specified quantity of PBX extensions starting from a defined number.

### Method
POST

### Endpoint
/v1/pbx/internal/create/

### Parameters
#### Request Body
- **user_id** (string) - Optional - User ID for resellers.
- **start_number** (string) - Required - Starting number (100-999) or "any".
- **quantity** (integer) - Required - Number of extensions to create.
- **return_password** (boolean) - Optional - If true, returns passwords in the response.

### Response
#### Success Response (200)
- **status** (string) - Success status.
- **numbers** (array) - List of created extension objects containing number and password.
```

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

### Get Incoming Channels Information

Source: https://zadarma.com/en/support/api

Response format for the GET request to check the possibility of increasing incoming channels for a virtual number.

```json
{
    "status": "success"
}
```

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

### Get WebRTC widget information

Source: https://zadarma.com/en/support/api

Retrieves current configuration and status of the WebRTC widget integration.

```json
{
    "status": "success",
    "is_exists": true,
    "domains": [
        "test.domain.com"
    ],
    "settings": {
        "shape": "square",
        "position": "top_right"
    }
}
```

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

### GET /v1/zcrm/customers/labels

Source: https://zadarma.com/en/support/api

Returns the list of all labels and their statistics.

```APIDOC
## GET /v1/zcrm/customers/labels

### Description
Returns the list of all labels and their statistics.

### Method
GET

### Endpoint
/v1/zcrm/customers/labels

### Response
#### Success Response (200)
- **totalCount** (integer) - total number of labels in the system
- **labels** (array) - labels array containing id, label, and count.
```

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

### POST /v1/reseller/users/registration/new/

Source: https://zadarma.com/en/support/api

Registers a new user in the Zadarma system.

```APIDOC
## POST /v1/reseller/users/registration/new/

### Description
User registration endpoint for resellers.

### Method
POST

### Endpoint
/v1/reseller/users/registration/new/

### Parameters
#### Request Body
- **email** (string) - Required - client email address
- **first_name** (string) - Required - client name
- **last_name** (string) - Optional - client last name
- **middle_name** (string) - Optional - client middle name
- **organization** (string) - Optional - organization name
- **country** (string) - Required - ISO2 country code
- **city** (string) - Required - client city
- **address** (string) - Optional - client address
- **phone** (string) - Optional - client phone
- **password** (string) - Optional - account password
- **tariff** (string) - Required - price plan ID
- **tariff_period** (string) - Optional - price plan period month | year
- **language** (string) - Optional - language code
- **currency** (string) - Optional - currency code
- **promocode** (string) - Optional - promotional code
- **gmt** (string) - Optional - GMT
- **id_card** (string) - Optional - ID card number or passport

### Response
#### Success Response (200)
- **status** (string) - Success status
- **user_id** (integer) - ID of the registered user
- **message** (string) - Registration status message
```

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

### POST /v1/pbx/ivr/create/

Source: https://zadarma.com/en/support/api

Creates a new IVR menu.

```APIDOC
## POST /v1/pbx/ivr/create/

### Description
Creates a new IVR menu.

### Method
POST

### Endpoint
/v1/pbx/ivr/create/

### Parameters
#### Query Parameters
- **user_id** (string) - Optional - Only available for use for reseller and users created by them.
- **buy** (string) - Optional - 'true' - paid menu creation.

### Response
#### Success Response (200)
- **status** (string) - Status of the request.
- **menu_id** (integer) - The ID of the created menu.
```

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

### Register new user

Source: https://zadarma.com/en/support/api

Returns the registration status for a new user, which may include account activation instructions via email.

```json
                                    {
    "status": "success",
    "user_id": 12345,
    "message": "You registered a new user in the system."
},{
    "status": "success",
    "message": "You registered a new user in the system. A registration confirmation link was sent to the email address you provided. To activate the account the user needs to click on that link, after which they can log in on the website."
},{
    "status": "success",
    "message": "You registered a new user in the system. A registration confirmation code was sent to the email address you provided. To activate the account the user needs to send code to you, after which you can confirm registration using API."
}
```

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

### GET /v1/zcrm/files/<file_id>

Source: https://zadarma.com/en/support/api

Retrieves a file by its unique identifier.

```APIDOC
## GET /v1/zcrm/files/<file_id>

### Description
Gives files by its ID.

### Method
GET

### Endpoint
/v1/zcrm/files/<file_id>

### Parameters
#### Path Parameters
- **file_id** (string) - Required - The unique identifier of the file.
```

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

### POST /v1/pbx/ivr/scenario/create/

Source: https://zadarma.com/en/support/api

Creates a new IVR scenario.

```APIDOC
## POST /v1/pbx/ivr/scenario/create/

### Description
Creates a new IVR scenario.

### Method
POST

### Endpoint
/v1/pbx/ivr/scenario/create/

### Parameters
#### Query Parameters
- **push_button** (integer) - Required - Scenario activation upon button press (0-9, 10, 11-30).
- **title** (string) - Required - Title.
- **extension** (string) - Required - Extension, numbers separated by space, or "fax".
- **menu_id** (integer) - Required - Menu ID/IVR.
- **user_id** (string) - Optional - Available for use only by dealers and only for those users created by them.
- **trigger_to_did_numbers** (string) - Optional - Numbers that trigger the scenario.
- **trigger_to_did_ext_lines** (string) - Optional - External lines that trigger the scenario.
- **trigger_from_clid_numbers** (string) - Optional - Numbers from which the scenario is triggered.

### Response
#### Success Response (200)
- **status** (string) - Status of the request.
- **menu_id** (integer) - Menu ID.
- **scenario_id** (integer) - The ID of the created scenario.
```

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

### Enable PBX Extension Call Recording

Source: https://zadarma.com/en/support/api

Response examples for enabling call recording on a PBX extension.

```json
                                    {
    "status":"success",
    "internal_number":100,
    "recording":"on",
    "email":"test@test.com",
    "speech_recognition":"all"
}
```

```xml
                                    <?xml version="1.0"?>
<answer>
    <status>success</status>
    <internal_number>100</internal_number>
    <recording>on</recording>
    <email>on</email>
    <speech_recognition>all</speech_recognition>
</answer>
```

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

### GET /v1/sip/

Source: https://zadarma.com/en/support/api

Retrieves the list of user's SIP-numbers.

```APIDOC
## GET /v1/sip/

### Description
Returns the list of SIP-numbers associated with the user account.

### Method
GET

### Endpoint
/v1/sip/

### Response
#### Success Response (200)
- **status** (string) - Status of the request
- **sips** (array) - List of SIP objects containing id, display_name, and lines
- **left** (integer) - Number of remaining SIPs that can be created
```

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

### Add a note to customer timeline

Source: https://zadarma.com/en/support/api

Example response structure for a successful note creation request.

```json
{
  "id": 37825,
  "type": "note",
  "content": "Call to the client",
  "time": "2020-06-08 06:55:02",
  "user_id": 20,
  "user_name": "John Beam",
  "attached_files": [
    {
      "file_id": 576,
      "original_filename": "document.doc"
    }
  ]
}
```

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

### Initialize Webhook Script

Source: https://zadarma.com/en/support/api

Add this snippet to the beginning of your PHP script to handle the initial Zadarma verification request.

```php
<?php if (isset($_GET['zd_echo'])) exit($_GET['zd_echo']); ?>
```

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

### PUT /v1/webrtc/

Source: https://zadarma.com/en/support/api

Updates settings for an existing WebRTC widget integration.

```APIDOC
## PUT /v1/webrtc/

### Description
WebRTC widget integration setting change.

### Method
PUT

### Endpoint
/v1/webrtc/

### Parameters
#### Request Body
- **user_id** (string) - Optional - Only available for use for reseller and users created by them
- **shape** (string) - Optional - Widget shape, possible values: 'square', 'rounded'
- **position** (string) - Optional - Widget position, possible values: 'top_left', 'top_right', 'bottom_right', 'bottom_left'
```

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

### GET /v1/zcrm/deals/<deal_id>/feed

Source: https://zadarma.com/en/support/api

Returns records in the deal feed.

```APIDOC
## GET /v1/zcrm/deals/<deal_id>/feed

### Description
Returns records in the deal feed.

### Method
GET

### Endpoint
/v1/zcrm/deals/<deal_id>/feed

### Parameters
#### Path Parameters
- **deal_id** (string) - Required - deal id

### Response
#### Success Response (200)
- **totalCount** (integer) - total number of records
- **items** (array) - array of records containing id, type, content, time, user_id, user_name, and attached_files.
```

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

### Create PBX

Source: https://zadarma.com/en/support/api

Response format for creating a new PBX instance.

```json
                                    {
    "status": "success",
    "stop_datetime": "2021-12-31 23:59:59"
}
```

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

### GET /v1/zcrm/users

Source: https://zadarma.com/en/support/api

Retrieves a list of all users registered in the CRM system.

```APIDOC
## GET /v1/zcrm/users

### Description
Returns a list of users from the CRM.

### Method
GET

### Endpoint
/v1/zcrm/users

### Response
#### Success Response (200)
- **totalCount** (integer) - Total number of users
- **users** (array) - List of user objects

#### Response Example
{
  "totalCount": 2,
  "users": [
    {
      "id": 234,
      "email": "john@example.com",
      "name": "John Beam",
      "group_id": 653,
      "is_superadmin": 1,
      "enabled": 1,
      "created_at": "2020-04-27 01:01:31",
      "avatar": 2457,
      "role": "",
      "status": "",
      "language": "en",
      "color": "220",
      "color_hex": "5678BD",
      "internal_number": "100",
      "timezone": "Europe/London",
      "first_day": 1,
      "device": "webphone",
      "phone_widget_location": "right",
      "phones": [
        {
          "phone": "+44123456789",
          "type": "work"
        }
      ],
      "contacts": [
        {
          "type": "email_work",
          "value": "ivanov@example.com"
        }
      ]
    }
  ]
}
```

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

### GET /v1/zcrm/leads

Source: https://zadarma.com/en/support/api

Retrieves a list of CRM leads with pagination and metadata.

```APIDOC
## GET /v1/zcrm/leads

### Description
Retrieves a list of CRM leads, including total counts and detailed lead information such as status, source, and contact details.

### Method
GET

### Endpoint
/v1/zcrm/leads

### Response
#### Success Response (200)
- **totalCount** (integer) - Total number of found leads
- **uncategorizedCount** (integer) - Total number of raw leads
- **leads** (array) - List of lead objects

#### Response Example
{
  "totalCount": 100,
  "uncategorizedCount": 10,
  "leads": [
    {
      "id": 3486,
      "name": "Good Company",
      "responsible_user_id": 234,
      "employees_count": "50",
      "comment": "",
      "country": "GB",
      "city": "London",
      "address": "",
      "zip": "",
      "website": "",
      "lead_status": "not_processed",
      "lead_source": "manual",
      "lead_created_at": "2020-04-28 05:47:47",
      "lead_created_by": 234,
      "phones": [
        {
          "type": "work",
          "phone": "+44123456789"
        }
      ],
      "contacts": [
        {
          "type": "email_work",
          "value": "good_company@example.com"
        }
      ],
      "labels": [
        {
          "id": 22,
          "label": "Best clients"
        }
      ],
      "utms": [
        {
          "id": 19,
          "param": "utm_source",
          "value": "google",
          "display_value": "Google"
        }
      ]
    }
  ]
}
```

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

### GET /v1/esim/order/

Source: https://zadarma.com/en/support/api

Retrieves a list of connected eSIM packages for the current user or a specified user if authorized as a dealer.

```APIDOC
## GET /v1/esim/order/

### Description
List of connected eSIM packages. By default, it returns packages for the current user. Dealers can specify a user_id to retrieve packages for users they have created.

### Method
GET

### Endpoint
/v1/esim/order/

### Parameters
#### Query Parameters
- **user_id** (integer) - Optional - The ID of the requested user. Only available for dealers.

### Response
#### Success Response (200)
- **status** (string) - The status of the request.
- **orders** (object[]) - A list of connected packages.

#### Response Example
{
  "status": "success",
  "orders": [
    {
      "iccid": "8937204017175532566",
      "status": "inactive",
      "packages": [
        {
          "iccid": "8937204017175532566",
          "price": 4.5,
          "currency": "USD",
          "countries": [
            {
              "iso2": "al",
              "name": "Albania",
              "aliases": []
            }
          ],
          "duration": 30,
          "data": 1,
          "region": null,
          "id": "3-al-30days-1gb",
          "data_remaining": 1,
          "top_up": true,
          "created_at": 1730978058,
          "auto_prolong": false,
          "activated_at": null,
          "expired_at": null,
          "reference_id": "672ca10a84a28e977c0cfe39"
        }
      ],
      "title": null,
      "msisdn": null,
      "activation_code": "LPA:1$smdp.io$K2-2627GZ-1UM3Z3Y",
      "created_at": 1730978058
    }
  ]
}
```

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

### GET /v1/zcrm/customers/utms

Source: https://zadarma.com/en/support/api

Returns an array of all source tags and their associated statistics.

```APIDOC
## GET /v1/zcrm/customers/utms

### Description
Returns the array of all source tags and their statistics.

### Method
GET

### Endpoint
/v1/zcrm/customers/utms

### Response
#### Success Response (200)
- **id** (integer) - source tag id
- **param** (string) - source tag type (utm_source, utm_medium, utm_campaign, utm_content, phone, custom)
- **value** (string) - actual source tag value
- **display_value** (string) - displayed source tag value
- **count** (integer) - number of clients and leads using this source tag

#### Response Example
[
  {
    "id": 78,
    "param": "utm_source",
    "value": "google",
    "display_value": "Google",
    "count": 1267
  }
]
```

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

### POST /v1/webrtc/domain/

Source: https://zadarma.com/en/support/api

Adds a domain to the WebRTC widget integration.

```APIDOC
## POST /v1/webrtc/domain/

### Description
Add a domain to WebRTC widget integration.

### Method
POST

### Endpoint
/v1/webrtc/domain/

### Parameters
#### Query Parameters
- **user_id** (string) - Optional - Only available for use for reseller and users created by them.
- **domain** (string) - Required - Domain name.

### Response
#### Success Response (200)
- **status** (string) - Success status indicator.

### Response Example
{
   "status": "success"
}
```

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

### List Supported eSIM Devices

Source: https://zadarma.com/en/support/api

Successful response containing a list of eSIM-supported devices grouped by brand.

```json
                                    Response 1:  
{
    "status": "success",
    "devices": {
        "acer": [
            "ACER Swift 3",
            "ACER Swift 7"
        ],
        "asus": [
            "ASUS Mini Transformer T103HAF",
            "ASUS NovaGo TP370QL",
            "ASUS Vivobook Flip 14 TP401NA"
        ],
        "xiaomi": [
            "Xiaomi 12T Pro",
            "Xiaomi 13 Lite"
        ]
    }
}
```
Tokens:
Raw