NSChatAgent - SuperOffice

Chat functions. Manage chat channels, sessions, and messages.

Constructors

NSChatAgent()

NSChatAgent

Chat functions. Manage chat channels, sessions, and messages.

Methods

AcceptChatSessionTransfer(Integer)

Accept the transfer: assign the session to the user. If the session is not being transferred, nothing happens.

NSChatSessionEntity AcceptChatSessionTransfer(Integer chatSessionId)

Returns: CRMScript.NetServer.NSChatSessionEntity Example:

NSChatAgent agent;
Integer chatSessionId;
NSChatSessionEntity res = agent.AcceptChatSessionTransfer(chatSessionId);

AddChatMessage(Integer,NSChatMessage)

Adds a new message to a chat session

NSChatMessage AddChatMessage(Integer chatSessionId, NSChatMessage message)

Returns: CRMScript.NetServer.NSChatMessage Example:

NSChatAgent agent;
Integer chatSessionId;
NSChatMessage message;
NSChatMessage res = agent.AddChatMessage(chatSessionId, message);

AddChatTopicUserAgent(Integer,NSChatTopicAgent)

Adds a user to a chat topic

NSChatTopicAgent AddChatTopicUserAgent(Integer chatTopicId, NSChatTopicAgent useragent)

Returns: CRMScript.NetServer.NSChatTopicAgent Example:

NSChatAgent agent;
Integer chatTopicId;
NSChatTopicAgent useragent;
NSChatTopicAgent res = agent.AddChatTopicUserAgent(chatTopicId, useragent);

ChatSessionsForUser()

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

NSChatSessionEntity[] ChatSessionsForUser()

Returns: CRMScript.NetServer.NSChatSessionEntity[]

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

Example:

NSChatAgent agent;
NSChatSessionEntity[] res = agent.ChatSessionsForUser();

ChatTopicsForUser()

Gets all chat topics which this user is a member of.nd, Notifications, Listen or Manager.

NSChatTopicEntity[] ChatTopicsForUser()

Returns: CRMScript.NetServer.NSChatTopicEntity[]

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

Example:

NSChatAgent agent;
NSChatTopicEntity[] res = agent.ChatTopicsForUser();

CreateChatSessionForTopic(Integer)

Creates a new session on a chat topic

NSChatSessionEntity CreateChatSessionForTopic(Integer chatTopicId)

Returns: CRMScript.NetServer.NSChatSessionEntity Example:

NSChatAgent agent;
Integer chatTopicId;
NSChatSessionEntity res = agent.CreateChatSessionForTopic(chatTopicId);

CreateDefaultChatSessionEntity()

Sets default values into a new NSChatSessionEntity.

NSChatSessionEntity CreateDefaultChatSessionEntity()

Returns: CRMScript.NetServer.NSChatSessionEntity

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

Example:

NSChatAgent agent;
NSChatSessionEntity thing = agent.CreateDefaultChatSessionEntity();
thing = agent.SaveChatSessionEntity(thing);

CreateDefaultChatTopicAgent()

Sets default values into a new NSChatTopicAgent.

NSChatTopicAgent CreateDefaultChatTopicAgent()

Returns: CRMScript.NetServer.NSChatTopicAgent

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

Example:

NSChatAgent agent;
NSChatTopicAgent thing = agent.CreateDefaultChatTopicAgent();
thing = agent.SaveChatTopicAgent(thing);

CreateDefaultChatTopicEntity()

Sets default values into a new NSChatTopicEntity.

NSChatTopicEntity CreateDefaultChatTopicEntity()

Returns: CRMScript.NetServer.NSChatTopicEntity

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

Example:

NSChatAgent agent;
NSChatTopicEntity thing = agent.CreateDefaultChatTopicEntity();
thing = agent.SaveChatTopicEntity(thing);

DeleteChatSessionEntity(Integer)

Deletes the NSChatSessionEntity

Void DeleteChatSessionEntity(Integer chatSessionEntity)

Returns: CRMScript.Global.Void Example:

NSChatAgent agent;
agent.DeleteChatSessionEntity(123);

DeleteChatTopicEntity(Integer)

Deletes the NSChatTopicEntity

Void DeleteChatTopicEntity(Integer chatTopicEntity)

Returns: CRMScript.Global.Void Example:

NSChatAgent agent;
agent.DeleteChatTopicEntity(123);

DeleteChatTopicUserAgent(Integer,String)

Removes a user from a topic

Void DeleteChatTopicUserAgent(Integer chatTopicId, String username)

Returns: CRMScript.Global.Void Example:

NSChatAgent agent;
Integer chatTopicId;
String username;
agent.DeleteChatTopicUserAgent(chatTopicId, username);

GetChatMessages(Integer,Integer)

Gets all or some of the messages in a chat session

NSChatMessage[] GetChatMessages(Integer chatSessionId, Integer after)

Returns: CRMScript.NetServer.NSChatMessage[] Example:

NSChatAgent agent;
Integer chatSessionId;
Integer after;
NSChatMessage[] res = agent.GetChatMessages(chatSessionId, after);

GetChatPresence()

Gets the chat presence status for all chat users.

