Skip to main content
POST
/
search
/
messages
Search for messages. Up to 50 results will be returned. Bot messages will not be included.
curl --request POST \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/search/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "conversation_id": 123,
  "not_older_than_days": 30
}
'
{
  "data": [
    {
      "channel": "bridge",
      "message_id": 123,
      "conversation_id": 123,
      "customer_id": 123,
      "profile_id": 123,
      "profile_name": "<string>",
      "preview": "<string>",
      "score": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
query
string

The search term to look for. Uses fuzzy search.

​
conversation_id
integer | null

If given, only search for messages in that conversation.

​
not_older_than_days
integer | null
default:30

Max age of messages. Lower to increase search performance.

Response

200 - application/json

Success

​
data
object[]