NSCustomerServiceAgent

Agent used for Customer Service methods.

Constructors

NSCustomerServiceAgent()

NSCustomerServiceAgent

Agent used for Customer Service methods.

Methods

AddMessageFromMailData(Integer,String)

Adds a message to an existing request in the sam way as importMail would do it from an email.

NSTicketInfo AddMessageFromMailData(Integer ticketId, String data)

Returns: CRMScript.NetServer.NSTicketInfo Example:

NSCustomerServiceAgent agent;
Integer ticketId;
String data;
NSTicketInfo res = agent.AddMessageFromMailData(ticketId, data);

ChatSessionsForUser()

Gets all chat TOPICS which this user is a member of.

NSChatSession[] ChatSessionsForUser()

Returns: CRMScript.NetServer.NSChatSession[] - chat topics.

Members means that you have at least one of: Can Respond, Notifications, Listen or Manager

Example:

NSCustomerServiceAgent agent;
NSChatSession[] res = agent.ChatSessionsForUser();

CheckIfCustomizedTemplates()

Checks whether the core HTML templates are customized

Bool CheckIfCustomizedTemplates()

Returns: CRMScript.Global.Bool Example:

NSCustomerServiceAgent agent;
Bool res = agent.CheckIfCustomizedTemplates();

CheckSymmetricEncryption(String)

Checks that we are using the same encryption keys

String CheckSymmetricEncryption(String encryptedString)

Returns: CRMScript.Global.String Example:

NSCustomerServiceAgent agent;
String encryptedString;
String res = agent.CheckSymmetricEncryption(encryptedString);

CreateDefaultCustomerCenterConfig()

Sets default values into a new NSCustomerCenterConfig.

NSCustomerCenterConfig CreateDefaultCustomerCenterConfig()

Returns: CRMScript.NetServer.NSCustomerCenterConfig

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Example:

NSCustomerServiceAgent agent;
NSCustomerCenterConfig thing = agent.CreateDefaultCustomerCenterConfig();
thing = agent.SaveCustomerCenterConfig(thing);

CreateDefaultMailboxEntity()

Sets default values into a new NSMailboxEntity

NSMailboxEntity CreateDefaultMailboxEntity()

Returns: CRMScript.NetServer.NSMailboxEntity

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Example:

NSCustomerServiceAgent agent;
NSMailboxEntity thing = agent.CreateDefaultMailboxEntity();
thing = agent.SaveMailboxEntity(thing);

CreateDefaultSmsConfig()

Sets default values into a new NSSmsConfig.

NSSmsConfig CreateDefaultSmsConfig()

Returns: CRMScript.NetServer.NSSmsConfig

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Example:

NSCustomerServiceAgent agent;
NSSmsConfig thing = agent.CreateDefaultSmsConfig();
thing = agent.SaveSmsConfig(thing);

CreateSession(String)

Creates a login session for a CS user

NSCsSessionKey CreateSession(String remoteIp)

Returns: CRMScript.NetServer.NSCsSessionKey Example:

NSCustomerServiceAgent agent;
String remoteIp;
NSCsSessionKey res = agent.CreateSession(remoteIp);

CreateTicketFromMailData(Integer,String)

Creates a new ticket in the same way as importMail would import an email.

NSTicketInfo CreateTicketFromMailData(Integer mailboxId, String data)

Returns: CRMScript.NetServer.NSTicketInfo Example:

NSCustomerServiceAgent agent;
Integer mailboxId;
String data;
NSTicketInfo res = agent.CreateTicketFromMailData(mailboxId, data);

DeleteChatSessions(Integer[])

Deletes the specified chat sessions.

Void DeleteChatSessions(Integer[] ids)

Returns: CRMScript.Global.Void Example:

NSCustomerServiceAgent agent;
Integer[] ids;
agent.DeleteChatSessions(ids);

DeleteCustomerCenterConfig(Integer)

Deletes the NSCustomerCenterConfig

DeleteCustomerCenterConfig(Integer customerCenterConfig)

Returns: CRMScript.Global.Void Example:

NSCustomerServiceAgent agent;
agent.DeleteCustomerCenterConfig(123);

EventHandlerExists(Integer)

Checks if an event handler exists.

Bool EventHandlerExists(Integer eventHandlerType)

Returns: CRMScript.Global.Bool Example:

NSCustomerServiceAgent agent;
Integer eventHandlerType;
Bool res = agent.EventHandlerExists(eventHandlerType);

ExecuteEventHandlers(NSEventData)

Executes event handlers in CRMScript for a given event.

NSEventData ExecuteEventHandlers(NSEventData eventData)

Returns: CRMScript.NetServer.NSEventData Example:

