NICE CXone
App · 25 actions
Run your NICE CXone contact centre from workflows: see agents, queues and contacts in real time, pull contact and performance reports, schedule callbacks and manage do-not-call lists, and start workflows when a contact ends or is abandoned or an agent's state changes.
Actions
| Action | What it does |
|---|---|
| Add number to DNC group | Add a phone number to a do-not-call group, so the outbound skills checked against it never dial it. |
| Delete scheduled callback | Cancel a scheduled callback that hasn't been made yet. |
| Get agent | Get one agent's profile: name, email, team, supervisor and status. |
| Get agent performance | Get each agent's contacts handled, refused and handle time for a period, or one agent's. The period is widened to whole quarter hours. |
| Get agent states | See what agents are doing right now: Available, Unavailable (and why), on a contact or logged out. |
| Get contact | Get one contact (a call, chat, email or other interaction), active or finished. |
| Get report job | Get a report job's state, and its result file's address once it has finished. |
| Get skill | Get one skill's settings: channel, campaign, outbound or not, and more. |
| Get skill activity | See each skill's queue right now: contacts waiting, agents available and working, and the service level. |
| Get skill summaries | Get each skill's totals for a period: contacts offered, handled and abandoned, handle time and service level. |
| List active contacts | List the contacts in progress right now (in the IVR, waiting in queue or with an agent), filtered by skill, agent, team or channel. |
| List agents | List your CXone agents with their team, supervisor and last login. |
| List agents on a skill | List the agents assigned to a skill, with their proficiency. |
| List completed contacts | List finished calls, chats, emails and other contacts that started in a period (the last 24 hours unless you say), with times, disposition and whether they were abandoned. |
| List dispositions | List dispositions, the outcomes agents give a contact such as Resolved or Call back. |
| List DNC groups | List your do-not-call groups and how many numbers each holds. |
| List reports | List the Custom Reporting reports you can run with 'Start report job'. |
| List scheduled callbacks | List the callbacks waiting on a skill, or on an agent. |
| List skills | List your skills, the queues contacts are routed through, with their channel and campaign. |
| List teams | List your CXone teams with how many agents each has. |
| Remove number from DNC group | Expire a phone number in a do-not-call group, so it can be dialled again. |
| Schedule callback | Schedule a callback to a customer on an outbound skill, for any agent on the skill or for one agent. |
| Search DNC groups for a number | Find which do-not-call groups hold a phone number. |
| Set agent state | Make a logged-in agent Available, or Unavailable with a reason such as Lunch or Training. |
| Start report job | Run a Custom Reporting report. |
Add number to DNC group
Add a phone number to a do-not-call group, so the outbound skills checked against it never dial it.
Inputs
- DNC group
dnc_group_idtextRequired - The do-not-call group. Pick one, or give its id.
- Phone number
phone_numbertextRequired - The phone number, with or without spaces and brackets.
- Expires
expires_ondate and time - When the number may be called again. Leave empty for never.
Outputs
dnc_group_idnumber- The group
formatted_phonetext- The number as CXone stored it
phone_numbertext- The number, as digits
Example output
{
"dnc_group_id": 31,
"formatted_phone": "8015550123",
"phone_number": "8015550123"
}Delete scheduled callback
Cancel a scheduled callback that hasn't been made yet.
Inputs
- Callback ID
callback_idtextRequired - The callback's id, from 'Schedule callback' or 'List scheduled callbacks'.
Outputs
callback_idnumber- The callback cancelled
deletedtrue/false- True once it is gone
Example output
{
"callback_id": 556677,
"deleted": true
}Get agent
Get one agent's profile: name, email, team, supervisor and status.
Inputs
- Agent
agent_idtextRequired - The agent. Pick one, or give their agent id.
Outputs
agentobject- The agent
Example output
{
"agent": {
"agentId": 30387543,
"createDate": "2025-02-01T16:00:00.000Z",
"emailAddress": "jo.bloggs@example.com",
"firstName": "Jo",
"isActive": true,
"isSupervisor": false,
"lastLogin": "2026-11-12T14:03:00.000Z",
"lastName": "Bloggs",
"location": "Salt Lake City",
"reportToName": "Sam Lee",
"teamId": 1234,
"teamName": "Support",
"timeZone": "Mountain Standard Time",
"userName": "jo.bloggs@example.com"
}
}Get agent performance
Get each agent's contacts handled, refused and handle time for a period, or one agent's. The period is widened to whole quarter hours.
Inputs
- From
start_datedate and timeRequired - The start of the period.
- Until
end_datedate and timeRequired - The end of the period, at most 30 days after the start.
- Agent
agent_idtext - The agent. Pick one, or give their agent id.
Outputs
agentslist- Each agent's performance
countnumber- How many came back
end_datetext- The end used
start_datetext- The start used
Example output
{
"agents": [
{
"agentId": 30387543,
"agentOffered": 41,
"inboundHandled": 38,
"loginTime": "PT7H45M",
"occupancy": 81.5,
"outboundHandled": 2,
"refused": 1,
"teamId": 1234,
"totalAvgHandleTime": "PT5M2S",
"totalHandled": 40
}
],
"count": 1,
"end_date": "2026-11-14T00:00:00Z",
"start_date": "2026-11-13T00:00:00Z"
}Get agent states
See what agents are doing right now: Available, Unavailable (and why), on a contact or logged out. For everyone, or one agent.
Inputs
- Agent
agent_idtext - The agent. Pick one, or give their agent id.
- Changed since
updated_sincedate and time - Only those that changed after this time.
- Page size
topnumber - How many to return, 1 to 1,000.From 1 to 1000.
- Skip
skipnumber - How many to skip before this page. Use the 'next_skip' an earlier run gave to read on.At least 0.
Outputs
agent_stateslist- Each agent's current state
countnumber- How many came back on this page
next_skipnumber- The Skip to ask for next, or 0 when there are no more
skipnumber- How many were skipped before this page
total_recordsnumber- How many CXone says there are in all
Example output
{
"agent_states": [
{
"agentId": 30387543,
"agentStateId": 2,
"agentStateName": "Unavailable",
"contactId": 0,
"firstName": "Jo",
"lastName": "Bloggs",
"lastUpdateTime": "2026-11-13T12:00:05.000Z",
"outStateDescription": "Lunch",
"outStateId": 12,
"skillName": "",
"startDate": "2026-11-13T12:00:05.000Z",
"teamId": 1234,
"teamName": "Support"
}
],
"count": 1,
"next_skip": 0,
"skip": 0,
"total_records": 1
}Get contact
Get one contact (a call, chat, email or other interaction), active or finished.
Inputs
- Contact ID
contact_idtextRequired - The contact's id, from a list step or a trigger.
Outputs
contactobject- The contact
Example output
{
"contact": {
"abandoned": false,
"acwSeconds": 18.6,
"agentId": 30387543,
"agentSeconds": 330.1,
"campaignName": "Support",
"contactId": 492837465,
"contactStartDate": "2026-11-13T15:04:11.000Z",
"dispositionNotes": "Reset the customer's password",
"endReason": "Contact Hung Up",
"firstName": "Alex",
"fromAddress": "8015550123",
"holdSeconds": 0,
"inQueueSeconds": 42.5,
"isOutbound": false,
"lastName": "Rivera",
"lastUpdateTime": "2026-11-13T15:10:42.000Z",
"masterContactId": 492837465,
"mediaTypeId": 4,
"mediaTypeName": "Phone Call",
"pointOfContactName": "Support line",
"primaryDispositionId": 77,
"skillId": 4354,
"skillName": "Support Phone",
"teamId": 1234,
"teamName": "Support",
"toAddress": "8005550100",
"totalDurationSeconds": 391.2
}
}Get report job
Get a report job's state, and its result file's address once it has finished.
Inputs
- Job ID
job_idtextRequired - The job's id, from 'Start report job' or a trigger.
Outputs
jobobject- The report job
Example output
{
"job": {
"deleteTime": "2026-11-14T15:21:10.000Z",
"fileName": "Daily contact detail_20261113.csv",
"jobEnd": "2026-11-13T15:21:10.000Z",
"jobId": 99120,
"jobStart": "2026-11-13T15:20:00.000Z",
"reportId": 1501,
"reportName": "Daily contact detail",
"resultFileURL": "https://api-na1.niceincontact.com/inContactAPI/services/v30.0/files?fileName=Daily%20contact%20detail_20261113.csv",
"state": "Finished"
}
}Get skill
Get one skill's settings: channel, campaign, outbound or not, and more.
Inputs
- Skill
skill_idtextRequired - The skill (queue). Pick one, or give its id.
Outputs
skillobject- The skill
Example output
{
"skill": {
"campaignId": 120,
"campaignName": "Support",
"isActive": true,
"isOutbound": false,
"mediaTypeId": 4,
"mediaTypeName": "Phone Call",
"notes": "Main support line",
"skillId": 4354,
"skillName": "Support Phone"
}
}Get skill activity
See each skill's queue right now: contacts waiting, agents available and working, and the service level. For every skill, or one.
Inputs
- Skill
skill_idtext - Only this skill (queue).
- Channel
media_typetext - Only this channel, such as phone calls or chat.One of:
4(Phone call),1(Email),3(Chat),5(Voicemail),6(Work item),7(SMS),8(Social),9(Digital),2(Fax). - Changed since
updated_sincedate and time - Only those that changed after this time.
Outputs
countnumber- How many came back
skillslist- Each skill's activity now
Example output
{
"count": 1,
"skills": [
{
"agentsAvailable": 2,
"agentsLoggedIn": 11,
"agentsUnavailable": 3,
"agentsWorking": 6,
"contactsActive": 9,
"earliestQueueTime": "2026-11-13T15:08:00.000Z",
"mediaTypeName": "Phone Call",
"queueCount": 3,
"serviceLevel": 87,
"skillId": 4354,
"skillName": "Support Phone"
}
]
}Get skill summaries
Get each skill's totals for a period: contacts offered, handled and abandoned, handle time and service level. For every skill, or one.
Inputs
- From
start_datedate and timeRequired - The start of the period.
- Until
end_datedate and timeRequired - The end of the period, at most 30 days after the start.
- Skill
skill_idtext - Only this skill (queue).
- Channel
media_typetext - Only this channel, such as phone calls or chat.One of:
4(Phone call),1(Email),3(Chat),5(Voicemail),6(Work item),7(SMS),8(Social),9(Digital),2(Fax).
Outputs
countnumber- How many came back
skillslist- Each skill's totals
Example output
{
"count": 1,
"skills": [
{
"abandonCount": 14,
"abandonRate": 3,
"averageHandleTime": "PT5M12S",
"averageSpeedToAnswer": "PT31S",
"contactsHandled": 398,
"contactsOffered": 412,
"mediaTypeName": "Phone Call",
"serviceLevel": 88,
"skillId": 4354,
"skillName": "Support Phone"
}
]
}List active contacts
List the contacts in progress right now (in the IVR, waiting in queue or with an agent), filtered by skill, agent, team or channel. Gets one page; to see more, run it again with the 'next_skip' it gives.
Inputs
- Skill
skill_idtext - Only this skill (queue).
- Agent
agent_idtext - Only this agent's.
- Team
teamtext - Only this team's.
- Channel
media_typetext - Only this channel, such as phone calls or chat.One of:
4(Phone call),1(Email),3(Chat),5(Voicemail),6(Work item),7(SMS),8(Social),9(Digital),2(Fax). - From
from_addresstext - Only contacts from this phone number, email address or chat address.
- To
to_addresstext - Only contacts to this number or address, such as your toll free number.
- Changed since
updated_sincedate and time - Only those that changed after this time.
- Page size
topnumber - How many to return, 1 to 1,000.From 1 to 1000.
- Skip
skipnumber - How many to skip before this page. Use the 'next_skip' an earlier run gave to read on.At least 0.
Outputs
contactslist- The contacts in progress
countnumber- How many came back on this page
next_skipnumber- The Skip to ask for next, or 0 when there are no more
skipnumber- How many were skipped before this page
total_recordsnumber- How many CXone says there are in all
Example output
{
"contacts": [
{
"agentId": 30387543,
"campaignName": "Support",
"contactId": 492837465,
"contactStartDate": "2026-11-13T15:04:11.000Z",
"contactStateCategory": "Agent",
"firstName": "Alex",
"fromAddress": "8015550123",
"isOutbound": false,
"lastName": "Rivera",
"lastUpdateTime": "2026-11-13T15:10:42.000Z",
"masterContactId": 492837465,
"mediaTypeId": 4,
"mediaTypeName": "Phone Call",
"pointOfContactName": "Support line",
"skillId": 4354,
"skillName": "Support Phone",
"stateName": "Active",
"teamId": 1234,
"teamName": "Support",
"toAddress": "8005550100"
}
],
"count": 1,
"next_skip": 0,
"skip": 0,
"total_records": 1
}List agents
List your CXone agents with their team, supervisor and last login. Gets one page; to see more, run it again with the 'next_skip' it gives.
Inputs
- Status
statustext - Only active or only inactive ones. Leave empty for both.One of:
active(Active only),inactive(Inactive only). - Search
searchtext - Only those whose name or id contains this.
- Changed since
updated_sincedate and time - Only those that changed after this time.
- Page size
topnumber - How many to return, 1 to 100.From 1 to 100.
- Skip
skipnumber - How many to skip before this page. Use the 'next_skip' an earlier run gave to read on.At least 0.
Outputs
agentslist- The agents
countnumber- How many came back on this page
next_skipnumber- The Skip to ask for next, or 0 when there are no more
skipnumber- How many were skipped before this page
total_recordsnumber- How many CXone says there are in all
Example output
{
"agents": [
{
"agentId": 30387543,
"createDate": "2025-02-01T16:00:00.000Z",
"emailAddress": "jo.bloggs@example.com",
"firstName": "Jo",
"isActive": true,
"isSupervisor": false,
"lastLogin": "2026-11-12T14:03:00.000Z",
"lastName": "Bloggs",
"location": "Salt Lake City",
"reportToName": "Sam Lee",
"teamId": 1234,
"teamName": "Support",
"timeZone": "Mountain Standard Time",
"userName": "jo.bloggs@example.com"
}
],
"count": 1,
"next_skip": 0,
"skip": 0,
"total_records": 1
}List agents on a skill
List the agents assigned to a skill, with their proficiency. Gets one page; to see more, run it again with the 'next_skip' it gives.
Inputs
- Skill
skill_idtextRequired - The skill (queue). Pick one, or give its id.
- Search
searchtext - Only those whose name or id contains this.
- Page size
topnumber - How many to return, 1 to 100.From 1 to 100.
- Skip
skipnumber - How many to skip before this page. Use the 'next_skip' an earlier run gave to read on.At least 0.
Outputs
agentslist- The agents on the skill
countnumber- How many came back on this page
next_skipnumber- The Skip to ask for next, or 0 when there are no more
skipnumber- How many were skipped before this page
total_recordsnumber- How many CXone says there are in all
Example output
{
"agents": [
{
"agentId": 30387543,
"agentProficiencyName": "High",
"agentProficiencyValue": 1,
"firstName": "Jo",
"isActive": true,
"isSkillActive": true,
"lastName": "Bloggs",
"lastUpdateTime": "2026-10-01T09:00:00.000Z"
}
],
"count": 1,
"next_skip": 0,
"skip": 0,
"total_records": 1
}List completed contacts
List finished calls, chats, emails and other contacts that started in a period (the last 24 hours unless you say), with times, disposition and whether they were abandoned. Gets one page; to see more, run it again with the 'next_skip' it gives.
Inputs
- From
start_datedate and time - Contacts that started at or after this time.
- Until
end_datedate and time - Contacts that started before this time, at most 31 days after From.
- Skill
skill_idtext - Only this skill (queue).
- Agent
agent_idtext - Only this agent's.
- Team
teamtext - Only this team's.
- Channel
media_typetext - Only this channel, such as phone calls or chat.One of:
4(Phone call),1(Email),3(Chat),5(Voicemail),6(Work item),7(SMS),8(Social),9(Digital),2(Fax). - From
from_addresstext - Only contacts from this phone number, email address or chat address.
- To
to_addresstext - Only contacts to this number or address, such as your toll free number.
- Page size
topnumber - How many to return, 1 to 1,000.From 1 to 1000.
- Skip
skipnumber - How many to skip before this page. Use the 'next_skip' an earlier run gave to read on.At least 0.
- Changed since
updated_sincedate and time - Instead of From and Until: contacts that changed after this time.
Outputs
contactslist- The completed contacts
countnumber- How many came back on this page
next_skipnumber- The Skip to ask for next, or 0 when there are no more
skipnumber- How many were skipped before this page
total_recordsnumber- How many CXone says there are in all
Example output
{
"contacts": [
{
"abandoned": false,
"acwSeconds": 18.6,
"agentId": 30387543,
"agentSeconds": 330.1,
"campaignName": "Support",
"contactId": 492837465,
"contactStartDate": "2026-11-13T15:04:11.000Z",
"dispositionNotes": "Reset the customer's password",
"endReason": "Contact Hung Up",
"firstName": "Alex",
"fromAddress": "8015550123",
"holdSeconds": 0,
"inQueueSeconds": 42.5,
"isOutbound": false,
"lastName": "Rivera",
"lastUpdateTime": "2026-11-13T15:10:42.000Z",
"masterContactId": 492837465,
"mediaTypeId": 4,
"mediaTypeName": "Phone Call",
"pointOfContactName": "Support line",
"primaryDispositionId": 77,
"skillId": 4354,
"skillName": "Support Phone",
"teamId": 1234,
"teamName": "Support",
"toAddress": "8005550100",
"totalDurationSeconds": 391.2
}
],
"count": 1,
"next_skip": 0,
"skip": 0,
"total_records": 1
}List dispositions
List dispositions, the outcomes agents give a contact such as Resolved or Call back. Gets one page; to see more, run it again with the 'next_skip' it gives.
Inputs
- Status
statustext - Only active or only inactive ones. Leave empty for both.One of:
active(Active only),inactive(Inactive only). - Search
searchtext - Only those whose name or id contains this.
- Page size
topnumber - How many to return, 1 to 100.From 1 to 100.
- Skip
skipnumber - How many to skip before this page. Use the 'next_skip' an earlier run gave to read on.At least 0.
Outputs
countnumber- How many came back on this page
dispositionslist- The dispositions
next_skipnumber- The Skip to ask for next, or 0 when there are no more
skipnumber- How many were skipped before this page
total_recordsnumber- How many CXone says there are in all
Example output
{
"count": 1,
"dispositions": [
{
"classificationId": 1,
"dispositionId": 77,
"dispositionName": "Resolved",
"isActive": true,
"lastUpdated": "2026-09-14T10:00:00.000Z",
"notes": "Issue fixed on the call"
}
],
"next_skip": 0,
"skip": 0,
"total_records": 1
}List DNC groups
List your do-not-call groups and how many numbers each holds.
Inputs
None.
Outputs
countnumber- How many came back
dnc_groupslist- The DNC groups
Example output
{
"count": 1,
"dnc_groups": [
{
"dncGroupDescription": "People who asked not to be called",
"dncGroupId": 31,
"dncGroupName": "Customer requests",
"isActive": true,
"lastUpdateTime": "2026-11-12T08:00:00.000Z",
"validRecords": 2210
}
]
}List reports
List the Custom Reporting reports you can run with 'Start report job'.
Inputs
None.
Outputs
countnumber- How many came back
reportslist- The reports
Example output
{
"count": 1,
"reports": [
{
"reportDescription": "Every contact of the day with its disposition",
"reportId": 1501,
"reportName": "Daily contact detail",
"reportType": "Public"
}
]
}List scheduled callbacks
List the callbacks waiting on a skill, or on an agent. Give one of the two.
Inputs
- Skill
skill_idtext - The skill's callbacks. Leave empty to give an agent instead.
- Agent
agent_idtext - The agent's callbacks. Leave empty to give a skill instead.
Outputs
callbackslist- The scheduled callbacks
countnumber- How many came back
Example output
{
"callbacks": [
{
"agentId": 30387543,
"callbackId": 556677,
"callbackTime": "2026-11-14T16:00:00.000Z",
"dialNumber": "8015550123",
"firstName": "Alex",
"lastName": "Rivera",
"notes": "Wants an update on order 1042",
"skillId": 4400,
"target": "S"
}
],
"count": 1
}List skills
List your skills, the queues contacts are routed through, with their channel and campaign. Gets one page; to see more, run it again with the 'next_skip' it gives.
Inputs
- Channel
media_typetext - Only this channel, such as phone calls or chat.One of:
4(Phone call),1(Email),3(Chat),5(Voicemail),6(Work item),7(SMS),8(Social),9(Digital),2(Fax). - Status
statustext - Only active or only inactive ones. Leave empty for both.One of:
active(Active only),inactive(Inactive only). - Search
searchtext - Only those whose name or id contains this.
- Page size
topnumber - How many to return, 1 to 100.From 1 to 100.
- Skip
skipnumber - How many to skip before this page. Use the 'next_skip' an earlier run gave to read on.At least 0.
Outputs
countnumber- How many came back on this page
next_skipnumber- The Skip to ask for next, or 0 when there are no more
skillslist- The skills
skipnumber- How many were skipped before this page
total_recordsnumber- How many CXone says there are in all
Example output
{
"count": 1,
"next_skip": 0,
"skills": [
{
"campaignId": 120,
"campaignName": "Support",
"isActive": true,
"isOutbound": false,
"mediaTypeId": 4,
"mediaTypeName": "Phone Call",
"notes": "Main support line",
"skillId": 4354,
"skillName": "Support Phone"
}
],
"skip": 0,
"total_records": 1
}List teams
List your CXone teams with how many agents each has. Gets one page; to see more, run it again with the 'next_skip' it gives.
Inputs
- Status
statustext - Only active or only inactive ones. Leave empty for both.One of:
active(Active only),inactive(Inactive only). - Search
searchtext - Only those whose name or id contains this.
- Page size
topnumber - How many to return, 1 to 100.From 1 to 100.
- Skip
skipnumber - How many to skip before this page. Use the 'next_skip' an earlier run gave to read on.At least 0.
Outputs
countnumber- How many came back on this page
next_skipnumber- The Skip to ask for next, or 0 when there are no more
skipnumber- How many were skipped before this page
teamslist- The teams
total_recordsnumber- How many CXone says there are in all
Example output
{
"count": 1,
"next_skip": 0,
"skip": 0,
"teams": [
{
"agentCount": 12,
"description": "Tier 1 support",
"isActive": true,
"lastUpdateTime": "2026-10-01T09:00:00.000Z",
"teamId": 1234,
"teamName": "Support"
}
],
"total_records": 1
}Remove number from DNC group
Expire a phone number in a do-not-call group, so it can be dialled again. CXone deletes it from the group 7 days later.
Inputs
- DNC group
dnc_group_idtextRequired - The do-not-call group. Pick one, or give its id.
- Phone number
phone_numbertextRequired - The phone number, with or without spaces and brackets.
Outputs
dnc_group_idnumber- The group
formatted_phonetext- The number as CXone stored it
phone_numbertext- The number, as digits
Example output
{
"dnc_group_id": 31,
"formatted_phone": "8015550123",
"phone_number": "8015550123"
}Schedule callback
Schedule a callback to a customer on an outbound skill, for any agent on the skill or for one agent. CXone offers it when it's due.
Inputs
- Outbound skill
skill_idtextRequired - The outbound skill to call from. Pick one, or give its id.
- Phone number
phone_numbertextRequired - The phone number, with or without spaces and brackets.
- When
schedule_datedate and timeRequired - When to call back.
- First name
first_nametext - The customer's first name.
- Last name
last_nametext - The customer's last name.
- Agent
agent_idtext - Only this agent gets the callback. Leave empty for the whole skill.
- Notes
notestext - Notes the agent sees, such as why to call.
Outputs
callback_idnumber- The callback's id
phone_numbertext- The number, as digits
schedule_datetext- When it is due
skill_idnumber- The skill it is on
Example output
{
"callback_id": 556677,
"phone_number": "8015550123",
"schedule_date": "2026-11-14T16:00:00Z",
"skill_id": 4400
}Search DNC groups for a number
Find which do-not-call groups hold a phone number.
Inputs
- Phone number
phone_numbertextRequired - The phone number, with or without spaces and brackets.
Outputs
countnumber- How many groups hold it
groupslist- The groups holding it
on_dnctrue/false- True if any group holds it
phone_numbertext- The number, as digits
Example output
{
"count": 1,
"groups": [
{
"dateCollected": "2026-11-12T08:00:00.000Z",
"dncGroupId": 31,
"dncGroupName": "Customer requests",
"expiredDate": "",
"formattedPhone": "8015550123"
}
],
"on_dnc": true,
"phone_number": "8015550123"
}Set agent state
Make a logged-in agent Available, or Unavailable with a reason such as Lunch or Training. The agent must be logged in.
Inputs
- Agent
agent_idtextRequired - The agent. Pick one, or give their agent id.
- State
statetextRequired - Available, or Unavailable.One of:
Available,Unavailable. - Unavailable reason
unavailable_codetext - For Unavailable only: the reason, such as Lunch. Leave empty for none.
Outputs
agent_idnumber- The agent's id
settrue/false- True once CXone took it
statetext- The state set
unavailable_codenumber- The unavailable reason's id, or 0 for none
Example output
{
"agent_id": 30387543,
"set": true,
"state": "Unavailable",
"unavailable_code": 12
}Start report job
Run a Custom Reporting report. It runs in the background: follow it with 'Get report job', which gives the file's address once it's done.
Inputs
- Report
report_idtextRequired - The report. Pick one, or give its id.
- File type
file_typetext - The result file's format. Defaults to the report's own.One of:
CSV,Excel,PDF,XML. - Include headers
include_headerstrue/false - Add a header row to the file.
- Add date to file name
append_datetrue/false - Put the date in the file's name.
- Overwrite
overwritetrue/false - Replace a file of the same name. CXone does this unless turned off.
- Keep for days
delete_afternumber - How many days CXone keeps the result file.From 1 to 365.
Outputs
job_idnumber- The job's id, for 'Get report job'
report_idnumber- The report run
Example output
{
"job_id": 99120,
"report_id": 1501
}