ipSCAPE API

Yellowfin
- List Methods
- Expand Methods
- POSTCreateYellowfinUser/yfbridge/createuser
  Create a new user in yellofin space.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTDeleteYellowfinUser/yfbridge/deleteuser
  Delete yellowfin user.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTUpdateYellowfinUser/yfbridge/updateuser
  Update yellowfin user.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTYellowfinLogin/yfbridge/login
  Login to yellowfin using existing user.
  
  Description
  Location
  Type
  Value
  Parameter
User
- List Methods
- Expand Methods
- POSTChangePassword/user/changepassword
  Change password for a user
  
  Description
  Location
  Type
  Value
  Parameter
- POSTCreateUser/user/createuser
  Create a new workspace user. Note that this method cannot create an agent.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTLogin/user/login
  Log in a user and return a user session token for use with subsequent calls on behalf of that user.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTLogout/user/logout
  Log out a currently logged-in user.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadAllocatedCampaignsList/user/readallocatedcampaignslist
  Retrieve the list of campaigns that the specified user is currently allocated to.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadUsersList/user/readuserslist
  Read a list of users. The user must have access to the User and/or Agent modules, depending on the type of user being accessed.
  
  Description
  Location
  Type
  Value
  Parameter
Lead
- List Methods
- Expand Methods
- POSTCreateLead/lead/createlead
  Create a new lead in a specified list.
  
  Description
  Location
  Type
  Value
  Parameter
- DELETEDeleteLead/lead/deletelead
  Deletes the lead by its lead id.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTInsertLeadList/lead/insertleadlist
  Insert a new list of leads for a campaign.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadLeadDetails/lead/readleaddetails
  Read the details of a lead. User should have the access to Leads module.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadLeadsList/lead/readleadslist
  Read a list of leads. User should have the access to Leads module.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadListsList/lead/readlistslist
  Read a list of leads lists. User should have the access to Leads module.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTUpdateLeadDetails/lead/updateleaddetails
  Update the details of an existing lead.
  
  Description
  Location
  Type
  Value
  Parameter
Campaign
- List Methods
- Expand Methods
- POSTAssignAgent/campaign/assignagent
  Assign an agent to a campaign.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadAllocatedUsersList/campaign/readallocateduserslist
  Read a list of all users (either agents or workspace users) that are allocated to a particular campaign. User should have access to the Administration module.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadAssignedAgents/campaign/readassignedagents
  Returns the list of agents assigned to a campaign.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadAssignedCampaigns/campaign/readassignedcampaigns
  Returns the list of campaigns an agent is assigned to.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadCallDetails/campaign/readcalldetails
  Read the call details. User should have the access to the Calls module, as well as access to the Campaign that contains the call.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadCallNotes/campaign/readcallnotes
  Read the notes for a call. User should have the access to the Calls module, as well as access to the Campaign that contains the call.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadCallRecording/campaign/readcallrecording
  Read the details of a call recording. User should have the access to Calls module, as well as access to the Campaign that contains the call.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadCallsList/campaign/readcallslist
  Read a list of calls. User should have the access to Calls module.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadCampaignDetails/campaign/readcampaigndetails
  Read the details of a campaign. User should have the access to Campaigns module, as well as access to this campaign.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadCampaignStatistics/campaign/readcampaignstatistics
  Read the statistics of a campaign. User should have the access to Campaigns module, as well as access to the queue.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadCampaignsList/campaign/readcampaignslist
  Read a list of campaigns. User should have the access to Campaigns module.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadQueueStatus/campaign/readqueuestatus
  Read the status of a queue. User should have the access to Campaigns module, as well as access to this queue.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadTransferTargetsList/campaign/readtransfertargetslist
  Read the list of possible transfer targets for a campaign.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadWrapCodesList/campaign/readwrapcodeslist
  Read the list of Wrap Codes available to the agent for a particular campaign at the completion of a call.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTUnassignAgent/campaign/unassignagent
  Unassign an agent from a campaign.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTUpdateCallNotes/campaign/updatecallnotes
  Update the notes for a call. User should have the access to the Calls module, as well as access to the Campaign that contains the call.
  
  Description
  Location
  Type
  Value
  Parameter
Chat
- List Methods
- Expand Methods
- GETReadChatTranscript/campaign/chat/readchattranscript
  Read the chat transcript of an interaction, including the entire message history. Can only be used by a workspace user with access to the campaign, or an agent who is assigned to the interaction.
  
  Description
  Location
  Type
  Value
  Parameter