NSCustomerServiceAgent agent;
NSEventData eventData;
NSEventData res = agent.ExecuteEventHandlers(eventData);

FindTicketsByTitleOrId(String,Integer)

Searches for tickets matching title or ID

NSTicketInfo[] FindTicketsByTitleOrId(String titleOrId, Integer maxRows)

Returns: CRMScript.NetServer.NSTicketInfo[] Example:

NSCustomerServiceAgent agent;
String titleOrId;
Integer maxRows;
NSTicketInfo[] res = agent.FindTicketsByTitleOrId(titleOrId, maxRows);

GetAllCustomerCenterConfigs()

Gets all rows from cust_config as an array of NSCustomerCenterConfig entities

NSCustomerCenterConfig[] GetAllCustomerCenterConfigs()

Returns: CRMScript.NetServer.NSCustomerCenterConfig[] Example:

NSCustomerServiceAgent agent;
NSCustomerCenterConfig[] res = agent.GetAllCustomerCenterConfigs();

GetCustomerCenterConfig(Integer)

Gets an NSCustomerCenterConfig object.

NSCustomerCenterConfig GetCustomerCenterConfig(Integer customerCenterConfigId)

Returns: CRMScript.NetServer.NSCustomerCenterConfig Example:

NSCustomerServiceAgent agent;
NSCustomerCenterConfig thing = agent.GetCustomerCenterConfig(123);

GetCustomerServiceStartup()

Gets the carrier with data that Service needs when starting up

NSCustomerServiceStartup GetCustomerServiceStartup()

Returns: CRMScript.NetServer.NSCustomerServiceStartup Example:

NSCustomerServiceAgent agent;
NSCustomerServiceStartup res = agent.GetCustomerServiceStartup();

GetMailboxEntity(Integer)

Gets an NSMailboxEntity object.

NSMailboxEntity GetMailboxEntity(Integer mailboxEntityId)

Returns: CRMScript.NetServer.NSMailboxEntity Example:

NSCustomerServiceAgent agent;
NSMailboxEntity thing = agent.GetMailboxEntity(123);

GetMailboxes()

Gets all registered mailboxes in Service

NSMailbox[] GetMailboxes()

Returns: CRMScript.NetServer.NSMailbox[] Example:

NSCustomerServiceAgent agent;
NSMailbox[] res = agent.GetMailboxes();

GetProgramUrl(String,Bool)

Converts a module name into a Service URL.

String GetProgramUrl(String programName, Bool external)

Returns: CRMScript.Global.String Example:

NSCustomerServiceAgent agent;
String programName;
Bool external;
String res = agent.GetProgramUrl(programName, external);

GetSmsConfig()

Gets the NSSmsConfig settings for Customer Service SMS providers.

NSSmsConfig GetSmsConfig()

Returns: CRMScript.NetServer.NSSmsConfig Example:

NSCustomerServiceAgent agent;
NSSmsConfig res = agent.GetSmsConfig();

GetStatistics()

Gets the calculated results for the required statistics for the Service Status page

CRMScript.NetServer.NSStatisticsDataSet[] GetStatistics(Integer[] functions)

Returns: CRMScript.NetServer.NSStatisticsDataSet[] - Array of StatisticsDataSet. Example:

NSCustomerServiceAgent agent;
Integer[] functions;
NSStatisticsDataSet[] res = agent.GetStatistics(functions);

HasChatNotify()

Checks if user has any chat notification

Bool HasChatNotify()

Returns: CRMScript.Global.Bool Example:

NSCustomerServiceAgent agent;
Bool res = agent.HasChatNotify();

RemoveSession(Integer)

Removes a login session for a Service user

Void RemoveSession(Integer loginId)

Returns: CRMScript.Global.Void

SaveAllCustomerCenterConfigs(NSCustomerCenterConfig[])

Saves an array of NSCustomerCenterConfig entities to the database

Void SaveAllCustomerCenterConfigs(NSCustomerCenterConfig[] custConfigs)

Returns: CRMScript.Global.Void Example:

NSCustomerServiceAgent agent;
agent.SaveAllCustomerCenterConfigs(custConfigs);

SaveCustomerCenterConfig(NSCustomerCenterConfig)

Updates the existing NSCustomerCenterConfig or creates a new NSCustomerCenterConfig if the id parameter is 0

NSCustomerCenterConfig SaveCustomerCenterConfig(NSCustomerCenterConfig customerCenterConfig)

Returns: CRMScript.NetServer.NSCustomerCenterConfig Example:

NSCustomerService  agent;
NSCustomerCenterConfig thing = agent.CreateDefaultCustomerCenterConfig();
thing = agent.SaveCustomerCenterConfig(thing);

