Compatibility adapter V2 → V4
The compatibility adapter accepts requests from clients of the old V2 platform in their original form and turns them into V4 campaigns. The client changes neither the request bodies nor how it parses responses: it sends the same JSON to its old address, and the current platform does the calling.Who this guide is for. V2 clients who keep sending API requests in V2 form, their integrators, and the platform staff who set up such clients and monitor their campaigns: root organization administrators and agent developers.
How it works
The V2 client keeps sending requests to its old address, and the platform routes them to the adapter. The client signs in with its V2 login and password, which are set up as an adapter account.- A
createrequest passes the same checks as in V2 and becomes a campaign in the account’s organization. One set of attributes “account, script, name, start hour, day, attempts” yields one campaign per day; further requests with the same attributes add batches of calls to it. deleteanddelete_phone_numberwithdraw contacts from the dialing campaign.detailsreturns the day’s calls export based on the report template.- Fields of a request row become agent variables according to the map in the compatibility registry.
What is set up before the first request
Before the client’s first request, a platform administrator sets up:- an adapter account — the client’s V2 login and password, the V4 organization where its campaigns will live, and dialing defaults for when a request does not pass a parameter. How to set it up: Adapter accounts;
- a compatibility registry — one row for each script name the client sends in
data[].type: which agent calls, which fields a request row carries, and how they reach the agent. How to build it: Compatibility registry.
Terms
The “in the logs” mark
Sometimes the reason for a rejection is visible only in the application log, not in the cabinet. In this guide such places are marked with the words “in the logs”. Platform engineers read the log: if you need such an investigation, give them the client’s login, the operation, and the request time. Everything that can be seen in the cabinet is described through the cabinet. What exactly is written to the log is covered in What is visible only in the logs.Sections
API for the V2 client
Address, request body, sign-in and limits, the
create, delete, details operations, differences from V2.Setup
Adapter accounts and the compatibility registry: setup, fields and variables, retry rules.
Monitoring
How to find an adapter campaign, its contacts, withdrawals, calls, and exports.
FAQ
What goes wrong: variables, an empty queue, hours, webhooks, sign-in.