Create Ticket External Messages
Register Serval messages as already present in an external channel. This records external message links so the egresser will not re-send those messages to the external system. Use this after posting a summary of prior conversation to an external ticket to prevent the individual historical messages from being replayed. Pass a single message to register one, or many to register in bulk.
curl --request POST \
--url https://public.api.serval.com/v2/tickets/{ticket_id}/external-messages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"channelTarget": {
"email": {}
},
"messages": [
{
"messageId": "<string>",
"externalMessageId": "<string>",
"externalMessageData": {}
}
]
}
'import requests
url = "https://public.api.serval.com/v2/tickets/{ticket_id}/external-messages"
payload = {
"channelTarget": { "email": {} },
"messages": [
{
"messageId": "<string>",
"externalMessageId": "<string>",
"externalMessageData": {}
}
]
}
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({
channelTarget: {email: {}},
messages: [
{messageId: '<string>', externalMessageId: '<string>', externalMessageData: {}}
]
})
};
fetch('https://public.api.serval.com/v2/tickets/{ticket_id}/external-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://public.api.serval.com/v2/tickets/{ticket_id}/external-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([
'channelTarget' => [
'email' => [
]
],
'messages' => [
[
'messageId' => '<string>',
'externalMessageId' => '<string>',
'externalMessageData' => [
]
]
]
]),
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 := "https://public.api.serval.com/v2/tickets/{ticket_id}/external-messages"
payload := strings.NewReader("{\n \"channelTarget\": {\n \"email\": {}\n },\n \"messages\": [\n {\n \"messageId\": \"<string>\",\n \"externalMessageId\": \"<string>\",\n \"externalMessageData\": {}\n }\n ]\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("https://public.api.serval.com/v2/tickets/{ticket_id}/external-messages")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"channelTarget\": {\n \"email\": {}\n },\n \"messages\": [\n {\n \"messageId\": \"<string>\",\n \"externalMessageId\": \"<string>\",\n \"externalMessageData\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.api.serval.com/v2/tickets/{ticket_id}/external-messages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channelTarget\": {\n \"email\": {}\n },\n \"messages\": [\n {\n \"messageId\": \"<string>\",\n \"externalMessageId\": \"<string>\",\n \"externalMessageData\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"externalMessageId": "<string>",
"messageId": "<string>",
"sourceId": "<string>",
"isOrigin": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"toRecipientEmails": [
"<string>"
],
"ccRecipientEmails": [
"<string>"
]
}
]
}{
"message": "<string>",
"detail": {
"type": "<string>",
"value": "<string>",
"debug": {}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The Serval ticket the messages belong to.
Body
The channel the messages should be registered against. Resolves to the same source the egresser uses to decide what to sync.
- Email
- Slack Channel
- Slack Dm
- Ticket Source
Show child attributes
Show child attributes
The messages to register as already present in the external channel. Provide one for a single registration or many for a bulk registration.
Show child attributes
Show child attributes
Response
Success
The external message links that were created or updated.
Show child attributes
Show child attributes
Was this page helpful?
curl --request POST \
--url https://public.api.serval.com/v2/tickets/{ticket_id}/external-messages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"channelTarget": {
"email": {}
},
"messages": [
{
"messageId": "<string>",
"externalMessageId": "<string>",
"externalMessageData": {}
}
]
}
'import requests
url = "https://public.api.serval.com/v2/tickets/{ticket_id}/external-messages"
payload = {
"channelTarget": { "email": {} },
"messages": [
{
"messageId": "<string>",
"externalMessageId": "<string>",
"externalMessageData": {}
}
]
}
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({
channelTarget: {email: {}},
messages: [
{messageId: '<string>', externalMessageId: '<string>', externalMessageData: {}}
]
})
};
fetch('https://public.api.serval.com/v2/tickets/{ticket_id}/external-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://public.api.serval.com/v2/tickets/{ticket_id}/external-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([
'channelTarget' => [
'email' => [
]
],
'messages' => [
[
'messageId' => '<string>',
'externalMessageId' => '<string>',
'externalMessageData' => [
]
]
]
]),
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 := "https://public.api.serval.com/v2/tickets/{ticket_id}/external-messages"
payload := strings.NewReader("{\n \"channelTarget\": {\n \"email\": {}\n },\n \"messages\": [\n {\n \"messageId\": \"<string>\",\n \"externalMessageId\": \"<string>\",\n \"externalMessageData\": {}\n }\n ]\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("https://public.api.serval.com/v2/tickets/{ticket_id}/external-messages")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"channelTarget\": {\n \"email\": {}\n },\n \"messages\": [\n {\n \"messageId\": \"<string>\",\n \"externalMessageId\": \"<string>\",\n \"externalMessageData\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.api.serval.com/v2/tickets/{ticket_id}/external-messages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channelTarget\": {\n \"email\": {}\n },\n \"messages\": [\n {\n \"messageId\": \"<string>\",\n \"externalMessageId\": \"<string>\",\n \"externalMessageData\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"externalMessageId": "<string>",
"messageId": "<string>",
"sourceId": "<string>",
"isOrigin": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"toRecipientEmails": [
"<string>"
],
"ccRecipientEmails": [
"<string>"
]
}
]
}{
"message": "<string>",
"detail": {
"type": "<string>",
"value": "<string>",
"debug": {}
}
}