SaveMailboxEntity(NSMailboxEntity)

Updates the existing NSMailboxEntity or creates a new NSMailboxEntity if the ID parameter is 0

NSMailboxEntity SaveMailboxEntity(NSMailboxEntity mailboxEntity)

Returns: CRMScript.NetServer.NSMailboxEntity Example:

NSCustomerService  agent;
NSMailboxEntity thing = agent.CreateDefaultMailboxEntity();
thing = agent.SaveMailboxEntity(thing);

SaveSmsConfig(NSSmsConfig)

Updates the existing NSSmsConfig or creates a new NSSmsConfig if the ID parameter is 0

NSSmsConfig SaveSmsConfig(NSSmsConfig smsConfig)

Returns: CRMScript.NetServer.NSSmsConfig Example:

NSCustomerService  agent;
NSSmsConfig thing = agent.CreateDefaultSmsConfig();
thing = agent.SaveSmsConfig(thing);

SessionIsValid(String)

Checks if a Service session is valid

Bool SessionIsValid(String csSessionKey)

Returns: CRMScript.Global.Bool Example:

NSCustomerServiceAgent agent;
String csSessionKey;
Bool res = agent.SessionIsValid(csSessionKey);

TestSmtpServer(String,String,Bool)

Tests an SMTP account, by sending an email to a special @superoffice.com account

NSSmtpTestResult TestSmtpServer(String smtpUri, String from, Bool useStoredPassword)

Returns: CRMScript.NetServer.NSSmtpTestResult Example:

NSCustomerServiceAgent agent;
String smtpUri;
String from;
Bool useStoredPassword;
NSSmtpTestResult res = agent.TestSmtpServer(smtpUri, from, useStoredPassword);

UpdateFeatureToggles(CsFeatureToggle[])

Updates the cached FeatureToggles for Service

Void UpdateFeatureToggles(CsFeatureToggle[] featureToggles)

Returns: CRMScript.Global.Void

​Constructors

​NSCustomerServiceAgent()

​Methods

​AddMessageFromMailData(Integer,String)

​ChatSessionsForUser()

​CheckIfCustomizedTemplates()

​CheckSymmetricEncryption(String)

​CreateDefaultCustomerCenterConfig()

​CreateDefaultMailboxEntity()

​CreateDefaultSmsConfig()

​CreateSession(String)

​CreateTicketFromMailData(Integer,String)

​DeleteChatSessions(Integer[])

​DeleteCustomerCenterConfig(Integer)

​EventHandlerExists(Integer)

​ExecuteEventHandlers(NSEventData)

​FindTicketsByTitleOrId(String,Integer)

​GetAllCustomerCenterConfigs()

​GetCustomerCenterConfig(Integer)

​GetCustomerServiceStartup()

​GetMailboxEntity(Integer)

​GetMailboxes()

​GetProgramUrl(String,Bool)

​GetSmsConfig()

​GetStatistics()

​HasChatNotify()

​RemoveSession(Integer)

​SaveAllCustomerCenterConfigs(NSCustomerCenterConfig[])

​SaveCustomerCenterConfig(NSCustomerCenterConfig)

​SaveMailboxEntity(NSMailboxEntity)

​SaveSmsConfig(NSSmsConfig)

​SessionIsValid(String)

​TestSmtpServer(String,String,Bool)

​UpdateFeatureToggles(CsFeatureToggle[])

Constructors

NSCustomerServiceAgent()

Methods

AddMessageFromMailData(Integer,String)

ChatSessionsForUser()

CheckIfCustomizedTemplates()

CheckSymmetricEncryption(String)

CreateDefaultCustomerCenterConfig()

CreateDefaultMailboxEntity()

CreateDefaultSmsConfig()

CreateSession(String)

CreateTicketFromMailData(Integer,String)

DeleteChatSessions(Integer[])

DeleteCustomerCenterConfig(Integer)

EventHandlerExists(Integer)

ExecuteEventHandlers(NSEventData)

FindTicketsByTitleOrId(String,Integer)

GetAllCustomerCenterConfigs()

GetCustomerCenterConfig(Integer)

GetCustomerServiceStartup()

GetMailboxEntity(Integer)

GetMailboxes()

GetProgramUrl(String,Bool)

GetSmsConfig()

GetStatistics()

HasChatNotify()

RemoveSession(Integer)

SaveAllCustomerCenterConfigs(NSCustomerCenterConfig[])

SaveCustomerCenterConfig(NSCustomerCenterConfig)

SaveMailboxEntity(NSMailboxEntity)

SaveSmsConfig(NSSmsConfig)

SessionIsValid(String)

TestSmtpServer(String,String,Bool)

UpdateFeatureToggles(CsFeatureToggle[])