using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Messaging/CreateMessage");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"IncomingMessage\": {\n \"To\": \"<string>\",\n \"From\": \"<string>\",\n \"Content\": \"<string>\",\n \"Format\": \"<string>\",\n \"SessionKey\": \"<string>\",\n \"Plugin\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
IncomingMessage: {
To: '<string>',
From: '<string>',
Content: '<string>',
Format: '<string>',
SessionKey: '<string>',
Plugin: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/Messaging/CreateMessage', 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 => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Messaging/CreateMessage",
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([
'IncomingMessage' => [
'To' => '<string>',
'From' => '<string>',
'Content' => '<string>',
'Format' => '<string>',
'SessionKey' => '<string>',
'Plugin' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
]),
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;
}import requests
url = "http://localhost:56350/api/v1/Agents/Messaging/CreateMessage"
payload = { "IncomingMessage": {
"To": "<string>",
"From": "<string>",
"Content": "<string>",
"Format": "<string>",
"SessionKey": "<string>",
"Plugin": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
} }
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({
IncomingMessage: {
To: '<string>',
From: '<string>',
Content: '<string>',
Format: '<string>',
SessionKey: '<string>',
Plugin: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/Messaging/CreateMessage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Create a new message and insert it in the message queue.
(inbox)
NsApiSlow threshold: 5000 ms.
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Messaging/CreateMessage");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"IncomingMessage\": {\n \"To\": \"<string>\",\n \"From\": \"<string>\",\n \"Content\": \"<string>\",\n \"Format\": \"<string>\",\n \"SessionKey\": \"<string>\",\n \"Plugin\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
IncomingMessage: {
To: '<string>',
From: '<string>',
Content: '<string>',
Format: '<string>',
SessionKey: '<string>',
Plugin: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/Messaging/CreateMessage', 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 => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Messaging/CreateMessage",
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([
'IncomingMessage' => [
'To' => '<string>',
'From' => '<string>',
'Content' => '<string>',
'Format' => '<string>',
'SessionKey' => '<string>',
'Plugin' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
]),
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;
}import requests
url = "http://localhost:56350/api/v1/Agents/Messaging/CreateMessage"
payload = { "IncomingMessage": {
"To": "<string>",
"From": "<string>",
"Content": "<string>",
"Format": "<string>",
"SessionKey": "<string>",
"Plugin": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
} }
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({
IncomingMessage: {
To: '<string>',
From: '<string>',
Content: '<string>',
Format: '<string>',
SessionKey: '<string>',
Plugin: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/Messaging/CreateMessage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Headers
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
IncomingMessage
CreateMessage: Create a new message and insert it in the message queue. (inbox)
Details about a message to be sent Carrier object for IncomingMessage. Services for the IncomingMessage Carrier is available from the Messaging Agent.
Show child attributes
Show child attributes
Response
No Content
Related topics
Create and update messagesCreate E Mail From Mime MessageCreate Default Shipment Message EntityCreate Default Ticket Message EntityCreate Default Shipment Message Block EntityCreate SuperOffice CRM Request Message action