Conversations
Send Message
Sends a message in a conversation between users
Send Message
curl --request POST \
--url http://localhost:3000/api/conversations/send-message \
--header 'Content-Type: application/json' \
--data '
{
"conversationId": "<string>",
"messageData": {
"type": "TEXT",
"text": "<string>"
},
"fileUrls": [
{
"url": "<string>",
"name": "<string>",
"type": "<string>"
}
],
"messageId": "<string>"
}
'import requests
url = "http://localhost:3000/api/conversations/send-message"
payload = {
"conversationId": "<string>",
"messageData": {
"type": "TEXT",
"text": "<string>"
},
"fileUrls": [
{
"url": "<string>",
"name": "<string>",
"type": "<string>"
}
],
"messageId": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
conversationId: '<string>',
messageData: {type: 'TEXT', text: '<string>'},
fileUrls: [{url: '<string>', name: '<string>', type: '<string>'}],
messageId: '<string>'
})
};
fetch('http://localhost:3000/api/conversations/send-message', 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/conversations/send-message",
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([
'conversationId' => '<string>',
'messageData' => [
'type' => 'TEXT',
'text' => '<string>'
],
'fileUrls' => [
[
'url' => '<string>',
'name' => '<string>',
'type' => '<string>'
]
],
'messageId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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/conversations/send-message"
payload := strings.NewReader("{\n \"conversationId\": \"<string>\",\n \"messageData\": {\n \"type\": \"TEXT\",\n \"text\": \"<string>\"\n },\n \"fileUrls\": [\n {\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"messageId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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/conversations/send-message")
.header("Content-Type", "application/json")
.body("{\n \"conversationId\": \"<string>\",\n \"messageData\": {\n \"type\": \"TEXT\",\n \"text\": \"<string>\"\n },\n \"fileUrls\": [\n {\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"messageId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/conversations/send-message")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"conversationId\": \"<string>\",\n \"messageData\": {\n \"type\": \"TEXT\",\n \"text\": \"<string>\"\n },\n \"fileUrls\": [\n {\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"messageId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": {
"id": "<string>",
"senderId": "<string>",
"content": "<string>",
"timestamp": 123,
"readBy": [
"<string>"
],
"type": "<string>"
},
"fileMessages": [
{
"id": "<string>",
"senderId": "<string>",
"content": "<string>",
"timestamp": 123,
"readBy": [
"<string>"
],
"type": "<string>"
}
]
}{
"message": "<string>"
}Body
application/json
ID of the conversation to send the message to
Data for the message to send
- Option 1
- Option 2
Show child attributes
Show child attributes
Optional array of file URLs to send as separate file messages
Show child attributes
Show child attributes
Optional frontend-generated unique ID for message correlation
⌘I
Send Message
curl --request POST \
--url http://localhost:3000/api/conversations/send-message \
--header 'Content-Type: application/json' \
--data '
{
"conversationId": "<string>",
"messageData": {
"type": "TEXT",
"text": "<string>"
},
"fileUrls": [
{
"url": "<string>",
"name": "<string>",
"type": "<string>"
}
],
"messageId": "<string>"
}
'import requests
url = "http://localhost:3000/api/conversations/send-message"
payload = {
"conversationId": "<string>",
"messageData": {
"type": "TEXT",
"text": "<string>"
},
"fileUrls": [
{
"url": "<string>",
"name": "<string>",
"type": "<string>"
}
],
"messageId": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
conversationId: '<string>',
messageData: {type: 'TEXT', text: '<string>'},
fileUrls: [{url: '<string>', name: '<string>', type: '<string>'}],
messageId: '<string>'
})
};
fetch('http://localhost:3000/api/conversations/send-message', 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/conversations/send-message",
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([
'conversationId' => '<string>',
'messageData' => [
'type' => 'TEXT',
'text' => '<string>'
],
'fileUrls' => [
[
'url' => '<string>',
'name' => '<string>',
'type' => '<string>'
]
],
'messageId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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/conversations/send-message"
payload := strings.NewReader("{\n \"conversationId\": \"<string>\",\n \"messageData\": {\n \"type\": \"TEXT\",\n \"text\": \"<string>\"\n },\n \"fileUrls\": [\n {\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"messageId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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/conversations/send-message")
.header("Content-Type", "application/json")
.body("{\n \"conversationId\": \"<string>\",\n \"messageData\": {\n \"type\": \"TEXT\",\n \"text\": \"<string>\"\n },\n \"fileUrls\": [\n {\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"messageId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/conversations/send-message")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"conversationId\": \"<string>\",\n \"messageData\": {\n \"type\": \"TEXT\",\n \"text\": \"<string>\"\n },\n \"fileUrls\": [\n {\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"messageId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": {
"id": "<string>",
"senderId": "<string>",
"content": "<string>",
"timestamp": 123,
"readBy": [
"<string>"
],
"type": "<string>"
},
"fileMessages": [
{
"id": "<string>",
"senderId": "<string>",
"content": "<string>",
"timestamp": 123,
"readBy": [
"<string>"
],
"type": "<string>"
}
]
}{
"message": "<string>"
}