NSChatPresence[] GetChatPresence()

Returns: CRMScript.NetServer.NSChatPresence[] Example:

NSChatAgent agent;
NSChatPresence[] res = agent.GetChatPresence();

GetChatSessionEntity(Integer)

Gets an NSChatSessionEntity object.

NSChatSessionEntity GetChatSessionEntity(Integer chatSessionEntityId)

Returns: CRMScript.NetServer.NSChatSessionEntity Example:

NSChatAgent agent;
NSChatSessionEntity thing = agent.GetChatSessionEntity(123);

GetChatTopicEntity(Integer)

Gets an NSChatTopicEntity object.

NSChatTopicEntity GetChatTopicEntity(Integer chatTopicEntityId)

Returns: CRMScript.NetServer.NSChatTopicEntity Example:

NSChatAgent agent;
NSChatTopicEntity thing = agent.GetChatTopicEntity(123);

GetChatTopicUserAgent(Integer,String)

Gets a user assigned to a topic

NSChatTopicAgent GetChatTopicUserAgent(Integer chatTopicId, String username)

Returns: CRMScript.NetServer.NSChatTopicAgent Example:

NSChatAgent agent;
Integer chatTopicId;
String username;
NSChatTopicAgent res = agent.GetChatTopicUserAgent(chatTopicId, username);

GetChatTopicUserAgentList(Integer)

Gets a list of users assigned to a chat topic.

NSChatTopicAgent[] GetChatTopicUserAgentList(Integer chatTopicId)

Returns: CRMScript.NetServer.NSChatTopicAgent[] Example:

NSChatAgent agent;
Integer chatTopicId;
NSChatTopicAgent[] res = agent.GetChatTopicUserAgentList(chatTopicId);

GetChatTranscript(Integer,Bool)

Gets the chat transcript, formatted as plain text or HTML.

String GetChatTranscript(Integer chatSessionId, Bool html)

Returns: CRMScript.Global.String - chat transcript, formatted as plain text or HTMl. Example:

NSChatAgent agent;
Integer chatSessionId;
Bool html;
String res = agent.GetChatTranscript(chatSessionId, html);

GetUserAgentList(Bool,Bool)

Gets list of users that can be assigned to chat topics.

NSMDOListItem[] GetUserAgentList(Bool flat, Bool onlyPresent)

Returns: CRMScript.NetServer.NSMDOListItem[]

Users with Chat-CALs from the MDO list ‘chatuser’

Example:

NSChatAgent agent;
Bool flat;
Bool onlyPresent;
NSMDOListItem[] res = agent.GetUserAgentList(flat, onlyPresent);

IsWithinOpeningHours(Integer)

Checks if we are right now within the opening hours of the given topic. Will use timezones to calculate if configured.

Bool IsWithinOpeningHours(Integer chatTopicId)

Returns: CRMScript.Global.Bool Example:

NSChatAgent agent;
Integer chatTopicId;
Bool res = agent.IsWithinOpeningHours(chatTopicId);

PickUpChatSession(Integer)

Answer the session: assign the session to the user. The welcome message is sent to the customer.

NSChatSessionEntity PickUpChatSession(Integer chatSessionId)

Returns: CRMScript.NetServer.NSChatSessionEntity - Returns NULL if session was not in queue. Example:

NSChatAgent agent;
Integer chatSessionId;
NSChatSessionEntity res = agent.PickUpChatSession(chatSessionId);

PickUpFirstChatSession()

Answer the first available session from the queue: assign the session to the user. The welcome message is sent to the customer.

NSChatSessionEntity PickUpFirstChatSession()

Returns: CRMScript.NetServer.NSChatSessionEntity Example:

NSChatAgent agent;
NSChatSessionEntity res = agent.PickUpFirstChatSession();

RejectChatSessionTransfer(Integer)

Do not want. Deny the transfer to the user. If the session is not being transferred, nothing happens.

NSChatSessionEntity RejectChatSessionTransfer(Integer chatSessionId)

Returns: CRMScript.NetServer.NSChatSessionEntity Example:

NSChatAgent agent;
Integer chatSessionId;
NSChatSessionEntity res = agent.RejectChatSessionTransfer(chatSessionId);

ResetChatSession(Integer)

Resets chat session, puts it back on the queue for pickup.

NSChatSessionEntity ResetChatSession(Integer chatSessionId)

Returns: CRMScript.NetServer.NSChatSessionEntity

Used by bots to hand off a session to human

Example:

NSChatAgent agent;
Integer chatSessionId;
NSChatSessionEntity res = agent.ResetChatSession(chatSessionId);

SaveChatPresence(NSChatPresence[])

Saves the chat presence for specified users

Void SaveChatPresence(NSChatPresence[] chatPresence)

Returns: CRMScript.Global.Void Example:

NSChatAgent agent;
NSChatPresence[] chatPresence;
agent.SaveChatPresence(chatPresence);

SaveChatSessionEntity(NSChatSessionEntity)

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

NSChatSessionEntity SaveChatSessionEntity(NSChatSessionEntity chatSessionEntity)

Returns: CRMScript.NetServer.NSChatSessionEntity Example:

