Reset size
Session
Username
Password
Tenant
login
getLoginState
logout
Phone device
Phone device type
Phone device number
getPhoneDevicesList
getPhoneDevice
setPhoneDevice
Agent state
Agent state
Not ready reason
getAgentState
getAgentNotReadyReasons
setAgentState
Teams and Service
Team ID
getTeams
getTeamMembers
Services and DID numbers
Service ID/name
DID phone number
getService
getServicesList
setService
getDIDNumber
getDIDNumbersList
setDIDNumber
Interactions
Start interaction
Chat Specific
Transfer
Conference
Active interaction
Active screen & Associated object
Notes & Disposition
End interaction
Chat channel
Phone or user ID
Email address
Phone number
Associated object
{ "id": "some-random-id", "type": "contact", "displayName": "Peter Morrison", "displayType": "Contact", "customFields": {} }
startChat
startEmail
startCall
Interaction ID
Message
Overwrite message
sendChatMessage
suggestChatMessage
Phone number
Interaction ID
Custom data for transfer:
{ "prevUrl": "http://example.com/?url=right", "reconnectAttempts": 3, "associatedMetadata": "blah-blah-blah" }
consultCall
blindTransfer
transfer
Phone number
Interaction ID
Party ID
Custom data for transfer:
{ "prevUrl": "http://example.com/?url=right", "reconnectAttempts": 3, "associatedMetadata": "blah-blah-blah" }
addToCallConference
mergeAllCallsIntoConference
removeFromCallConference
destroyCallConference
inviteToChatConference
removeFromChatConference
Interaction ID
DTMF
Variable name
Variable value
Variable names
setCallHold (retrieve)
setCallRecording (stop)
setCallMute (unmute)
acceptInteraction
rejectInteraction
switchActiveInteraction
sendDtmf
setVariable
getVariables
Interaction ID
Associated object
{ "id": "some-random-id", "type": "contact", "displayName": "Peter Morrison", "displayType": "Contact", "customFields": {} }
Servicenow contact
Servicenow Task
Salesforce Case
Salesforce Contact
Interaction active screen
{ "url": "https://brightpattern.com/?data=none" }
addInteractionAssociatedObject
setInteractionActiveScreen
Interaction ID
Service ID/name
Disposition id/code/name
Note
getDispositionsList
setDisposition
addNote
updateNote
replaceNote
Interaction ID
Disposition ID/code/name
Note
leaveInteraction
completeInteraction
leaveAndCompleteInteraction
destroyCallConference
Reschedule window
Phone number
Interaction ID
From time
Until time
Time zone code
setRescheduleWindow
Screen recording
Mute screen recording
setScreenRecordingMute (unmute)
getScreenRecordingState
Widget & Config
Widget minimized
setWidgetMinimized
getConfig
Knowledge Base
Search KB result:
[ { "id": "random-id-1", "title": "Demo article", "text": "This is KB Article content" }, { "id": "random-id-2", "title": "How to use KB articles", "text": "You can use KB articles when a client asks you a common question" } ]
KB Article full data:
{ "id": "random-id-2", "title": "How to use KB articles", "answer": "You can use KB articles when a client asks you a common question", "keywords": "agent,kb,article", "notes": "use it only to teach agents-newcomers", "language": "ru", "createdByUser": "System admin", "lastEditedByUser": "Pol Andersen", "customFields": {} }