Starting with Stratus Agent 3.4 "External Web Request" Workflow Element properties have moved away from Workflow Instance and into a central "Web Requests" page for central management and assignment to Organization Units.

Good to know:

  • Workflow Instance containing Web Requests from Stratus Agent version 3.3 or older will have their web request properties automatically imported into this view.  The naming for these new requests will be "WI_<ImportedWorkflowInstancename>". Any used Service Context Parameters and other user-defined properties are imported over alongside.
  • Existing Web Request data entities appear as Pulldown the "External Web Request" Workflow Elements within your Workflow Instance.
  • Starting with Stratus Agent 3.4 you can also add Web Requests within External Web Request Trigger Sets

Definition and Usage

Within the Web Requests tab you can define and share web requests and make them available across your Organization Units - same as any other data entities configured under your Common Service Settings. Web Requests find their use in Workflow Instances or External Web Request Trigger Sets.

(lightbulb) As within other panels, you can make use of Parameters and Placeholders within web requests to react flexible when sending or receiving CRM data. 

The ‘Web Requests’ page is accessible on Settings -> Service section -> "External Web Requests"

WebConfigurator - Web Requests Page

The 'Web Requests' page contains the following settings:

Control NameDescription

Name

Request name.

Organization Unit

Organization Units to which the web request will be available.

Description

Additional description.

Authentication

  • No Authentication (Default)
  • BasicAuthentication(Base64)

(info) Enables additional fields (Username and Password) for login when enabled.
(info) Within Username and Password the use of Workflow Placeholders (→ See Workflow Resources and Dependencies) or predefined Service Parameters is supported.

Request Type

Define the request type of the HTTP request. Possible values are: POST, GET or PUT 

Request Headers

Allows to add one or more request headers to the request 

The Header Name and Value are split by a ";" (semicolon). Example: 

Name;Value;Name2;Value2
CODE

or just

Name;
CODE

...if you want an empty header value. 


(info) The use of Placeholders or Service Parameters is supported.

Timeout

Timeout in hh:mm:ss for a request

(info) If set to 0, timeout is disabled

Server URL

Either full URL or fragments substitution with Placeholders or Service Parameters

(info) If placeholders or parameters are used, supported format is <(placeholder|parameter name).Value> only.

(lightbulb) This URL and the format depends on your external system. Example: 

http://mycrm.com/create/callerPhoneNumber.Value
CODE

Parameter to save Response Code

Allows to save the response code into a Service Parameter for further handling.

Parameter to save Response Content

Allows to save the response content into a Service Parameter for further handling, e.g. to display as Service Call Context.

Parameter to save Response Header

Allows to save the response header into a Service Parameters, e.g. to react in a Workflow Instance "Switch" activity.

Response Content Parameter Mapping

Allows to map one or several Stratus Agent-internal Service Parameters to save an external content parameter. 

(lightbulb) Example: your CRM system delivers a crmTicketID upon ticket creation which can be mapped to the Stratus Agent-internal "TicketId"


Response Header Parameter Mapping

Allows to map one or several Stratus Agent-internal Service Parameters to save an external content parameter. 

(lightbulb) Example: your CRM system delivers an responsible Agent URI upon ticket creation as header for the new ticket, which can be mapped to the Stratus Agent-internal "AgentSipURI"

Content Type and Content 

Selection Drop-Down with Multi-Line text field below.

Allows for the following formats: JSON, XML, www-form-urlencoded, multipart, text-plain, text-xml.

(info) Content supports Service Context Parameters or Placeholders.


To distinguish between multiple Agent transfers a new Service Context Parameter called "LastAgentTransferType" has been added.

(lightbulb) The parameter stores the last type of a transfer triggered by an agent via API or native in the client (SfB/Teams).

By default this parameter is set to "None". It changes changes for every "OnTransfer" trigger for an Agent occurs, to any of the following types: 

  • APIBlind (flag set to true)
  • APIConsultative
  • APIAttendant (flag set to false)
  • NativeAttendant
  • NativeConsultative

How to use

  1. Create an external Web request that uses the "LastAgentTransferType" parameter in the response content body:

    Example Json Content

    {
    	"lasttransfer": "LastAgentTransferType.Value",
    	"agent": "AgentSipUriWithoutSipPrefix.Value",
    	"caller": "CallerTelNumber.Value"
    }
    XML
  2. Within the External Web Request Trigger Sets dialogue, set a Trigger for: Agent - OnTransfer 
  3. Receive a service call on any Agent
  4. Make a native Transfer call to another Agent → The trigger should be fired with the Parameter LastAgentTransferType