Get Assigned Users
Fetch the user-lead mapping for a specific lead within a campaign. Returns which agents are assigned and unassigned, useful for managing agent workload distribution.
Endpoint​
GET https://{Cms_Domain_Name}:{port}/cms/configuration/cc/{contactCenterId}/process/{processId}/campaign/{campaignId}/lead-user
Authentication​
| Header | Value |
|---|---|
Content-Type | application/json |
Accept | application/json |
Authorization | Basic {AuthToken} |
note
This endpoint uses Basic authentication (Base64-encoded username:password).
Path Parameters​
| Parameter | Type | Required | Description |
|---|---|---|---|
contactCenterId | Integer | Yes | Contact center ID |
processId | Integer | Yes | Process ID |
campaignId | Integer | Yes | Campaign ID |
Query Parameters​
| Parameter | Type | Required | Description |
|---|---|---|---|
leadId | Integer | Yes | Lead identifier to look up assignments for |
limit | Integer | Yes | Number of records to fetch |
offset | Integer | Yes | Pagination offset |
Sample Request​
curl -X 'GET' \
'https://{Cms_Domain_Name}:{port}/cms/configuration/cc/1/process/1/campaign/1/lead-user?leadId=2&limit=100&offset=0' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic {AuthToken}'
Sample Response​
{
"campaignLeadId": 1,
"assignedCampaignUserIds": [1],
"unassignedCampaignUserIds": [3817, 3802],
"leadId": 2,
"campaignId": 1,
"assignedUserIds": ["anav_agent"],
"unassignedUserIds": ["madhur1", "exe_gs"]
}
Response Fields​
| Field | Type | Description |
|---|---|---|
campaignLeadId | Integer | Campaign-lead mapping ID |
assignedCampaignUserIds | Array<Integer> | Internal IDs of currently assigned campaign users |
unassignedCampaignUserIds | Array<Integer> | Internal IDs of unassigned campaign users |
leadId | Integer | Lead identifier |
campaignId | Integer | Campaign identifier |
assignedUserIds | Array<String> | User IDs (usernames) of assigned agents |
unassignedUserIds | Array<String> | User IDs (usernames) of unassigned agents |
Related Endpoints​
- Assign/Unassign Users to Lead — Modify user-lead assignments
- Get Campaign Leads — List all leads in a campaign
- Get All Campaigns — List all campaigns
Error Responses​
| Status Code | Description |
|---|---|
| 400 | Bad Request — Missing required query parameters |
| 401 | Unauthorized — Missing or invalid credentials |
| 403 | Forbidden — Insufficient permissions |
| 404 | Not Found — Lead, campaign, or process does not exist |
| 500 | Internal Server Error |
{
"statusCode": 404,
"status": "Not Found",
"errorCode": "CONF-1001",
"errorMessage": "Object doesn't exist"
}