GETPROSPECT
This help page is for Studio. This information is also available for Desktop Studio.
|
|
Retrieves a prospective contact from the platform as part of Proactive XS. With GetProspect, there is a notion of checking in/out prospective contacts from a lead source and bringing them into the CXone Mpower platform. GetProspect is structured to support multi-number contacts. |
Supported Script Types
|
|
|
|
|
|
|
|
|
Generic |
Chat | Phone | Voicemail | Work Item | SMS |
Input Properties
These properties define data that the action uses when executing.
|
Property |
Description |
|---|---|
|
Add Caption |
Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon. |
| Source Name | The name of the source where the records originated. Provides a logical grouping of records within the system. If you have an invalid or missing source map, you may receive a Missing External ID error. |
| Search Options | A dynamic data object that contains the search criteria. Four fields can be searched: ExternalID, PhoneNumber, FirstName and LastName. If FirstName or LastName is specified, both must be specified. |
Output Properties
These properties contain variables that hold data returned from executing the action. They're available for reference and use when the action completes.
|
Property |
Description |
|---|---|
| Results | A dynamic data object containing the results of the action executing. |
Result Branch Conditions
Result branch conditions allow you to create branches in your script to handle different outcomes when an action executes.
|
Condition |
Description |
|---|---|
|
Default |
Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the action's other branches are not defined. |
|
|
Path taken when the action fails to execute properly. For example, when there is an unexpected problem such as poor connectivity, syntax errors, and so on. The _ERR variable, with a single underscore character, should be populated with a condensed explanation of the problem. |
Example Script
This is an example to show how this action can be used in scripts. It is not intended to be a complete script. Additional scripting may be required.
In this sample script, you can use the Snippet to leave your dynamic object blank and get all records back for the sourcename you set. You can also comment out your search criteria to get specific records back from the sourcename you set. Afterward, you can check your trace to see whether your data is correct or not.
Click here to view the Snippet Properties.
Click here to view the Assign Properties.
Would you like to download this script?