NSChat  agent;
NSChatSessionEntity thing = agent.CreateDefaultChatSessionEntity();
thing = agent.SaveChatSessionEntity(thing);

SaveChatTopicEntity(NSChatTopicEntity)

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

NSChatTopicEntity SaveChatTopicEntity(NSChatTopicEntity chatTopicEntity)

Returns: CRMScript.NetServer.NSChatTopicEntity Example:

NSChat  agent;
NSChatTopicEntity thing = agent.CreateDefaultChatTopicEntity();
thing = agent.SaveChatTopicEntity(thing);

TransferChatSession(Integer,String)

Requests to send the session to another user. If the session does not belong to the user, nothing happens.

NSChatSessionEntity TransferChatSession(Integer chatSessionId, String toAssociate)

Returns: CRMScript.NetServer.NSChatSessionEntity Example:

NSChatAgent agent;
Integer chatSessionId;
String toAssociate;
NSChatSessionEntity res = agent.TransferChatSession(chatSessionId, toAssociate);

UpdateChatTopicUserAgent(Integer,String,NSChatTopicAgent)

Updates a user’s role in a chat topic

NSChatTopicAgent UpdateChatTopicUserAgent(Integer chatTopicId, String username, NSChatTopicAgent useragent)

Returns: CRMScript.NetServer.NSChatTopicAgent Example:

NSChatAgent agent;
Integer chatTopicId;
String username;
NSChatTopicAgent useragent;
NSChatTopicAgent res = agent.UpdateChatTopicUserAgent(chatTopicId, username, useragent);

UpdateChatTopicUserAgent(Integer,NSChatTopicAgent[])

Updates users roles in a chat topic

NSChatTopicAgent[] UpdateChatTopicUserAgents(Integer chatTopicId, NSChatTopicAgent[] useragents)

Returns: CRMScript.NetServer.NSChatTopicAgent[] Example:

NSChatAgent agent;
Integer chatTopicId;
NSChatTopicAgent[] useragents;
NSChatTopicAgent[] res = agent.UpdateChatTopicUserAgents(chatTopicId, useragents);

​Constructors

​NSChatAgent()

​Methods

​AcceptChatSessionTransfer(Integer)

​AddChatMessage(Integer,NSChatMessage)

​AddChatTopicUserAgent(Integer,NSChatTopicAgent)

​ChatSessionsForUser()

​ChatTopicsForUser()

​CreateChatSessionForTopic(Integer)

​CreateDefaultChatSessionEntity()

​CreateDefaultChatTopicAgent()

​CreateDefaultChatTopicEntity()

​DeleteChatSessionEntity(Integer)

​DeleteChatTopicEntity(Integer)

​DeleteChatTopicUserAgent(Integer,String)

​GetChatMessages(Integer,Integer)

​GetChatPresence()

​GetChatSessionEntity(Integer)

​GetChatTopicEntity(Integer)

​GetChatTopicUserAgent(Integer,String)

​GetChatTopicUserAgentList(Integer)

​GetChatTranscript(Integer,Bool)

​GetUserAgentList(Bool,Bool)

​IsWithinOpeningHours(Integer)

​PickUpChatSession(Integer)

​PickUpFirstChatSession()

​RejectChatSessionTransfer(Integer)

​ResetChatSession(Integer)

​SaveChatPresence(NSChatPresence[])

​SaveChatSessionEntity(NSChatSessionEntity)

​SaveChatTopicEntity(NSChatTopicEntity)

​TransferChatSession(Integer,String)

​UpdateChatTopicUserAgent(Integer,String,NSChatTopicAgent)

​UpdateChatTopicUserAgent(Integer,NSChatTopicAgent[])

Constructors

NSChatAgent()

Methods

AcceptChatSessionTransfer(Integer)

AddChatMessage(Integer,NSChatMessage)

AddChatTopicUserAgent(Integer,NSChatTopicAgent)

ChatSessionsForUser()

ChatTopicsForUser()

CreateChatSessionForTopic(Integer)

CreateDefaultChatSessionEntity()

CreateDefaultChatTopicAgent()

CreateDefaultChatTopicEntity()

DeleteChatSessionEntity(Integer)

DeleteChatTopicEntity(Integer)

DeleteChatTopicUserAgent(Integer,String)

GetChatMessages(Integer,Integer)

GetChatPresence()

GetChatSessionEntity(Integer)

GetChatTopicEntity(Integer)

GetChatTopicUserAgent(Integer,String)

GetChatTopicUserAgentList(Integer)

GetChatTranscript(Integer,Bool)

GetUserAgentList(Bool,Bool)

IsWithinOpeningHours(Integer)

PickUpChatSession(Integer)

PickUpFirstChatSession()

RejectChatSessionTransfer(Integer)

ResetChatSession(Integer)

SaveChatPresence(NSChatPresence[])

SaveChatSessionEntity(NSChatSessionEntity)

SaveChatTopicEntity(NSChatTopicEntity)

TransferChatSession(Integer,String)

UpdateChatTopicUserAgent(Integer,String,NSChatTopicAgent)

UpdateChatTopicUserAgent(Integer,NSChatTopicAgent[])