.png?sv=2022-11-02&spr=https&st=2025-12-29T18%3A32%3A07Z&se=2025-12-29T18%3A42%3A07Z&sr=c&sp=r&sig=nq3eKrDI6V5qP%2F4KI1g%2F5V7nxzu6AwZdxaxjg8xuKk8%3D){kind=logo}
Search Criteria Event
- DarkLight
Search Criteria Event
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
This is an event sent by Salesforce Core during a successful Screen Pop.
Pre-requisite
The Agent must be on an active call.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
No request parameters | |
Data Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
No request parameters |
Response Parameters | Value |
|---|---|
channel | Salesforce |
topic | Call |
subtopic | SearchCriteria |
source | «JSON Object» |
Response Data Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
callid | String | Call ID for which you want to remove variables | 12345 |
searchField | String | The field name used for screen pop. | from Address |
searchText | String | The field value used for screen pop. | 9999999999 |
searchCallType | String | The call type for which the screen pop provided information. | ACD_IN |
searchEvent | String | The event during which screen pop happened. | ALERTING |
searchObjects | JSON Array | Salesforce objects corresponding to search. | Empty for NO_MATCH and DIRECT |
searchResult | String | Search result. | SINGLE_MATCH, MULTI_MATCH, NO_MATCH, DIRECT |
searchObjects Details Parameters | |||
id | String | Salesforce object identifier. | 00T7F000027L43nUAC |
type | String | Salesforce object type. | Contact, Account, etc. |
name | String | Salesforce object name. | |
Sample Request
Not applicableSample Response
{
"channel": "Salesforce",
"topic": "Call",
"subtopic": "SearchCriteria",
"data":
{
"callId": "12345",
"searchField": "fromAddress",
"searchText": "4454",
"searchCallType": "ACD_IN",
"searchEvent": "ALERTING",
"searchObjects":
[
{
"id": "0017F00000ELIkaQAH",
"type": "Account",
"name": "Grand Hotels & Resorts Ltd"
},
{
"id": "0037F00001ghehyQAA",
"type": "Contact",
"name": "Test1"
},
{
"id": "0037F00001bovxyQAA",
"type": "Contact",
"name": "Test2"
}
],
"searchResult": "MULTI_MATCH"
}Was this article helpful?