Read messages from one chat
curl --request POST \
--url http://localhost:3000/api/v1/chats/read \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"chat": "<string>",
"channel": "<string>",
"includeRaw": true,
"instance": "<string>",
"limit": "<string>",
"offset": "<string>",
"order": "<string>",
"type": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/chats/read"
payload = {
"chat": "<string>",
"channel": "<string>",
"includeRaw": True,
"instance": "<string>",
"limit": "<string>",
"offset": "<string>",
"order": "<string>",
"type": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
chat: '<string>',
channel: '<string>',
includeRaw: true,
instance: '<string>',
limit: '<string>',
offset: '<string>',
order: '<string>',
type: '<string>'
})
};
fetch('http://localhost:3000/api/v1/chats/read', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/chats/read",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'chat' => '<string>',
'channel' => '<string>',
'includeRaw' => true,
'instance' => '<string>',
'limit' => '<string>',
'offset' => '<string>',
'order' => '<string>',
'type' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/v1/chats/read"
payload := strings.NewReader("{\n \"chat\": \"<string>\",\n \"channel\": \"<string>\",\n \"includeRaw\": true,\n \"instance\": \"<string>\",\n \"limit\": \"<string>\",\n \"offset\": \"<string>\",\n \"order\": \"<string>\",\n \"type\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/api/v1/chats/read")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"chat\": \"<string>\",\n \"channel\": \"<string>\",\n \"includeRaw\": true,\n \"instance\": \"<string>\",\n \"limit\": \"<string>\",\n \"offset\": \"<string>\",\n \"order\": \"<string>\",\n \"type\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/chats/read")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"chat\": \"<string>\",\n \"channel\": \"<string>\",\n \"includeRaw\": true,\n \"instance\": \"<string>\",\n \"limit\": \"<string>\",\n \"offset\": \"<string>\",\n \"order\": \"<string>\",\n \"type\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"chat": {
"channel": "<string>",
"chatType": "dm",
"createdAt": 123,
"firstSeenAt": 123,
"id": "<string>",
"instanceId": "<string>",
"lastSeenAt": 123,
"updatedAt": 123,
"actorId": "<string>",
"agentId": "<string>",
"avatarUrl": "<string>",
"metadata": {},
"normalizedChatId": "<string>",
"platformChatId": "<string>",
"rawProvenance": {},
"title": "<string>"
},
"messages": [
{
"actorType": "<string>",
"chatId": "<string>",
"createdAt": 123,
"id": "<string>",
"ingestedAt": 123,
"sortKey": "<string>",
"updatedAt": 123,
"actorId": "<string>",
"agentId": "<string>",
"channel": "<string>",
"clientMessageId": "<string>",
"contactId": "<string>",
"content": {},
"instanceId": "<string>",
"messageType": "<string>",
"normalizedSenderId": "<string>",
"platformIdentityId": "<string>",
"providerMessageId": "<string>",
"providerTimestamp": 123,
"rawChatId": "<string>",
"rawProvenance": {},
"rawSenderId": "<string>",
"revision": 123,
"state": "<string>"
}
],
"pagination": {
"limit": 123,
"offset": 123,
"returned": 123,
"total": 123,
"hasMore": true,
"nextCommand": "<string>",
"nextOffset": 123
},
"total": 123
}chats
Read messages from one chat
POST
/
api
/
v1
/
chats
/
read
Read messages from one chat
curl --request POST \
--url http://localhost:3000/api/v1/chats/read \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"chat": "<string>",
"channel": "<string>",
"includeRaw": true,
"instance": "<string>",
"limit": "<string>",
"offset": "<string>",
"order": "<string>",
"type": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/chats/read"
payload = {
"chat": "<string>",
"channel": "<string>",
"includeRaw": True,
"instance": "<string>",
"limit": "<string>",
"offset": "<string>",
"order": "<string>",
"type": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
chat: '<string>',
channel: '<string>',
includeRaw: true,
instance: '<string>',
limit: '<string>',
offset: '<string>',
order: '<string>',
type: '<string>'
})
};
fetch('http://localhost:3000/api/v1/chats/read', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/chats/read",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'chat' => '<string>',
'channel' => '<string>',
'includeRaw' => true,
'instance' => '<string>',
'limit' => '<string>',
'offset' => '<string>',
'order' => '<string>',
'type' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/v1/chats/read"
payload := strings.NewReader("{\n \"chat\": \"<string>\",\n \"channel\": \"<string>\",\n \"includeRaw\": true,\n \"instance\": \"<string>\",\n \"limit\": \"<string>\",\n \"offset\": \"<string>\",\n \"order\": \"<string>\",\n \"type\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/api/v1/chats/read")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"chat\": \"<string>\",\n \"channel\": \"<string>\",\n \"includeRaw\": true,\n \"instance\": \"<string>\",\n \"limit\": \"<string>\",\n \"offset\": \"<string>\",\n \"order\": \"<string>\",\n \"type\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/chats/read")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"chat\": \"<string>\",\n \"channel\": \"<string>\",\n \"includeRaw\": true,\n \"instance\": \"<string>\",\n \"limit\": \"<string>\",\n \"offset\": \"<string>\",\n \"order\": \"<string>\",\n \"type\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"chat": {
"channel": "<string>",
"chatType": "dm",
"createdAt": 123,
"firstSeenAt": 123,
"id": "<string>",
"instanceId": "<string>",
"lastSeenAt": 123,
"updatedAt": 123,
"actorId": "<string>",
"agentId": "<string>",
"avatarUrl": "<string>",
"metadata": {},
"normalizedChatId": "<string>",
"platformChatId": "<string>",
"rawProvenance": {},
"title": "<string>"
},
"messages": [
{
"actorType": "<string>",
"chatId": "<string>",
"createdAt": 123,
"id": "<string>",
"ingestedAt": 123,
"sortKey": "<string>",
"updatedAt": 123,
"actorId": "<string>",
"agentId": "<string>",
"channel": "<string>",
"clientMessageId": "<string>",
"contactId": "<string>",
"content": {},
"instanceId": "<string>",
"messageType": "<string>",
"normalizedSenderId": "<string>",
"platformIdentityId": "<string>",
"providerMessageId": "<string>",
"providerTimestamp": 123,
"rawChatId": "<string>",
"rawProvenance": {},
"rawSenderId": "<string>",
"revision": 123,
"state": "<string>"
}
],
"pagination": {
"limit": 123,
"offset": 123,
"returned": 123,
"total": 123,
"hasMore": true,
"nextCommand": "<string>",
"nextOffset": 123
},
"total": 123
}Authorizations
Runtime context-key (rctx_*) issued by the Ravi gateway. Required for every non-open scope. Bootstrap the first key with ravi daemon init-admin-key; rotate, derive, and revoke via the ravi context family. Specs: runtime/context-keys, sdk/auth.
Body
application/json
Chat id, platform chat id, phone, group id, or normalized chat id
Resolve chat within a channel
Include raw provider ids and provenance in JSON output
Resolve chat within an instance
Page size (default: 50, max: 500)
Number of matching messages to skip (default: 0)
Message order (default: asc)
Resolve chat type: dm|group|thread|room