> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hubtalk.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Adapter accounts

> Creating and changing an adapter account: login, password, organization, dialing defaults, disabling, and refusals on save.

# Adapter accounts

An **adapter account** is the login and password a V2 client uses to sign in to the adapter. It is bound to a V4 organization and stores the dialing defaults that are filled into a campaign when the client's request did not pass a parameter.

> [!NOTE]
>
> **What to know before you start**
>
> * The account login and password work only in the adapter. They do not open the cabinet or the Web API, and a cabinet token or a Web API key does not open the adapter.
> * The password is kept in the adapter password store and is recorded nowhere else: a generated password is shown once.
> * The account organization is the source of agents, report templates and dialing bindings for all its scripts. While the account has no scripts, the organization can be changed; after that it cannot.

## Who sees the section and where it is

The **Compatibility adapter** section is in the cabinet menu under the **Admin** group, after **Market package**. Only the **root organization administrator** sees it. The root organization developer and users of client organizations do not have this item.

The section has two tabs: **Accounts** and **Compatibility registries**. The selected tab, account and filters are kept in the page address, so you can send the link to a colleague.

![The Accounts tab](https://mintcdn.com/hubtalk/imXtUGq2OJsLMMCI/images/v4_adapter_accounts_list_en.png?fit=max\&auto=format\&n=imXtUGq2OJsLMMCI\&q=85\&s=d72321913b02e6c9fa8dbd32386bc5c1)

1. Section tabs: **Accounts** and **Compatibility registries**.
2. **Create account**.
3. List filters: system, organization, **Show disabled**, **Clear filters**.
4. Status: **Active** or **Disabled since …**.
5. Row actions: **Registry**, the **Edit** pencil, the power button **Disable** or **Enable**. Next to them is the **Campaigns** button.

The list shows the login, system, organization, status and who created the account.

> [!WARNING]
>
> **The "The password store of the adapter is unavailable" banner.** If it is shown above the tabs, the adapter password store is not set up or does not respond on this environment. While this is the case, you cannot create accounts, change the password or login, disable or enable accounts. The other account fields and the registries work. The **Check again** button rereads the state; the response may update with a delay of up to a minute. If the banner does not go away, contact the platform engineers.

## Creating an account

Before creating an account, get the client's V2 login **exactly as the client writes it in requests**, and decide with the business whether to keep the former V2 password or issue a new one. The former V2 password cannot be carried over automatically — it has to be entered by hand.

**1. Open the section and click Create account**

The button is in the top right corner. While the section is empty, it is inside the empty list card.

**2. Select the system**

**V2 · MX** or **V2 · KZ**. The system determines the common request fields and login uniqueness: the same login can exist in both MX and KZ. The system cannot be changed after saving.

**3. Enter the login**

Exactly as in the client's requests: this is the `user` field in the request body. Case does not matter — `User_Freedom` and `user_freedom` are the same login. Spaces are not allowed; the length is up to 150 characters.

**4. Set a password or click Generate**

A manual password: not empty, not only spaces, up to 255 characters; any former client password works. A generated password is shown once after saving. While generation is selected, the field shows **Generated on saving**; the **Enter by hand** link returns to manual entry.

**5. Select the V4 organization**

An organization tree with search. The organization provides the agents for scripts, the report templates and the dialing bindings. An archived organization cannot be selected.

**6. Fill in the For the adapter core block**

* **Display name** — the client's name in V2, up to 255 characters. A reference field; it is not passed to the agent.
* **Response to create** — the form of the response to the client: **List of ids** (`{"type":"success","data":[100000001,…]}`) or **Pairs of batch\_id and foreign\_id** (`[{"batch_id":100000001,"foreign_id":"…"}]`). Choose the one the client's code parses.
* **Export template** — the organization report template used to build the response to `details`. Without a template, `details` returns a refusal. For the general V2 form there is the system template `sys-api-v2`, for the moneyman form — `sys-api-moneyman`.
* **Number on the do-not-call list** — what to do with a row whose number is on the organization's **Do not call** list: **Skip the number, as in V2** (the row gets an ID, but no contact is created) or **Refuse the whole request** (the client gets an error on the `phone_number` field).

**7. Check the dialing defaults**

They are filled into a campaign when the request did not pass a parameter:

| Field | Value |
| - | - |
| Attempts | 1–30, but not more than the organization limit |
| Speed | Organization tiers, 20 per minute by default |
| Auto-speed mode | Off by default. When on, every new campaign of the account is created with [auto speed](https://docs.hubtalk.ai/v4/platform/campaign-launch.md#auto-speed): the speed is recomputed every 10 minutes from the contacts left, the retries they are expected to need and the hours left in the window, up to 200 per minute. The speed above and the request's `speed` stay the fallback. Campaigns already created are not changed. |
| Interval between attempts | 15 minutes by default |
| Dialing window | 08:00–21:00 by default |
| Start hour | 09:00 by default, inside the window |
| Repeated upload | **Do not check**, **Skip a number already uploaded today** or **Skip a number with the same foreign\_id uploaded today** |

The window must fit inside the organization's dialing window, otherwise saving is refused.

**8. Click Create**

The account is created together with the password in the store. If the store refuses, the account is not created and the reason appears at the bottom of the window.

![The New adapter account window](https://mintcdn.com/hubtalk/imXtUGq2OJsLMMCI/images/v4_adapter_account_create_en.png?fit=max\&auto=format\&n=imXtUGq2OJsLMMCI\&q=85\&s=24143cb6bcc841009c9509b745bca8df)

On the left — sign-in and organization, on the right — adapter core settings and dialing defaults.

1. System: V2 · MX or V2 · KZ. Cannot be changed after saving.
2. Login exactly as in the client's requests, no spaces, up to 150 characters.
3. Password by hand or **Generate**: a generated one is shown once.
4. V4 organization: the source of agents, templates and bindings.
5. The client's display name in V2, for reference.
6. Form of the response to `create`: a list of IDs or `batch_id`/`foreign_id` pairs.
7. Export template for the `details` operation.
8. What to do with a number on the **Do not call** list.
9. Dialing defaults: attempts, speed, interval.
10. Dialing window: the hours a request may send.
11. Repeated upload: checking numbers uploaded today.
12. **Create**.

### What to check right after creating

* Give the client the login, password and adapter address. The cheapest way to check sign-in is the request `{"user":"…","pass":"…","type":"delete","data":[1]}`: the adapter echoes `{"type":"deleted", "data": [1]}` and withdraws nothing.
* Create the [registry](https://docs.hubtalk.ai/v4/compat-adapter/registry.md): without scripts, any client `create` gets an error on the `type` field. The **Open the registry** button is right in the window with the shown password.

## Password: shown once and changing it

If the password was generated, after **Create** the **Account created** window opens with the password and a **Copy** button. Copy the password right away: it is shown once and stored nowhere else. If you lose it, set a new one in the account edit window.

![The password field after choosing generation](https://mintcdn.com/hubtalk/imXtUGq2OJsLMMCI/images/v4_adapter_account_password_generate_en.png?fit=max\&auto=format\&n=imXtUGq2OJsLMMCI\&q=85\&s=f3ee0946eb402a3b03761fcd181fdd11)

1. After **Generate**, the field shows **Generated on saving**. The **Enter by hand** link returns manual entry.

To change the password, use the edit window: the **Set a new password** button next to the **set** mark. A small **New password for \<login>** window opens with the same password field and a **Generate** button; **Save the password** applies it.

![The new password window](https://mintcdn.com/hubtalk/imXtUGq2OJsLMMCI/images/v4_adapter_account_new_password_en.png?fit=max\&auto=format\&n=imXtUGq2OJsLMMCI\&q=85\&s=4ed35d75c9b6f356aab37f1de4895808)

> [!WARNING]
>
> **The former password stops working within a minute.** After a password change, the former one may still be accepted for up to a minute — this is how the password store works. After a minute, only the new one works.

## Changing an account

The pencil in a list row opens the **Account \<login>** window. The header shows the system, the internal account number and who created it.

![The account edit window](https://mintcdn.com/hubtalk/imXtUGq2OJsLMMCI/images/v4_adapter_account_edit_en.png?fit=max\&auto=format\&n=imXtUGq2OJsLMMCI\&q=85\&s=551d06112d587681c1394ea61d07ad48)

1. The system cannot be changed.
2. The login can be changed.
3. Password: **set** and the **Set a new password** button.
4. The organization is locked while the account has scripts.
5. Display name, response to `create`, export template and do-not-call mode can be changed at any time.
6. Dialing window with the hint **window of the organization …**: you cannot set it wider.
7. **Disable the account**.
8. **Save**.

| Field | What changes for the client |
| - | - |
| Login | The client must send the new login in the `user` field. |
| Organization | Changes only for an account without scripts. On a move, the dialing window and export template are rechecked in the new organization. |
| Response to create | From the next request, the client gets a different response form. Agree on this with the client in advance. |
| Export template | Affects only `details`. Can be set later. |
| Number on the do-not-call list | Applies from the next `create`. |
| Dialing defaults | Apply to subsequent campaigns. Campaigns already created do not change. |

## Disabling and enabling

The power button in a list row or the **Disable the account** button in the edit window opens a confirmation. **An account cannot be deleted**: disabling is the only way to close sign-in for a client.

![Disable confirmation](https://mintcdn.com/hubtalk/imXtUGq2OJsLMMCI/images/v4_adapter_account_disable_en.png?fit=max\&auto=format\&n=imXtUGq2OJsLMMCI\&q=85\&s=6531868cf60987c1cd165c3fa00b8c76)

* **Disabling.** The client immediately gets `{"type":"error", "data":"Authentication failed"}` for any request. The registry scripts remain but stop protecting their agents from archiving and deletion.
* **Enabling.** Sign-in returns within a minute. The scripts protect their agents again.
* A disabled account is visible in the list when the **Show disabled** filter is on: the row is dimmed, and the status says **Disabled since …**. On the registries tab it has the **The account is disabled** banner.

## Refusals on save

Validation errors in the window itself only highlight the field. Server refusals are shown as text at the bottom of the window.

| Refusal text | Reason and what to do |
| - | - |
| Unknown legacy system | Select a system from the list. |
| The login must not be empty, must contain no spaces… | Remove the spaces, shorten to 150 characters. |
| This login is already taken in the selected legacy system | Logins are compared case-insensitively. Turn on **Show disabled**: the account may already exist and need enabling rather than creating a new one. |
| The password must not be blank… | Enter a password or choose generation. |
| The organization does not exist or is archived | Select an active organization. |
| The account has N registry script(s)… | Delete the registry scripts and move the account, or create a new account in the required organization. |
| The report template is not found in the organization of the account | The template was selected from another organization or deleted. Select it again. |
| The dialing default … is outside the allowed limits | Attempts — from 1 to the organization limit; speed — from the organization tiers; interval greater than zero if there is more than one attempt; window start before window end; start hour inside the window. |
| The dialing window … is wider than the allowed window … (source: …) | The account window goes beyond the organization window. Narrow it: there will be no calls outside the organization window anyway. |
| Keycloak refused the operation on the account | A temporary error. Retry in a minute; if it repeats, contact the platform engineers. |
| The password store of the compatibility adapter … is not available | See the banner [above](#who-sees-the-section-and-where-it-is). |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.