Send Messages With Config - SuperOffice

Send Messages With Config

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Messaging/SendMessagesWithConfig");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"Plugin\": \"<string>\",\n  \"OutgoingMessages\": [\n    {\n      \"From\": \"<string>\",\n      \"To\": \"<string>\",\n      \"Content\": \"<string>\",\n      \"Format\": \"<string>\",\n      \"ParentMessagingId\": 123,\n      \"SuggestedSessionKey\": \"<string>\",\n      \"TableRight\": {\n        \"Mask\": \"<string>\",\n        \"Reason\": \"<string>\"\n      },\n      \"FieldProperties\": {}\n    }\n  ],\n  \"Config\": {}\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({
    Plugin: '<string>',
    OutgoingMessages: [
      {
        From: '<string>',
        To: '<string>',
        Content: '<string>',
        Format: '<string>',
        ParentMessagingId: 123,
        SuggestedSessionKey: '<string>',
        TableRight: {Mask: '<string>', Reason: '<string>'},
        FieldProperties: {}
      }
    ],
    Config: {}
  })
};

fetch('http://localhost:56350/api/v1/Agents/Messaging/SendMessagesWithConfig', 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/SendMessagesWithConfig",
  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([
    'Plugin' => '<string>',
    'OutgoingMessages' => [
        [
                'From' => '<string>',
                'To' => '<string>',
                'Content' => '<string>',
                'Format' => '<string>',
                'ParentMessagingId' => 123,
                'SuggestedSessionKey' => '<string>',
                'TableRight' => [
                                'Mask' => '<string>',
                                'Reason' => '<string>'
                ],
                'FieldProperties' => [
                                
                ]
        ]
    ],
    'Config' => [
        
    ]
  ]),
  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/SendMessagesWithConfig"

payload = {
    "Plugin": "<string>",
    "OutgoingMessages": [
        {
            "From": "<string>",
            "To": "<string>",
            "Content": "<string>",
            "Format": "<string>",
            "ParentMessagingId": 123,
            "SuggestedSessionKey": "<string>",
            "TableRight": {
                "Mask": "<string>",
                "Reason": "<string>"
            },
            "FieldProperties": {}
        }
    ],
    "Config": {}
}
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({
    Plugin: '<string>',
    OutgoingMessages: [
      {
        From: '<string>',
        To: '<string>',
        Content: '<string>',
        Format: '<string>',
        ParentMessagingId: 123,
        SuggestedSessionKey: '<string>',
        TableRight: {Mask: '<string>', Reason: '<string>'},
        FieldProperties: {}
      }
    ],
    Config: {}
  })
};

fetch('http://localhost:56350/api/v1/Agents/Messaging/SendMessagesWithConfig', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "Status": 123,
    "StatusDescription": "<string>",
    "MessagingId": 123,
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  }
]

Send Messages With Config

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Messaging/SendMessagesWithConfig");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"Plugin\": \"<string>\",\n  \"OutgoingMessages\": [\n    {\n      \"From\": \"<string>\",\n      \"To\": \"<string>\",\n      \"Content\": \"<string>\",\n      \"Format\": \"<string>\",\n      \"ParentMessagingId\": 123,\n      \"SuggestedSessionKey\": \"<string>\",\n      \"TableRight\": {\n        \"Mask\": \"<string>\",\n        \"Reason\": \"<string>\"\n      },\n      \"FieldProperties\": {}\n    }\n  ],\n  \"Config\": {}\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({
    Plugin: '<string>',
    OutgoingMessages: [
      {
        From: '<string>',
        To: '<string>',
        Content: '<string>',
        Format: '<string>',
        ParentMessagingId: 123,
        SuggestedSessionKey: '<string>',
        TableRight: {Mask: '<string>', Reason: '<string>'},
        FieldProperties: {}
      }
    ],
    Config: {}
  })
};

fetch('http://localhost:56350/api/v1/Agents/Messaging/SendMessagesWithConfig', 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/SendMessagesWithConfig",
  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([
    'Plugin' => '<string>',
    'OutgoingMessages' => [
        [
                'From' => '<string>',
                'To' => '<string>',
                'Content' => '<string>',
                'Format' => '<string>',
                'ParentMessagingId' => 123,
                'SuggestedSessionKey' => '<string>',
                'TableRight' => [
                                'Mask' => '<string>',
                                'Reason' => '<string>'
                ],
                'FieldProperties' => [
                                
                ]
        ]
    ],
    'Config' => [
        
    ]
  ]),
  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/SendMessagesWithConfig"

payload = {
    "Plugin": "<string>",
    "OutgoingMessages": [
        {
            "From": "<string>",
            "To": "<string>",
            "Content": "<string>",
            "Format": "<string>",
            "ParentMessagingId": 123,
            "SuggestedSessionKey": "<string>",
            "TableRight": {
                "Mask": "<string>",
                "Reason": "<string>"
            },
            "FieldProperties": {}
        }
    ],
    "Config": {}
}
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({
    Plugin: '<string>',
    OutgoingMessages: [
      {
        From: '<string>',
        To: '<string>',
        Content: '<string>',
        Format: '<string>',
        ParentMessagingId: 123,
        SuggestedSessionKey: '<string>',
        TableRight: {Mask: '<string>', Reason: '<string>'},
        FieldProperties: {}
      }
    ],
    Config: {}
  })
};

fetch('http://localhost:56350/api/v1/Agents/Messaging/SendMessagesWithConfig', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "Status": 123,
    "StatusDescription": "<string>",
    "MessagingId": 123,
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  }
]

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select

string

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

Plugin, OutgoingMessages, Config

SendMessagesWithConfig: Send an array of messages using given config

Plugin

string

OutgoingMessages

object[]

Show child attributes

Config

object

Show child attributes

Response

OK

Status

integer<int32>

Current message status

StatusDescription

string

String describing the current message status.

MessagingId

integer<int32>

Id to the outgoing message table

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes

Related topics

NSMessagingAgent Send Messages Send Ticket Message Send System Message Send messages (email or SMS)

⌘I