Chats, Messages, Attachments, and Contacts have a unified search API residing on each of their endpoints. There are two types of searches.
- Basic search, give your query and get your results.
- Bulk search – provide multiple queries, each with their own identifier. These queries will resolve concurrently, and are generally faster than if you were to run multiple searches consecutively.
- A use case would be for recreating the overview page in the iOS Messages app, where you see attachments, links, locations, etc. in their own groups. You can bulk search for all of these and ensure you get 10 of each, etc.
Search Parameters
GET /:resource/search
Perform a regular search
Query String
The query string can be any combination of the search parameters for the given resource
Response
POST /:resource/search/bulk
Perform a bulk search
Request
Response