> ## 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 campaigns

> How a client request becomes a V4 campaign, how to find an adapter campaign, and what its card shows.

# Adapter campaigns

Client requests turn into ordinary V4 campaigns with contacts and calls. The cabinet marks them with the **Compatibility adapter** badge and shows the root organization administrator the account, the registry script and the adapter contact IDs.

> [!NOTE]
>
> The adapter attributes — the account, the registry script, the contact IDs — are visible **only to the root organization administrator**. Users of the client organization see the same screens as before.

## How a request becomes a campaign

| In the V2 request | In the V4 cabinet |
| - | - |
| `cname`, day, `start_hour`, script | Campaign name `<cname> <YYYY-MM-DD> <HH:MM> (<script>)`, up to 80 characters. An empty `cname` becomes `API`. The date is the campaign day in the organization's time zone; if the request arrived 5 minutes before the end of the day or later, it is tomorrow's date. |
| A repeated request with the same attributes on the same day | A batch of calls into the same campaign: the **Contacts** column grows, and the campaign gets the **With call additions** pill. |
| Response `{"type":"success","data":[100000017,…]}` | Adapter contact IDs, nine digits starting from 100,000,000. Visible in the expanded contact row and in the call overview. |
| Account | In the card subtitle: "Source: compatibility adapter · Account: \<login> (V2 · MX) · Registry script: \<name>". |
| `try`, `speed`, hours | Retries (attempts and interval), speed — the nearest tier below, working hours of one day; the campaign end is the end of the campaign day. |
| `delete`, `delete_phone_number` | The contact is **Suppressed** with the reason **Withdrawn at the client's request**. |
| A failure after the checks (request rollback) | The request's own campaign is cancelled, and batches in other campaigns are suppressed with the reason **Compatibility adapter request not accepted**. |

The campaign launch and added batches are signed with the adapter login.

> [!NOTE]
>
> **Campaigns live in the client's organization.** In their home organization, the root administrator sees only that organization's campaigns. Adapter campaigns are created in the account organization, so first switch to it with the organization switcher in the top left corner. The **Campaigns** link in the account row and the **Open the contact in the campaign** link in the call overview switch the organization by themselves.

## How to find an adapter campaign

**1. From the account**

The **Compatibility adapter** section → the **Accounts** tab → the **Campaigns** button in the account row. The cabinet switches the organization and opens the list of this account's campaigns with the **Account: \<login>** chip.

**2. From the campaign list**

In the client organization: the **Source** filter = **Compatibility adapter**. Or search by name: part of `cname`, the date or the script name. In the **Status** column, such campaigns have the **Compatibility adapter** badge; hovering shows the hint "login · system · script".

**3. By adapter contact ID**

The [History](https://docs.hubtalk.ai/v4/platform/campaign-history) section → **More filters** → the **Adapter contact ID** field (digits only, exact match) → open the call → the **Open the contact in the campaign** link in the overview. This finds only a contact that has already been dialed.

**4. On the campaign card**

The third search field in the **Campaign contacts** block finds a contact by adapter ID, including one not yet dialed.

![The Campaigns link in the account row](https://mintcdn.com/hubtalk/imXtUGq2OJsLMMCI/images/v4_adapter_accounts_campaigns_link_en.png?fit=max\&auto=format\&n=imXtUGq2OJsLMMCI\&q=85\&s=178c827129f24b69c65bf5278ba601a0)

1. **Campaigns**: switches the organization and opens the list of this account's campaigns.

![The account's campaigns after clicking the Campaigns button](https://mintcdn.com/hubtalk/imXtUGq2OJsLMMCI/images/v4_adapter_campaigns_by_account_en.png?fit=max\&auto=format\&n=imXtUGq2OJsLMMCI\&q=85\&s=2adc7017a3f5a00fa386232b3bf9f708)

The organization is already switched, and the source and account filters are set.

1. The **Source** filter: **Compatibility adapter** is already selected.
2. The **Account: login** chip; the cross removes the filter.
3. The **Compatibility adapter** badge in the status cell.
4. The organization is already switched to the account organization.

![All client campaigns with the adapter badge](https://mintcdn.com/hubtalk/imXtUGq2OJsLMMCI/images/v4_adapter_campaigns_sources_en.png?fit=max\&auto=format\&n=imXtUGq2OJsLMMCI\&q=85\&s=c6da99474c868e38d338cc18f2750683)

Campaigns of one agent from different sources. Only the adapter campaigns have the badge.

1. The **Source** filter: **All sources**, **Cabinet**, **API**, **Compatibility adapter**, **Not recorded**.
2. Only the adapter campaign has the badge; campaigns from the cabinet and the Web API do not.
3. Adapter campaign name: `cname` · date · start hour · (script).

## Campaign card

![Adapter campaign card header](https://mintcdn.com/hubtalk/imXtUGq2OJsLMMCI/images/v4_adapter_campaign_header_en.png?fit=max\&auto=format\&n=imXtUGq2OJsLMMCI\&q=85\&s=db448460173521bb6c1f411b679c7c49)

1. Subtitle: "Source: compatibility adapter · Account: login (system) · Registry script: name". There is no badge in the title — the attributes are in the subtitle.

* **Status and dates.** An adapter campaign launches immediately: **Running**, or **Scheduled** until the start hour. An empty queue does not end it; it is closed by the end of the campaign day or by cancellation. A completed or cancelled campaign with the same attributes cannot be revived before the end of the day: the client gets an internal error.
* **Dialing configuration "as launched".** Agent, classification, trunk, subgroup, caller ID, speed, retries, and working hours on the **Schedule** tab. This is a snapshot at launch time: editing the registry or the account does not change it.
* **Scheduler state.** Held for reasons, suppressed by policy (with reasons and contact counts), next attempt, speed. The reasons **Withdrawn at the client's request** and **Compatibility adapter request not accepted** are adapter withdrawals and rollbacks.
* **Permission attestation.** **Signed by**: \<V2 login> with the **organization user** mark — the signature by the adapter account. For batches — **Batch signature** in the upload report.
* **Upload history.** Each batch from a repeated request is a separate upload with its own report.

For the general layout of a campaign card, see [Campaigns](https://docs.hubtalk.ai/v4/platform/campaigns).


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