Nextiva
App · 20 actions
Read contact center conversations and workitems, send messages, and control active calls.
Actions
| Action | What it does |
|---|---|
| Change workitem priority | Change the priority of a workitem. |
| Fetch conversation by ID | Fetch a conversation by ID, including its associated workitems. |
| Fetch conversation history by participant ID | Fetch conversation history by participant ID. |
| Fetch conversation work items by status | Fetch workitems within a conversation by their status. |
| Fetch conversations | Fetch all conversations. |
| Fetch recent conversation workitem engagements | Fetch recent conversation workitem engagements. |
| Fetch ticket conversations | Fetch conversations associated with a ticket. |
| Fetch transcriptions and recordings | Fetch transcriptions and recordings for a specific workitem within a conversation. |
| Fetch unread counts | Fetch unread conversation counts. |
| Fetch workitem by ID | Fetch a specific workitem by ID. |
| Fetch workitems | Fetch all workitems. |
| Hang up workitem call | Ends a call. |
| Hold workitem call | Puts a call on hold. |
| Mute workitem call | Mutes a call. |
| Send dtmf tones | Sends DTMF tones during a call. |
| Send email response | Sends an email response for a workitem. |
| Send sms message | Send an outbound SMS message. |
| Transfer workitem to agent | Transfers a workitem to another agent. |
| Transfer workitem to inbox | Transfers a workitem to an inbox/queue. |
| Unmute call | Unmute an active contact center call. |
Change workitem priority
Change the priority of a workitem.
Inputs
- Workitem ID
workitemIdtextRequired - Unique identifier of the workitem.
- Priority
prioritynumberRequired - Priority level of a workitem (1-5, 5 being highest).One of:
1,2,3,4,5.
Outputs
dataobject- Nextiva response data.
Example output
{
"data": {}
}Fetch conversation by ID
Fetch a conversation by ID, including its associated workitems.
Inputs
- Conversation ID
conversationIdtextRequired - Unique identifier of the conversation.
- Cursor
cursornumber - Cursor for pagination (for v2).
- Include call recordings
includeCallRecordingstrue/false - Whether to include call recordings.
- Include conversation
includeConversationtrue/false - Whether to include conversation details.
- Include parent engagement
includeParentEngagementtrue/false - Whether to include parent engagement details.
- Include summary
includeSummarytrue/false - Whether to include a summary.
- Include voicemail
includeVoicemailtrue/false - Whether to include voicemail.
- Limit
limitnumber - Number of items per page (for v2).
- Mentioned
mentionedtrue/false - Filter messages that mention the logged user.
- Rows
rowsnumber - Number of items per page (for v1).
- Start
startnumber - Pagination starting index (for v1).
- Version
versiontext - API version to use.One of:
v1,v2. - Workitem ID
workitemIdtext - Filter by workitem ID.
Outputs
dataobject- Nextiva response data.
Example output
{
"data": {
"count": 1,
"engagementData": [],
"objects": [],
"total": 1
}
}Fetch conversation history by participant ID
Fetch conversation history by participant ID.
Inputs
- Page number
pageNumbernumber - Page number for pagination.
- Page size
pageSizenumber - Number of items per page.
- Participant IDs
participantIdslist - IDs of the participants to filter by.
Outputs
dataobject- Nextiva response data.
Example output
{
"data": {
"count": 1,
"objects": [],
"total": 1
}
}Fetch conversation work items by status
Fetch workitems within a conversation by their status.
Inputs
- Conversation ID
conversationIdtextRequired - Unique identifier of the conversation.
- Work item status
workItemStatustextRequired - Status of the workitems to filter by (e.g., 'draft').
- Rows
rowsnumber - Number of items per page.
- Start
startnumber - Pagination starting index.
Outputs
dataobject- Nextiva response data.
Example output
{
"data": {
"count": 1,
"objects": [],
"total": 1
}
}Fetch conversations
Fetch all conversations.
Inputs
- Rows
rowsnumber - Number of items per page.
- Start
startnumber - Pagination starting index.
Outputs
dataobject- Nextiva response data.
Example output
{
"data": {
"count": 1,
"objects": [],
"total": 1
}
}Fetch recent conversation workitem engagements
Fetch recent conversation workitem engagements.
Inputs
- Cursor
cursornumber - Cursor for pagination.
- Filter
filtertext - Filter type for conversations.One of:
ALL,ARCHIVED,CALLS,CALLS_AND_TEXTS(Calls and texts),CHANNELS,DRAFTS,EXTERNAL,INCOMING_CALLS(Incoming calls),INTERNAL,MENTIONS, and 5 more. - Ignore voicemail transcripts
ignoreVoicemailTranscriptstrue/false - Whether to ignore voicemail transcripts.
- Limit
limitnumber - Number of items per page.
- Tab
tabtext - Tab filter for conversations.One of:
ALL,ARCHIVED,CALLS,CALLS_AND_TEXTS(Calls and texts),CHANNELS,DRAFTS,EXTERNAL,INCOMING_CALLS(Incoming calls),INTERNAL,MENTIONS, and 5 more.
Outputs
dataobject- Nextiva response data.
Example output
{
"data": {
"count": 1,
"objects": [],
"total": 1
}
}Fetch ticket conversations
Fetch conversations associated with a ticket.
Inputs
- Ticket ID
ticketIdtextRequired - Unique identifier of the ticket.
Outputs
dataobject- Nextiva response data.
Example output
{
"data": {
"count": 1,
"objects": [],
"total": 1
}
}Fetch transcriptions and recordings
Fetch transcriptions and recordings for a specific workitem within a conversation.
Inputs
- Conversation ID
conversationIdtextRequired - Unique identifier of the conversation.
- Workitem ID
workitemIdtextRequired - Unique identifier of the workitem.
- Created at
createdAtdate and time - When the interaction was created.
Outputs
dataobject- Nextiva response data.
Example output
{
"data": {
"count": 1,
"objects": [],
"total": 1
}
}Fetch unread counts
Fetch unread conversation counts.
Inputs
None.
Outputs
dataobject- Nextiva response data.
Example output
{
"data": {
"internal": 1,
"mentions": 1,
"total": 1,
"voicecalls": 1,
"voicemails": 1
}
}Fetch workitem by ID
Fetch a specific workitem by ID.
Inputs
- Id
idtextRequired - Unique identifier of the workitem.
Outputs
dataobject- Nextiva response data.
Example output
{
"data": {
"_id": "example",
"agentUsername": "example",
"channelType": "example",
"createdAt": 1,
"modifiedAt": 1,
"priority": 1,
"state": "example",
"type": "example",
"workitemId": "example"
}
}Fetch workitems
Fetch all workitems.
Inputs
- Q
qtext - Query string for filtering workitems.
- Rows
rowsnumber - Number of items per page.
- Start
startnumber - Pagination starting index.
Outputs
dataobject- Nextiva response data.
Example output
{
"data": {
"count": 1,
"objects": [],
"total": 1
}
}Hang up workitem call
Ends a call.
Inputs
- Workitem ID
workitemIdtextRequired - Unique identifier of the workitem (call) to hang up.
Outputs
dataobject- Nextiva response data.
Example output
{
"data": {
"_id": "example",
"agentUsername": "example",
"channelType": "example",
"createdAt": 1,
"modifiedAt": 1,
"priority": 1,
"state": "example",
"type": "example",
"workitemId": "example"
}
}Hold workitem call
Puts a call on hold.
Inputs
- Workitem ID
workitemIdtextRequired - Unique identifier of the workitem (call) to put on hold.
Outputs
dataobject- Nextiva response data.
Example output
{
"data": {
"_id": "example",
"agentUsername": "example",
"channelType": "example",
"createdAt": 1,
"modifiedAt": 1,
"priority": 1,
"state": "example",
"type": "example",
"workitemId": "example"
}
}Mute workitem call
Mutes a call.
Inputs
- Workitem ID
workitemIdtextRequired - Unique identifier of the workitem (call) to mute.
Outputs
dataobject- Nextiva response data.
Example output
{
"data": {
"_id": "example",
"agentUsername": "example",
"channelType": "example",
"createdAt": 1,
"modifiedAt": 1,
"priority": 1,
"state": "example",
"type": "example",
"workitemId": "example"
}
}Send dtmf tones
Sends DTMF tones during a call.
Inputs
- Workitem ID
workitemIdtextRequired - Unique identifier of the workitem (call) to send DTMF tones to.
- Digit
digittextRequired - The DTMF digit(s) to send.
Outputs
dataobject- Nextiva response data.
Example output
{
"data": {
"_id": "example",
"agentUsername": "example",
"channelType": "example",
"createdAt": 1,
"modifiedAt": 1,
"priority": 1,
"state": "example",
"type": "example",
"workitemId": "example"
}
}Send email response
Sends an email response for a workitem.
Inputs
- Workitem ID
workitemIdtextRequired - Unique identifier of the workitem associated with the email.
- Bcc addresses
bccAddresseslist - Email addresses to BCC.
- Body parts
bodyPartsobject - Body parts of the email.
- Cc addresses
ccAddresseslist - Email addresses to CC.
- Created at
createdAtdate and time - When the interaction was created.
- From
sendertextRequired - Sender's email address.
- Subject
subjecttextRequired - Email subject.
- To
totextRequired - Recipient's email address.
- To addresses
toAddresseslist - List of recipient email addresses.
Outputs
dataobject- Nextiva response data.
Example output
{
"data": {
"_id": "example",
"agentUsername": "example",
"channelType": "example",
"createdAt": 1,
"modifiedAt": 1,
"priority": 1,
"state": "example",
"type": "example",
"workitemId": "example"
}
}Send sms message
Send an outbound SMS message.
Inputs
- Campaign ID
campaignIdtext - The ID of the campaign for which the SMS message is being sent. If not provided, the user's default SMS campaign ID will be used.
- Contact ID
contactIdtext - The unique identifier of the contact to whom the SMS message will be sent.
- From
sendertext - The sender's number or identifier.
- Message
messagetextRequired - The content of the SMS message to be sent.
- To
totextRequired - The phone number or contact to which the SMS message will be sent.
- Workitem ID
workitemIdtext - The ID associated with a specific work item for tracking purposes.
Outputs
dataobject- Nextiva response data.
Example output
{
"data": {
"canDial": false,
"consentType": 1
}
}Transfer workitem to agent
Transfers a workitem to another agent.
Inputs
- Workitem ID
workitemIdtextRequired - Unique identifier of the workitem to transfer.
- User ID
userIdtextRequired - Unique identifier of the target agent.
- Event name
eventNametext - Name given to the transfer event.
- Recording
recordingtext - Recording options for transfers.One of:
keepCurrent,startRecording,stopRecording. - Survey
surveyobject - Survey data.
Outputs
dataobject- Nextiva response data.
Example output
{
"data": {}
}Transfer workitem to inbox
Transfers a workitem to an inbox/queue.
Inputs
- Workitem ID
workitemIdtextRequired - Unique identifier of the workitem to transfer.
- Inbox ID
inboxIdtextRequired - Unique identifier of the target inbox/queue.
- Event name
eventNametext - Name given to the transfer event.
- Recording
recordingtext - Recording options for transfers.One of:
keepCurrent,startRecording,stopRecording. - Ring all
ringAlltrue/false - Whether to ring all agents in the inbox.
- Survey
surveyobject - Survey data.
Outputs
dataobject- Nextiva response data.
Example output
{
"data": {}
}Unmute call
Unmute an active contact center call.
Inputs
- Workitem ID
workitemIdtextRequired - The workitem ID of the active call.
Outputs
dataobject- Nextiva response data.
Example output
{
"data": {
"_id": "example",
"agentUsername": "example",
"channelType": "example",
"createdAt": 1,
"modifiedAt": 1,
"priority": 1,
"state": "example",
"type": "example",
"workitemId": "example"
}
}