Click2CallAddAgent¶
POST click2call/agent
Links a CRM manager to their line at the provider. This is what makes an INDIVIDUAL
profile work: the module needs to know which extension, SIP account, or number belongs to
the manager who pressed the call button.
externalIdentifier is the provider-side identifier, not a CRM value — an extension
(1042), a SIP login, or a phone number, depending on the provider.
Access Control¶
Allowed role: admin. The link belongs to the brand of the caller.
Request¶
POST https://{broker_domain}/click2call/agent
{
"managerId": 10,
"profileId": 4,
"status": "ENABLED",
"externalIdentifier": "1042"
}
{
"command": "Click2CallAddAgent",
"extID": "1",
"data": {
"managerId": 10,
"profileId": 4,
"status": "ENABLED",
"externalIdentifier": "1042"
}
}
const res = await platform.Click2CallAddAgent({
managerId: 10,
profileId: 4,
status: "ENABLED",
externalIdentifier: "1042"
});
Request Data¶
| Field | Type | Required | Description |
|---|---|---|---|
managerId |
int | Yes | CRM manager id |
profileId |
int | Yes | Provider profile the link belongs to. The profile must be INDIVIDUAL |
status |
enum | Yes | ENABLED or DISABLED |
externalIdentifier |
string | Yes | Manager identifier at the provider: extension, SIP login, or number |
Behavior¶
- A
COMMONprofile is rejected: it dials from the credentials of the profile, so a per-manager line there would be silently ignored. - One manager has at most one link per profile. A previously deleted link is restored rather than duplicated — the pair is unique in storage.
Response Data¶
{
"id": 12,
"brand": "default",
"managerId": 10,
"profileId": 4,
"externalIdentifier": "1042",
"status": "ENABLED",
"createdAt": "2026-08-24 13:10:02"
}
Errors¶
| Code | Error | Description |
|---|---|---|
400 |
PROFILE_MODE_MISMATCH |
The profile does not use per-manager lines |
404 |
PROFILE_NOT_FOUND |
Profile not found in the brand |
409 |
AGENT_EXISTS |
This manager is already linked to this profile |