searchAndOpenRecords (JavaScript API Reference) for Dynamics 365 Channel Integration Framework 1.0

Publisher

Microsoft

URL

https://learn.microsoft.com/en-us/dynamics365/channel-integration-framework/v1/develop/reference/microsoft-ciframework/searchandopenrecords

Published

2024-12-10

Updated

unknown

Accessed

2026-10-01

HTTP status

200

License

Microsoft Learn terms of use; no-redistribution; short excerpts and locators only

Source notes citing this source

• searchAndOpenRecords defaults to categorized search; relevance search (searchType 0) works only after relevance search is configured for the organisation, and otherwise falls back to category search. in context
• The CIF searchAndOpenRecords method searches for a record from the communication widget during inbound communication and opens it, which is CIF's screen-pop primitive. in context
• With searchOnly set to false, a searchAndOpenRecords call that returns multiple records opens only Account, Contact and Activity entities; with $search in the query it always opens the search results page, not the record. in context
• In the embedded-widget pattern, the screen pop is triggered client-side: the telephony widget calls the CRM's JavaScript API (for example CIF searchAndOpenRecords) when an interaction arrives, so a screen-pop failure can stem from the widget, the browser or the CRM search configuration, not from the telephony routing. inferred in context

Cite this source record

APA

WarmTransfer. (2024, December 10). searchAndOpenRecords (JavaScript API Reference) for Dynamics 365 Channel Integration Framework 1.0. WarmTransfer. https://warmtransfer.net/knowledge/sources/ms-learn-cif1-searchandopenrecords

BibTeX

@misc{warmtransfer-ms-learn-cif1-searchandopenrecords,
  title  = {searchAndOpenRecords (JavaScript API Reference) for Dynamics 365 Channel Integration Framework 1.0},
  author = {{WarmTransfer}},
  year   = {2024},
  url    = {https://warmtransfer.net/knowledge/sources/ms-learn-cif1-searchandopenrecords},
  note   = {Microsoft, accessed 2026-10-01}
}