v1
latestOpenAPI 3.0.02026-07-14362240.2 KBsearch
Search within a specific chat
Searches for messages, files, and links within a specific chat. Returns categorized results for easy filtering.
get/messenger/v1/search/{chatId}
Path parameters
chatIdstring required
The unique identifier of the chat to search within
Query parameters
querystring required
The search query string to match against chat content
limitnumber required
Maximum number of results to return per category
datestring required
Filter results by date (ISO 8601 format)
Response
Search results categorized by messages, files, and links
Example response
{
"messages": [
{
"id": "76bfc2ff-207c-4b5a-8543-f7009b7f8872",
"timestamp": 1709043064088,
"message": "Hello, world!",
"type": "MESSAGE",
"chatId": "76bfc2ff-207c-4b5a-8543-f7009b7f8872",
"readBy": [
1,
2,
3,
4
],
"externalLine": {
"id": "659ff121fd62e43063340f2f",
"name": "Main line",
"icon": "https://example.com/icon.png",
"externalId": "externalId",
"timestamp": 1620211200000,
"portal": "portal",
"phoneNumber": "+1234567890"
},
"attachedFiles": [
{
"entityId": "659ff121fd62e43063340f2f",
"entityType": "chat_message",
"lastModified": 1613491200000,
"originalFilename": "file.jpg",
"size": "1024",
"url": "https://example.com/file.jpg"
}
],
"relations": [
{
"action": "create",
"service": "crm",
"entity": "contact",
"name": "659ff121fd62e43063340f2f",
"pictureUrl": "https://example.com/picture.jpg",
"entityId": "659ff121fd62e43063340f2f"
}
],
"externalAuthorId": "123456",
"externalId": "123456",
"ref": {
"chatId": "76bfc2ff-207c-4b5a-8543-f7009b7f8872",
"authorId": 1,
"messageId": "76bfc2ff-207c-4b5a-8543-f7009b7f8872"
},
"meta": {
"body": [
{
"text": "Hello, world!",
"url": "https://www.instagram.com"
}
]
}
}
],
"files": [
{
"id": "76bfc2ff-207c-4b5a-8543-f7009b7f8872",
"timestamp": 1709043064088,
"message": "Hello, world!",
"type": "MESSAGE",
"chatId": "76bfc2ff-207c-4b5a-8543-f7009b7f8872",
"readBy": [
1,
2,
3,
4
],
"externalLine": {
"id": "659ff121fd62e43063340f2f",
"name": "Main line",
"icon": "https://example.com/icon.png",
"externalId": "externalId",
"timestamp": 1620211200000,
"portal": "portal",
"phoneNumber": "+1234567890"
},
"attachedFiles": [
{
"entityId": "659ff121fd62e43063340f2f",
"entityType": "chat_message",
"lastModified": 1613491200000,
"originalFilename": "file.jpg",
"size": "1024",
"url": "https://example.com/file.jpg"
}
],
"relations": [
{
"action": "create",
"service": "crm",
"entity": "contact",
"name": "659ff121fd62e43063340f2f",
"pictureUrl": "https://example.com/picture.jpg",
"entityId": "659ff121fd62e43063340f2f"
}
],
"externalAuthorId": "123456",
"externalId": "123456",
"ref": {
"chatId": "76bfc2ff-207c-4b5a-8543-f7009b7f8872",
"authorId": 1,
"messageId": "76bfc2ff-207c-4b5a-8543-f7009b7f8872"
},
"meta": {
"body": [
{
"text": "Hello, world!",
"url": "https://www.instagram.com"
}
]
}
}
],
"links": [
{
"id": "76bfc2ff-207c-4b5a-8543-f7009b7f8872",
"timestamp": 1709043064088,
"message": "Hello, world!",
"type": "MESSAGE",
"chatId": "76bfc2ff-207c-4b5a-8543-f7009b7f8872",
"readBy": [
1,
2,
3,
4
],
"externalLine": {
"id": "659ff121fd62e43063340f2f",
"name": "Main line",
"icon": "https://example.com/icon.png",
"externalId": "externalId",
"timestamp": 1620211200000,
"portal": "portal",
"phoneNumber": "+1234567890"
},
"attachedFiles": [
{
"entityId": "659ff121fd62e43063340f2f",
"entityType": "chat_message",
"lastModified": 1613491200000,
"originalFilename": "file.jpg",
"size": "1024",
"url": "https://example.com/file.jpg"
}
],
"relations": [
{
"action": "create",
"service": "crm",
"entity": "contact",
"name": "659ff121fd62e43063340f2f",
"pictureUrl": "https://example.com/picture.jpg",
"entityId": "659ff121fd62e43063340f2f"
}
],
"externalAuthorId": "123456",
"externalId": "123456",
"ref": {
"chatId": "76bfc2ff-207c-4b5a-8543-f7009b7f8872",
"authorId": 1,
"messageId": "76bfc2ff-207c-4b5a-8543-f7009b7f8872"
},
"meta": {
"body": [
{
"text": "Hello, world!",
"url": "https://www.instagram.com"
}
]
}
}
]
}