Get Message
curl --request GET \
--url http://localhost:8080/api/v1/conversations/{cuuid}/messages/{uuid} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "http://localhost:8080/api/v1/conversations/{cuuid}/messages/{uuid}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('http://localhost:8080/api/v1/conversations/{cuuid}/messages/{uuid}', 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 => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/conversations/{cuuid}/messages/{uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/conversations/{cuuid}/messages/{uuid}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/api/v1/conversations/{cuuid}/messages/{uuid}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/conversations/{cuuid}/messages/{uuid}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"type": "incoming",
"status": "pending",
"conversation_id": 123,
"conversation_uuid": "<string>",
"content": "<string>",
"text_content": "<string>",
"content_type": "html",
"private": true,
"sender_id": 123,
"sender_type": "agent",
"meta": {
"to": [
"<string>"
],
"cc": [
"<string>"
],
"bcc": [
"<string>"
],
"from": [
"<string>"
],
"subject": "<string>"
},
"attachments": [
{
"name": "<string>",
"size": 123,
"content": "aSDinaTvuI8gbWludGxpZnk=",
"content_id": "<string>",
"content_type": "<string>",
"disposition": "inline",
"uuid": "<string>",
"url": "<string>",
"thumbnail_url": "<string>"
}
],
"author": {
"id": 123,
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"avatar_url": "<string>",
"availability_status": "<string>",
"type": "agent",
"last_active_at": "2023-11-07T05:31:56Z"
}
}
}{
"status": "error",
"message": "Invalid request",
"data": "<unknown>",
"error_type": "GeneralException"
}{
"status": "error",
"message": "Invalid request",
"data": "<unknown>",
"error_type": "GeneralException"
}{
"status": "error",
"message": "Invalid request",
"data": "<unknown>",
"error_type": "GeneralException"
}{
"status": "error",
"message": "Invalid request",
"data": "<unknown>",
"error_type": "GeneralException"
}Conversations
Get Message
Requires the messages:read permission.
GET
/
api
/
v1
/
conversations
/
{cuuid}
/
messages
/
{uuid}
Get Message
curl --request GET \
--url http://localhost:8080/api/v1/conversations/{cuuid}/messages/{uuid} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "http://localhost:8080/api/v1/conversations/{cuuid}/messages/{uuid}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('http://localhost:8080/api/v1/conversations/{cuuid}/messages/{uuid}', 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 => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/conversations/{cuuid}/messages/{uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/conversations/{cuuid}/messages/{uuid}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/api/v1/conversations/{cuuid}/messages/{uuid}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/conversations/{cuuid}/messages/{uuid}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"type": "incoming",
"status": "pending",
"conversation_id": 123,
"conversation_uuid": "<string>",
"content": "<string>",
"text_content": "<string>",
"content_type": "html",
"private": true,
"sender_id": 123,
"sender_type": "agent",
"meta": {
"to": [
"<string>"
],
"cc": [
"<string>"
],
"bcc": [
"<string>"
],
"from": [
"<string>"
],
"subject": "<string>"
},
"attachments": [
{
"name": "<string>",
"size": 123,
"content": "aSDinaTvuI8gbWludGxpZnk=",
"content_id": "<string>",
"content_type": "<string>",
"disposition": "inline",
"uuid": "<string>",
"url": "<string>",
"thumbnail_url": "<string>"
}
],
"author": {
"id": 123,
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"avatar_url": "<string>",
"availability_status": "<string>",
"type": "agent",
"last_active_at": "2023-11-07T05:31:56Z"
}
}
}{
"status": "error",
"message": "Invalid request",
"data": "<unknown>",
"error_type": "GeneralException"
}{
"status": "error",
"message": "Invalid request",
"data": "<unknown>",
"error_type": "GeneralException"
}{
"status": "error",
"message": "Invalid request",
"data": "<unknown>",
"error_type": "GeneralException"
}{
"status": "error",
"message": "Invalid request",
"data": "<unknown>",
"error_type": "GeneralException"
}Authorizations
basicAuthtokenAuth
Basic authentication using base64 encoded API key and secret. Format: Authorization: Basic <base64(api_key:api_secret)>
Was this page helpful?