Workflow
- List Methods
- Expand Methods
- GETReadWorkflowsList/workflow/readworkflowslist
  Read a list of workflows.
  
  Description
  Location
  Type
  Value
  Parameter
Activity
- List Methods
- Expand Methods
- GETReadActivitiesList/activity/readactivitieslist
  Returns a list of activities.
  
  Description
  Location
  Type
  Value
  Parameter
Agent
- List Methods
- Expand Methods
- POSTCall/agent/call
  Place an external call using the phone number supplied by the agent and put the user in the Manual Talk status. This API call is only allowed if the agent is in the Available, Paused, or Manual Preview states.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTCancelManualPreview/agent/cancelmanualpreview
  This method sets the current state of the agent from 'ManualPreview' to the prior state.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTConferenceCall/agent/conferencecall
  Initiate conference call based on an attended transfer call
  
  Description
  Location
  Type
  Value
  Parameter
- POSTCreateAgent/agent/createagent
  Create a new agent.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTExtendAutoWrapTime/agent/extendautowraptime
  Extend the wrap time of a call that is configured to auto-wrap.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTHangup/agent/hangup
  Terminate a call placed by the system. The agent remains connected to the system, but the connection between the agent and the destination phone number is closed.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTHold/agent/hold
  Place the agent's current call on hold.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTLoginPhone/agent/loginphone
  Connect the agent to the system so they can make and receive calls.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTManualPreview/agent/manualpreview
  This method sets the current state of the agent to 'ManualPreview'.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTPause/agent/pause
  Take the agent from the Available state into the Paused state. A mandatory pause reason must be supplied from the set of valid pause reasons.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTPlayAnnouncement/agent/playannouncement
  Get an Announcement for an activity.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadAgentDetails/agent/readagentdetails
  return the details for an agent
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadAgentsAvailableForTransfer/agent/readagentsavailablefortransfer
  Returns a list of agents that may be transferred to.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTReleaseCall/agent/releasecall
  Release an attended transfer call
  
  Description
  Location
  Type
  Value
  Parameter
- POSTRetrieveCall/agent/retrievecall
  Retrieve a call during an attended transfer.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTStartVoiceRecording/agent/startvoicerecording
  Start recording the current call.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTStopAnnouncement/agent/stopannouncement
  Stop an ongoing announcement for an activity.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTStopVoiceRecording/agent/stopvoicerecording
  Stop recording the voice call.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTSwitchLine/agent/switchline
  Switch between lines for an agent performing an attended transfer.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTTagVoiceRecording/agent/tagvoicerecording
  Tag a voice recording.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTTransfer/agent/transfer
  Transfer call
  
  Description
  Location
  Type
  Value
  Parameter
- POSTUnhold/agent/unhold
  Take the agents current call off hold.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTUnpause/agent/unpause
  Take the agent from a Paused state into the Available state.
  
  Description
  Location
  Type
  Value
  Parameter
- PUTUpdatePauseReason/agent/updatepausereason
  Change the pause reason for an agent.
  
  Description
  Location
  Type
  Value
  Parameter
- POSTWrapActivity/agent/wrapactivity
  Wrap an activity, separately to the agent interaction. Used primarily for outbound preview campaigns.
  
  Description
  Location
  Type
  Value
  Parameter
- GETreadagentactions/agent/readagentactions
  Returns a list of agent action history.
  
  Description
  Location
  Type
  Value
  Parameter
Other
- List Methods
- Expand Methods
- GETPing/ping
  Test to see if the servers are available.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadApiDetails/readapidetails
  Returns the version number of the API, and a list of available methods with their minimum and maximum version numbers. Can be used without logging in.
  
  Description
  Location
  Type
  Value
  Parameter
Organisation
- List Methods
- Expand Methods
- GETGetEnabledFeatureFlags/organisation/getenabledfeatureflags
  Get a list of enabled feature flags for this organisation.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadCtiConfiguration/organisation/readcticonfiguration
  Get CTI configuration for an organisation.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadOrgDetails/organisation/readorgdetails
  Return a relevant set of organisation details.
  
  Description
  Location
  Type
  Value
  Parameter
- GETReadPauseReasonsList/organisation/readpausereasonslist
  Read the possible pause reasons for an organisation.
  
  Description
  Location
  Type
  Value
  Parameter