Load a conversation and mark its customer messages as read
curl --request POST \
--url https://app.flextell.ai/api/v1/conversations/{id}/open \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Tenant: <x-tenant>' \
--data '
{
"per_page": 50,
"page": 2,
"search": "<string>",
"message_type": []
}
'import requests
url = "https://app.flextell.ai/api/v1/conversations/{id}/open"
payload = {
"per_page": 50,
"page": 2,
"search": "<string>",
"message_type": []
}
headers = {
"X-Tenant": "<x-tenant>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Tenant': '<x-tenant>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({per_page: 50, page: 2, search: '<string>', message_type: []})
};
fetch('https://app.flextell.ai/api/v1/conversations/{id}/open', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.flextell.ai/api/v1/conversations/{id}/open",
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([
'per_page' => 50,
'page' => 2,
'search' => '<string>',
'message_type' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Tenant: <x-tenant>"
],
]);
$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 := "https://app.flextell.ai/api/v1/conversations/{id}/open"
payload := strings.NewReader("{\n \"per_page\": 50,\n \"page\": 2,\n \"search\": \"<string>\",\n \"message_type\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Tenant", "<x-tenant>")
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("https://app.flextell.ai/api/v1/conversations/{id}/open")
.header("X-Tenant", "<x-tenant>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"per_page\": 50,\n \"page\": 2,\n \"search\": \"<string>\",\n \"message_type\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.flextell.ai/api/v1/conversations/{id}/open")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Tenant"] = '<x-tenant>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"per_page\": 50,\n \"page\": 2,\n \"search\": \"<string>\",\n \"message_type\": []\n}"
response = http.request(request)
puts response.read_body{
"success": "<string>",
"data": {
"messages": "<unknown>",
"read": {
"marked_count": 123
},
"ai_suggestion": {
"id": 123,
"conversation_id": 123,
"original_text": "<string>",
"final_text": "<string>",
"status": "<string>",
"rating": "<string>",
"pending_actions": "<string>",
"attachments": "<string>",
"actions": "<string>",
"block_reason": "<string>",
"editable_insert": true,
"found_treatments": [
"<string>"
],
"editable_found_treatments": true,
"trigger_chat_log_ids": [
"<unknown>"
],
"has_new_messages": true,
"generated_at": "<string>",
"sent_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
},
"agent": {
"agent_disabled": true,
"agent_expires_at": "2023-11-07T05:31:56Z",
"agent_disabled_by_user_name": "<string>",
"remaining_minutes": 123
}
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"success": true,
"error_code": "RESOURCE_NOT_FOUND",
"message": "Conversation not found",
"errors": null,
"data": null
}{
"message": "<string>",
"errors": {}
}{
"success": false,
"error_code": "SETUP_REQUIRED",
"message": "Complete the required setup steps to continue.",
"data": {
"next_step": "clinic_info"
}
}Sohbetler ve bildirimler
Load a conversation and mark its customer messages as read
Allowed for an erased patient too: it only reads and marks as read, like the read endpoint.
POST
/
v1
/
conversations
/
{id}
/
open
Load a conversation and mark its customer messages as read
curl --request POST \
--url https://app.flextell.ai/api/v1/conversations/{id}/open \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Tenant: <x-tenant>' \
--data '
{
"per_page": 50,
"page": 2,
"search": "<string>",
"message_type": []
}
'import requests
url = "https://app.flextell.ai/api/v1/conversations/{id}/open"
payload = {
"per_page": 50,
"page": 2,
"search": "<string>",
"message_type": []
}
headers = {
"X-Tenant": "<x-tenant>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Tenant': '<x-tenant>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({per_page: 50, page: 2, search: '<string>', message_type: []})
};
fetch('https://app.flextell.ai/api/v1/conversations/{id}/open', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.flextell.ai/api/v1/conversations/{id}/open",
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([
'per_page' => 50,
'page' => 2,
'search' => '<string>',
'message_type' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Tenant: <x-tenant>"
],
]);
$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 := "https://app.flextell.ai/api/v1/conversations/{id}/open"
payload := strings.NewReader("{\n \"per_page\": 50,\n \"page\": 2,\n \"search\": \"<string>\",\n \"message_type\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Tenant", "<x-tenant>")
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("https://app.flextell.ai/api/v1/conversations/{id}/open")
.header("X-Tenant", "<x-tenant>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"per_page\": 50,\n \"page\": 2,\n \"search\": \"<string>\",\n \"message_type\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.flextell.ai/api/v1/conversations/{id}/open")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Tenant"] = '<x-tenant>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"per_page\": 50,\n \"page\": 2,\n \"search\": \"<string>\",\n \"message_type\": []\n}"
response = http.request(request)
puts response.read_body{
"success": "<string>",
"data": {
"messages": "<unknown>",
"read": {
"marked_count": 123
},
"ai_suggestion": {
"id": 123,
"conversation_id": 123,
"original_text": "<string>",
"final_text": "<string>",
"status": "<string>",
"rating": "<string>",
"pending_actions": "<string>",
"attachments": "<string>",
"actions": "<string>",
"block_reason": "<string>",
"editable_insert": true,
"found_treatments": [
"<string>"
],
"editable_found_treatments": true,
"trigger_chat_log_ids": [
"<unknown>"
],
"has_new_messages": true,
"generated_at": "<string>",
"sent_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
},
"agent": {
"agent_disabled": true,
"agent_expires_at": "2023-11-07T05:31:56Z",
"agent_disabled_by_user_name": "<string>",
"remaining_minutes": 123
}
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"success": true,
"error_code": "RESOURCE_NOT_FOUND",
"message": "Conversation not found",
"errors": null,
"data": null
}{
"message": "<string>",
"errors": {}
}{
"success": false,
"error_code": "SETUP_REQUIRED",
"message": "Complete the required setup steps to continue.",
"data": {
"next_step": "clinic_info"
}
}Yetkilendirmeler
oauth2bearer
The access token received from the authorization server in the OAuth 2.0 flow.
Başlıklar
Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.
Yol Parametreleri
The conversation identifier
Gövde
application/json
The number of items per page.
Gerekli aralık:
1 <= x <= 100The page number.
Gerekli aralık:
x >= 1The search query. Matches the message body and, for voice messages, the audio transcript.
Maximum string length:
255Filter by message type. A message matches when its type is any of the given values.
A message type to filter by (text, audio, video, document, image, location, system).
Mevcut seçenekler:
text, audio, video, document, image, sticker, location, contact, system