Create a new message
curl --request POST \
--url https://api.gleap.io/v3/messages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'project: <project>' \
--data '
{
"user": "<string>",
"session": "<string>",
"bot": true,
"fallbackUser": {
"username": "<string>",
"email": "<string>",
"imageUrl": "<string>"
},
"messageRef": "<string>",
"ticket": "<string>",
"data": "<unknown>",
"translatedData": "<unknown>",
"type": "<string>",
"emailId": "<string>",
"sessionNotificationsUnread": true,
"outbound": "<string>",
"outboundTemplate": "<string>",
"outboundSubject": "<string>",
"status": "<unknown>",
"statusHistory": [
"<unknown>"
],
"comment": "<unknown>",
"replyTo": "<string>",
"kaiChat": true,
"aiData": "<unknown>",
"attachments": [
{
"name": "<string>",
"url": "<string>",
"type": "<string>"
}
],
"actions": [
{
"type": "<string>",
"data": "<unknown>"
}
],
"sendToChannel": true,
"isNote": true,
"rating": "<string>"
}
'import requests
url = "https://api.gleap.io/v3/messages"
payload = {
"user": "<string>",
"session": "<string>",
"bot": True,
"fallbackUser": {
"username": "<string>",
"email": "<string>",
"imageUrl": "<string>"
},
"messageRef": "<string>",
"ticket": "<string>",
"data": "<unknown>",
"translatedData": "<unknown>",
"type": "<string>",
"emailId": "<string>",
"sessionNotificationsUnread": True,
"outbound": "<string>",
"outboundTemplate": "<string>",
"outboundSubject": "<string>",
"status": "<unknown>",
"statusHistory": ["<unknown>"],
"comment": "<unknown>",
"replyTo": "<string>",
"kaiChat": True,
"aiData": "<unknown>",
"attachments": [
{
"name": "<string>",
"url": "<string>",
"type": "<string>"
}
],
"actions": [
{
"type": "<string>",
"data": "<unknown>"
}
],
"sendToChannel": True,
"isNote": True,
"rating": "<string>"
}
headers = {
"project": "<project>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
project: '<project>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
user: '<string>',
session: '<string>',
bot: true,
fallbackUser: {username: '<string>', email: '<string>', imageUrl: '<string>'},
messageRef: '<string>',
ticket: '<string>',
data: '<unknown>',
translatedData: '<unknown>',
type: '<string>',
emailId: '<string>',
sessionNotificationsUnread: true,
outbound: '<string>',
outboundTemplate: '<string>',
outboundSubject: '<string>',
status: '<unknown>',
statusHistory: ['<unknown>'],
comment: '<unknown>',
replyTo: '<string>',
kaiChat: true,
aiData: '<unknown>',
attachments: [{name: '<string>', url: '<string>', type: '<string>'}],
actions: [{type: '<string>', data: '<unknown>'}],
sendToChannel: true,
isNote: true,
rating: '<string>'
})
};
fetch('https://api.gleap.io/v3/messages', 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://api.gleap.io/v3/messages",
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([
'user' => '<string>',
'session' => '<string>',
'bot' => true,
'fallbackUser' => [
'username' => '<string>',
'email' => '<string>',
'imageUrl' => '<string>'
],
'messageRef' => '<string>',
'ticket' => '<string>',
'data' => '<unknown>',
'translatedData' => '<unknown>',
'type' => '<string>',
'emailId' => '<string>',
'sessionNotificationsUnread' => true,
'outbound' => '<string>',
'outboundTemplate' => '<string>',
'outboundSubject' => '<string>',
'status' => '<unknown>',
'statusHistory' => [
'<unknown>'
],
'comment' => '<unknown>',
'replyTo' => '<string>',
'kaiChat' => true,
'aiData' => '<unknown>',
'attachments' => [
[
'name' => '<string>',
'url' => '<string>',
'type' => '<string>'
]
],
'actions' => [
[
'type' => '<string>',
'data' => '<unknown>'
]
],
'sendToChannel' => true,
'isNote' => true,
'rating' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"project: <project>"
],
]);
$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://api.gleap.io/v3/messages"
payload := strings.NewReader("{\n \"user\": \"<string>\",\n \"session\": \"<string>\",\n \"bot\": true,\n \"fallbackUser\": {\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"imageUrl\": \"<string>\"\n },\n \"messageRef\": \"<string>\",\n \"ticket\": \"<string>\",\n \"data\": \"<unknown>\",\n \"translatedData\": \"<unknown>\",\n \"type\": \"<string>\",\n \"emailId\": \"<string>\",\n \"sessionNotificationsUnread\": true,\n \"outbound\": \"<string>\",\n \"outboundTemplate\": \"<string>\",\n \"outboundSubject\": \"<string>\",\n \"status\": \"<unknown>\",\n \"statusHistory\": [\n \"<unknown>\"\n ],\n \"comment\": \"<unknown>\",\n \"replyTo\": \"<string>\",\n \"kaiChat\": true,\n \"aiData\": \"<unknown>\",\n \"attachments\": [\n {\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"actions\": [\n {\n \"type\": \"<string>\",\n \"data\": \"<unknown>\"\n }\n ],\n \"sendToChannel\": true,\n \"isNote\": true,\n \"rating\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("project", "<project>")
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://api.gleap.io/v3/messages")
.header("project", "<project>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user\": \"<string>\",\n \"session\": \"<string>\",\n \"bot\": true,\n \"fallbackUser\": {\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"imageUrl\": \"<string>\"\n },\n \"messageRef\": \"<string>\",\n \"ticket\": \"<string>\",\n \"data\": \"<unknown>\",\n \"translatedData\": \"<unknown>\",\n \"type\": \"<string>\",\n \"emailId\": \"<string>\",\n \"sessionNotificationsUnread\": true,\n \"outbound\": \"<string>\",\n \"outboundTemplate\": \"<string>\",\n \"outboundSubject\": \"<string>\",\n \"status\": \"<unknown>\",\n \"statusHistory\": [\n \"<unknown>\"\n ],\n \"comment\": \"<unknown>\",\n \"replyTo\": \"<string>\",\n \"kaiChat\": true,\n \"aiData\": \"<unknown>\",\n \"attachments\": [\n {\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"actions\": [\n {\n \"type\": \"<string>\",\n \"data\": \"<unknown>\"\n }\n ],\n \"sendToChannel\": true,\n \"isNote\": true,\n \"rating\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gleap.io/v3/messages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["project"] = '<project>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user\": \"<string>\",\n \"session\": \"<string>\",\n \"bot\": true,\n \"fallbackUser\": {\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"imageUrl\": \"<string>\"\n },\n \"messageRef\": \"<string>\",\n \"ticket\": \"<string>\",\n \"data\": \"<unknown>\",\n \"translatedData\": \"<unknown>\",\n \"type\": \"<string>\",\n \"emailId\": \"<string>\",\n \"sessionNotificationsUnread\": true,\n \"outbound\": \"<string>\",\n \"outboundTemplate\": \"<string>\",\n \"outboundSubject\": \"<string>\",\n \"status\": \"<unknown>\",\n \"statusHistory\": [\n \"<unknown>\"\n ],\n \"comment\": \"<unknown>\",\n \"replyTo\": \"<string>\",\n \"kaiChat\": true,\n \"aiData\": \"<unknown>\",\n \"attachments\": [\n {\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"actions\": [\n {\n \"type\": \"<string>\",\n \"data\": \"<unknown>\"\n }\n ],\n \"sendToChannel\": true,\n \"isNote\": true,\n \"rating\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ticket": "507f1f77bcf86cd799439011",
"comment": {
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Thank you for reporting this issue. We are looking into it."
}
]
},
"type": "COMMENT",
"bot": false,
"attachments": [
{
"name": "screenshot.png",
"url": "https://example.com/screenshots/screenshot.png",
"type": "image/png"
}
]
}Messages
Create a new message
Create a new message
POST
/
messages
Create a new message
curl --request POST \
--url https://api.gleap.io/v3/messages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'project: <project>' \
--data '
{
"user": "<string>",
"session": "<string>",
"bot": true,
"fallbackUser": {
"username": "<string>",
"email": "<string>",
"imageUrl": "<string>"
},
"messageRef": "<string>",
"ticket": "<string>",
"data": "<unknown>",
"translatedData": "<unknown>",
"type": "<string>",
"emailId": "<string>",
"sessionNotificationsUnread": true,
"outbound": "<string>",
"outboundTemplate": "<string>",
"outboundSubject": "<string>",
"status": "<unknown>",
"statusHistory": [
"<unknown>"
],
"comment": "<unknown>",
"replyTo": "<string>",
"kaiChat": true,
"aiData": "<unknown>",
"attachments": [
{
"name": "<string>",
"url": "<string>",
"type": "<string>"
}
],
"actions": [
{
"type": "<string>",
"data": "<unknown>"
}
],
"sendToChannel": true,
"isNote": true,
"rating": "<string>"
}
'import requests
url = "https://api.gleap.io/v3/messages"
payload = {
"user": "<string>",
"session": "<string>",
"bot": True,
"fallbackUser": {
"username": "<string>",
"email": "<string>",
"imageUrl": "<string>"
},
"messageRef": "<string>",
"ticket": "<string>",
"data": "<unknown>",
"translatedData": "<unknown>",
"type": "<string>",
"emailId": "<string>",
"sessionNotificationsUnread": True,
"outbound": "<string>",
"outboundTemplate": "<string>",
"outboundSubject": "<string>",
"status": "<unknown>",
"statusHistory": ["<unknown>"],
"comment": "<unknown>",
"replyTo": "<string>",
"kaiChat": True,
"aiData": "<unknown>",
"attachments": [
{
"name": "<string>",
"url": "<string>",
"type": "<string>"
}
],
"actions": [
{
"type": "<string>",
"data": "<unknown>"
}
],
"sendToChannel": True,
"isNote": True,
"rating": "<string>"
}
headers = {
"project": "<project>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
project: '<project>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
user: '<string>',
session: '<string>',
bot: true,
fallbackUser: {username: '<string>', email: '<string>', imageUrl: '<string>'},
messageRef: '<string>',
ticket: '<string>',
data: '<unknown>',
translatedData: '<unknown>',
type: '<string>',
emailId: '<string>',
sessionNotificationsUnread: true,
outbound: '<string>',
outboundTemplate: '<string>',
outboundSubject: '<string>',
status: '<unknown>',
statusHistory: ['<unknown>'],
comment: '<unknown>',
replyTo: '<string>',
kaiChat: true,
aiData: '<unknown>',
attachments: [{name: '<string>', url: '<string>', type: '<string>'}],
actions: [{type: '<string>', data: '<unknown>'}],
sendToChannel: true,
isNote: true,
rating: '<string>'
})
};
fetch('https://api.gleap.io/v3/messages', 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://api.gleap.io/v3/messages",
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([
'user' => '<string>',
'session' => '<string>',
'bot' => true,
'fallbackUser' => [
'username' => '<string>',
'email' => '<string>',
'imageUrl' => '<string>'
],
'messageRef' => '<string>',
'ticket' => '<string>',
'data' => '<unknown>',
'translatedData' => '<unknown>',
'type' => '<string>',
'emailId' => '<string>',
'sessionNotificationsUnread' => true,
'outbound' => '<string>',
'outboundTemplate' => '<string>',
'outboundSubject' => '<string>',
'status' => '<unknown>',
'statusHistory' => [
'<unknown>'
],
'comment' => '<unknown>',
'replyTo' => '<string>',
'kaiChat' => true,
'aiData' => '<unknown>',
'attachments' => [
[
'name' => '<string>',
'url' => '<string>',
'type' => '<string>'
]
],
'actions' => [
[
'type' => '<string>',
'data' => '<unknown>'
]
],
'sendToChannel' => true,
'isNote' => true,
'rating' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"project: <project>"
],
]);
$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://api.gleap.io/v3/messages"
payload := strings.NewReader("{\n \"user\": \"<string>\",\n \"session\": \"<string>\",\n \"bot\": true,\n \"fallbackUser\": {\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"imageUrl\": \"<string>\"\n },\n \"messageRef\": \"<string>\",\n \"ticket\": \"<string>\",\n \"data\": \"<unknown>\",\n \"translatedData\": \"<unknown>\",\n \"type\": \"<string>\",\n \"emailId\": \"<string>\",\n \"sessionNotificationsUnread\": true,\n \"outbound\": \"<string>\",\n \"outboundTemplate\": \"<string>\",\n \"outboundSubject\": \"<string>\",\n \"status\": \"<unknown>\",\n \"statusHistory\": [\n \"<unknown>\"\n ],\n \"comment\": \"<unknown>\",\n \"replyTo\": \"<string>\",\n \"kaiChat\": true,\n \"aiData\": \"<unknown>\",\n \"attachments\": [\n {\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"actions\": [\n {\n \"type\": \"<string>\",\n \"data\": \"<unknown>\"\n }\n ],\n \"sendToChannel\": true,\n \"isNote\": true,\n \"rating\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("project", "<project>")
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://api.gleap.io/v3/messages")
.header("project", "<project>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user\": \"<string>\",\n \"session\": \"<string>\",\n \"bot\": true,\n \"fallbackUser\": {\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"imageUrl\": \"<string>\"\n },\n \"messageRef\": \"<string>\",\n \"ticket\": \"<string>\",\n \"data\": \"<unknown>\",\n \"translatedData\": \"<unknown>\",\n \"type\": \"<string>\",\n \"emailId\": \"<string>\",\n \"sessionNotificationsUnread\": true,\n \"outbound\": \"<string>\",\n \"outboundTemplate\": \"<string>\",\n \"outboundSubject\": \"<string>\",\n \"status\": \"<unknown>\",\n \"statusHistory\": [\n \"<unknown>\"\n ],\n \"comment\": \"<unknown>\",\n \"replyTo\": \"<string>\",\n \"kaiChat\": true,\n \"aiData\": \"<unknown>\",\n \"attachments\": [\n {\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"actions\": [\n {\n \"type\": \"<string>\",\n \"data\": \"<unknown>\"\n }\n ],\n \"sendToChannel\": true,\n \"isNote\": true,\n \"rating\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gleap.io/v3/messages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["project"] = '<project>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user\": \"<string>\",\n \"session\": \"<string>\",\n \"bot\": true,\n \"fallbackUser\": {\n \"username\": \"<string>\",\n \"email\": \"<string>\",\n \"imageUrl\": \"<string>\"\n },\n \"messageRef\": \"<string>\",\n \"ticket\": \"<string>\",\n \"data\": \"<unknown>\",\n \"translatedData\": \"<unknown>\",\n \"type\": \"<string>\",\n \"emailId\": \"<string>\",\n \"sessionNotificationsUnread\": true,\n \"outbound\": \"<string>\",\n \"outboundTemplate\": \"<string>\",\n \"outboundSubject\": \"<string>\",\n \"status\": \"<unknown>\",\n \"statusHistory\": [\n \"<unknown>\"\n ],\n \"comment\": \"<unknown>\",\n \"replyTo\": \"<string>\",\n \"kaiChat\": true,\n \"aiData\": \"<unknown>\",\n \"attachments\": [\n {\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"actions\": [\n {\n \"type\": \"<string>\",\n \"data\": \"<unknown>\"\n }\n ],\n \"sendToChannel\": true,\n \"isNote\": true,\n \"rating\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ticket": "507f1f77bcf86cd799439011",
"comment": {
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Thank you for reporting this issue. We are looking into it."
}
]
},
"type": "COMMENT",
"bot": false,
"attachments": [
{
"name": "screenshot.png",
"url": "https://example.com/screenshots/screenshot.png",
"type": "image/png"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
200 - application/json
Ok
⌘I