Matchai Docs

Search messagesComing soon

Finds messages containing these words, across every conversation you are in, best match first.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
GET
/messages/search

Coming soon. Finds messages containing these words, across every conversation you are in, best match first.

Scopes: messages:read

Pricing: Included with the connection.

Authorization

headerAuthorizationBearer <matchai_<base62>>

A personal API key, sent as Authorization: Bearer matchai_…. Create keys in Matchai under Settings → Connectors → Advanced (for developers). A key starts with matchai_ followed by letters and digits, carries the scopes chosen when it was created, and can be revoked at any time. Keys reach only the account that created them: to serve other professionals, use Connect with Matchai.

Scope: messages:read

Query Parameters

query*string

Words to find.

Length2 <= length <= 200
conversation_id?string

Search one conversation only.

limit?integer

How many results per page.

Range1 <= value <= 100
Default25
cursor?string

The next_cursor of the previous page. Cursors expire after 24 hours.

Lengthlength <= 512

Response Body

One page of matches.

application/json
  1. response

One page of results. Pass next_cursor as cursor to get the next page; it is null on the last page.

data*array<>
next_cursor*|

Cursor for the next page, or null when there are no more results.

Example Request
curl -X GET 'https://api.matchai.co/v1/messages/search?query=string'
Example Response
{  "data": [    {      "message": {        "id": "string",        "conversation_id": "string",        "type": "text",        "text": "string",        "sender": {          "user_id": "string",          "contact_id": "string",          "display_name": "string",          "avatar_url": "http://example.com"        },        "from_you": true,        "sent_via": {          "kind": "person",          "app_name": "string"        },        "reply_to_message_id": "string",        "attachments": [          {            "document_id": "string",            "name": "string",            "mime_type": "string",            "size_bytes": 0          }        ],        "delivery": {          "channel": "matchai",          "state": "sent"        },        "sent_at": "2019-08-24T14:15:22Z",        "edited_at": "2019-08-24T14:15:22Z"      },      "highlight": "string"    }  ],  "next_cursor": "string"}