Interface IMessagingAgent

Interface for the Messaging Agent SMS and other external messaging systems

Online Restricted: This agent is not available in Online by default. Access must be requested specifically when app is registered.

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

[Agent("Messaging Agent", "Interface for the Messaging Agent. SMS and other external messaging systems")]
public interface IMessagingAgent : IAgent

Examples

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   using (MessagingAgent agent = new MessagingAgent())
   {
      // call methods on agent here...
   }
}

Methods

CreateMessageAsync(IncomingMessage, CancellationToken)

Create a new message and insert it in the message queue. (inbox)

Online Restricted: The Messaging agent is not available in Online by default. Access must be requested specifically when app is registered.

Declaration

Task CreateMessageAsync(IncomingMessage incomingMessage, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IncomingMessage	incomingMessage
CancellationToken	cancellationToken

Returns

Type	Description
Task

GetDeliveryStatusAsync(int[], CancellationToken)

Get delivery status

Online Restricted: The Messaging agent is not available in Online by default. Access must be requested specifically when app is registered.

Declaration

Task<MessageDeliveryStatus[]> GetDeliveryStatusAsync(int[] messagingIds, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int[]	messagingIds	Array of messaging ids.
CancellationToken	cancellationToken

Returns

Type	Description
Task<MessageDeliveryStatus[]>

GetPluginsAsync(CancellationToken)

Online Restricted: The Messaging agent is not available in Online by default. Access must be requested specifically when app is registered.

Declaration

Task<ProviderInfo[]> GetPluginsAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<ProviderInfo[]>

SendMessagesAsync(string, OutgoingMessage[], CancellationToken)

Send an array of messages

Online Restricted: The Messaging agent is not available in Online by default. Access must be requested specifically when app is registered.

Declaration

Task<MessageDeliveryStatus[]> SendMessagesAsync(string plugin, OutgoingMessage[] outgoingMessages, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	plugin	Name of plugin to use.
OutgoingMessage[]	outgoingMessages	Array of outgoing messages you want to send.
CancellationToken	cancellationToken

Returns

Type	Description
Task<MessageDeliveryStatus[]>	Array of MessageDeliveryStatus. Length of the array is equal to the number of outgoing messages.

SendMessagesWithConfigAsync(string, OutgoingMessage[], StringDictionary, CancellationToken)

Send an array of messages using given config

Online Restricted: The Messaging agent is not available in Online by default. Access must be requested specifically when app is registered.

Declaration

Task<MessageDeliveryStatus[]> SendMessagesWithConfigAsync(string plugin, OutgoingMessage[] outgoingMessages, StringDictionary config, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	plugin	Name of plugin to use.
OutgoingMessage[]	outgoingMessages	Array of outgoing messages you want to send.
StringDictionary	config	Config values used by the plugin.
CancellationToken	cancellationToken

Returns

Type	Description
Task<MessageDeliveryStatus[]>	Array of MessageDeliveryStatus. Length of the array is equal to the number of outgoing messages.

SetDeliveryStatusAsync(string, string, int, string, CancellationToken)

Set or change the delivery status on an outgoing messsage.

Online Restricted: The Messaging agent is not available in Online by default. Access must be requested specifically when app is registered.

Declaration

Task SetDeliveryStatusAsync(string plugin, string externalMessageId, int status, string statusDescription, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	plugin	Name of plugin
string	externalMessageId	External message id known to plugin.
int	status	Delivery status
string	statusDescription	String describing delivery status.
CancellationToken	cancellationToken

Returns

Type	Description
Task