Nextiva

App · 20 actions

Read contact center conversations and workitems, send messages, and control active calls.

Actions

ActionWhat it does
Change workitem priorityChange the priority of a workitem.
Fetch conversation by IDFetch a conversation by ID, including its associated workitems.
Fetch conversation history by participant IDFetch conversation history by participant ID.
Fetch conversation work items by statusFetch workitems within a conversation by their status.
Fetch conversationsFetch all conversations.
Fetch recent conversation workitem engagementsFetch recent conversation workitem engagements.
Fetch ticket conversationsFetch conversations associated with a ticket.
Fetch transcriptions and recordingsFetch transcriptions and recordings for a specific workitem within a conversation.
Fetch unread countsFetch unread conversation counts.
Fetch workitem by IDFetch a specific workitem by ID.
Fetch workitemsFetch all workitems.
Hang up workitem callEnds a call.
Hold workitem callPuts a call on hold.
Mute workitem callMutes a call.
Send dtmf tonesSends DTMF tones during a call.
Send email responseSends an email response for a workitem.
Send sms messageSend an outbound SMS message.
Transfer workitem to agentTransfers a workitem to another agent.
Transfer workitem to inboxTransfers a workitem to an inbox/queue.
Unmute callUnmute an active contact center call.

Change workitem priority

Change the priority of a workitem.

Inputs

Workitem IDworkitemIdtextRequired
Unique identifier of the workitem.
PriorityprioritynumberRequired
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 IDconversationIdtextRequired
Unique identifier of the conversation.
Cursorcursornumber
Cursor for pagination (for v2).
Include call recordingsincludeCallRecordingstrue/false
Whether to include call recordings.
Include conversationincludeConversationtrue/false
Whether to include conversation details.
Include parent engagementincludeParentEngagementtrue/false
Whether to include parent engagement details.
Include summaryincludeSummarytrue/false
Whether to include a summary.
Include voicemailincludeVoicemailtrue/false
Whether to include voicemail.
Limitlimitnumber
Number of items per page (for v2).
Mentionedmentionedtrue/false
Filter messages that mention the logged user.
Rowsrowsnumber
Number of items per page (for v1).
Startstartnumber
Pagination starting index (for v1).
Versionversiontext
API version to use.One of: v1, v2.
Workitem IDworkitemIdtext
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 numberpageNumbernumber
Page number for pagination.
Page sizepageSizenumber
Number of items per page.
Participant IDsparticipantIdslist
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 IDconversationIdtextRequired
Unique identifier of the conversation.
Work item statusworkItemStatustextRequired
Status of the workitems to filter by (e.g., 'draft').
Rowsrowsnumber
Number of items per page.
Startstartnumber
Pagination starting index.

Outputs

dataobject
Nextiva response data.
Example output
{
  "data": {
    "count": 1,
    "objects": [],
    "total": 1
  }
}

Fetch conversations

Fetch all conversations.

Inputs

Rowsrowsnumber
Number of items per page.
Startstartnumber
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

Cursorcursornumber
Cursor for pagination.
Filterfiltertext
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 transcriptsignoreVoicemailTranscriptstrue/false
Whether to ignore voicemail transcripts.
Limitlimitnumber
Number of items per page.
Tabtabtext
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 IDticketIdtextRequired
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 IDconversationIdtextRequired
Unique identifier of the conversation.
Workitem IDworkitemIdtextRequired
Unique identifier of the workitem.
Created atcreatedAtdate 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

IdidtextRequired
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

Qqtext
Query string for filtering workitems.
Rowsrowsnumber
Number of items per page.
Startstartnumber
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 IDworkitemIdtextRequired
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 IDworkitemIdtextRequired
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 IDworkitemIdtextRequired
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 IDworkitemIdtextRequired
Unique identifier of the workitem (call) to send DTMF tones to.
DigitdigittextRequired
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 IDworkitemIdtextRequired
Unique identifier of the workitem associated with the email.
Bcc addressesbccAddresseslist
Email addresses to BCC.
Body partsbodyPartsobject
Body parts of the email.
Cc addressesccAddresseslist
Email addresses to CC.
Created atcreatedAtdate and time
When the interaction was created.
FromsendertextRequired
Sender's email address.
SubjectsubjecttextRequired
Email subject.
TototextRequired
Recipient's email address.
To addressestoAddresseslist
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 IDcampaignIdtext
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 IDcontactIdtext
The unique identifier of the contact to whom the SMS message will be sent.
Fromsendertext
The sender's number or identifier.
MessagemessagetextRequired
The content of the SMS message to be sent.
TototextRequired
The phone number or contact to which the SMS message will be sent.
Workitem IDworkitemIdtext
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 IDworkitemIdtextRequired
Unique identifier of the workitem to transfer.
User IDuserIdtextRequired
Unique identifier of the target agent.
Event nameeventNametext
Name given to the transfer event.
Recordingrecordingtext
Recording options for transfers.One of: keepCurrent, startRecording, stopRecording.
Surveysurveyobject
Survey data.

Outputs

dataobject
Nextiva response data.
Example output
{
  "data": {}
}

Transfer workitem to inbox

Transfers a workitem to an inbox/queue.

Inputs

Workitem IDworkitemIdtextRequired
Unique identifier of the workitem to transfer.
Inbox IDinboxIdtextRequired
Unique identifier of the target inbox/queue.
Event nameeventNametext
Name given to the transfer event.
Recordingrecordingtext
Recording options for transfers.One of: keepCurrent, startRecording, stopRecording.
Ring allringAlltrue/false
Whether to ring all agents in the inbox.
Surveysurveyobject
Survey data.

Outputs

dataobject
Nextiva response data.
Example output
{
  "data": {}
}

Unmute call

Unmute an active contact center call.

Inputs

Workitem IDworkitemIdtextRequired
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"
  }
}

On this page