Index

Classes


Class SocialNetworkSession

Class Summary
Constructor Attributes Constructor Name and Description
 
SocialNetworkSession(sn, agtCommand)
A SocialNetwork session, in other term, a social network feed presented to the agent
Field Summary
Field Attributes Field Name and Description
 
- list of SocialNetworkSessionActionAllowed for this session
 
- Default length in minute for callback (used for display only)
 
- the last day allowed to take callback on the campaign (format : yyyyMMddHHmm)
 
- campaign description for this socialnetwork feed
 
- campaign id for this socialnetwork feed
 
- campaign type for this socialnetwork feed.
 
- TimeZone of this client, in minutes (MediaServer TimeZone for now)
 
- socialnetwork id of this contact for this SocialNetworkSession#SocialNetworkType
 
- Phonenumber of this contact, used for session not of telephony type
 
- Adress book used to display contact informations and history
 
- socialnetwork feed date recept in format yyyyMMddHHmmss
 
- Oid of holidays group used on the campaign
 
- Client file indice
 
- Socialnetwork unique id (the SessionId change on each agent treatment for the same feed)
 
- Oid of Openings group used on the campaign
 
- Planning used to display or set appointment
 
- Qualification code selected by the agent for this socialnetwork
 
- Qualification detail code selected by the agent for this socialnetwork
 
- Group of status to use to qualify this socialnetwork
 
- Queue used to distribute this socialnetwork to this agent
 
- URL for the script to display defined in the Hermes.Net Admin
 
- 0 : no script, 1 : InterfaceDesigner script, 2 : free url
 
- Sentence group that the agent can use when answering this feed
 
- Unique identifier of this session (is unique across all session)
 
- the current session state
 
- detail for the current state.
 
- textual representation of the current SessionState
 
- time of the last session state change
 
- 1:Facebook, 2:Twitter
 
- Right to send a free attachment file by email to the customer
Method Summary
Method Attributes Method Name and Description
 
ActionIsReady(action)
Used to know if an action is authorized on the session.
 
Answer(json)
Send the answer to a socialnetwork feed
 
CallSession(phoneNumber, type, data, memo)
Call the contact on it's phone.
 
Cancel the current socialnetwork search
 
Close the session.
 
 
Hangup the call linked to this socialnetwork
 
HoldCall(holdMessage)
Set the call linked to this socialnetwork on hold
 
IgnoreComments(postId, commandIdList)
Set a list of comments to hidde from the search result
 
Like(postId)
Send a Like on a facebook postId
 
This function allow to know if the session has to be qualified before being closed
 
RedialCall(number, type, data)
On communication lost, allow to redial the same customer (a new session will not be created)
 
Retrieve the holded call linked to this socialnetwork
 
SearchModeSelect(mediaUID, data, memo, campaignId)
Select a socialnetwork to manage.
 
SetCallStatus(status, detail, callbackTime, callbackNumber, callbackValidity, comment)
Qualify the session.
 
Transfer(number, type, data)
Transfer the fax to another party.
 
Set the session state in wrapup.
Class Detail
SocialNetworkSession(sn, agtCommand)
A SocialNetwork session, in other term, a social network feed presented to the agent
Parameters:
sn
agtCommand
Field Detail
{COMArray} ActionsAllowed
- list of SocialNetworkSessionActionAllowed for this session

{number} CallbackDefaultLength
- Default length in minute for callback (used for display only)

{string} CallbackLastAllowedDay
- the last day allowed to take callback on the campaign (format : yyyyMMddHHmm)

{string} CampaignDescription
- campaign description for this socialnetwork feed

{string} CampaignId
- campaign id for this socialnetwork feed

{CampaignTypes} CampaignType
- campaign type for this socialnetwork feed. Not used for SocialNetworkSession

{number} ClientTZ
- TimeZone of this client, in minutes (MediaServer TimeZone for now)

{string} ContactNumber
- socialnetwork id of this contact for this SocialNetworkSession#SocialNetworkType

{string} ContactPhone
- Phonenumber of this contact, used for session not of telephony type

{string} CrmOid
- Adress book used to display contact informations and history

{string} DateRecept
- socialnetwork feed date recept in format yyyyMMddHHmmss

{string} HolidayGroup
- Oid of holidays group used on the campaign

{number} Indice
- Client file indice

{string} MediaServerUID
- Socialnetwork unique id (the SessionId change on each agent treatment for the same feed)

{string} OpeningGroup
- Oid of Openings group used on the campaign

{string} PlanningId
- Planning used to display or set appointment

{number} QualificationCode
- Qualification code selected by the agent for this socialnetwork

{number} QualificationDetail
- Qualification detail code selected by the agent for this socialnetwork

{string} QualificationGroup
- Group of status to use to qualify this socialnetwork

{number} QueuedID
- Queue used to distribute this socialnetwork to this agent

{string} ScriptAddress
- URL for the script to display defined in the Hermes.Net Admin

{number} ScriptMode
- 0 : no script, 1 : InterfaceDesigner script, 2 : free url

{string} SentenceGroup
- Sentence group that the agent can use when answering this feed

{string} SessionId
- Unique identifier of this session (is unique across all session)

{SessionSocialNetworkStates} SessionState
- the current session state

{number} SessionStateDetail
- detail for the current state. Not used for SocialNetworkSession

{string} SessionStateLabel
- textual representation of the current SessionState

{number} SessionStateTime
- time of the last session state change

{number} SocialNetworkType
- 1:Facebook, 2:Twitter

{boolean} UploadAttachmentRight
- Right to send a free attachment file by email to the customer
Method Detail
ActionIsReady(action)
Used to know if an action is authorized on the session.
You have to check the return of this function before calling an action on the session
    if (agentlink.SocialNetwork.GetSession(thesessionid).ActionIsReady(SocialNetworkSessionActionAllowed.CloseSession)) {
        //agent can close the current socialnetwork session - no need to qualify
    }
Parameters:
{SocialNetworkSessionActionAllowed} action
- The action to test
Returns:
true if the action is currently authorized

Answer(json)
Send the answer to a socialnetwork feed
Parameters:
{string} json
- answer to send in the json format

CallSession(phoneNumber, type, data, memo)
Call the contact on it's phone. Call will be linked to the socialnetwork.
Parameters:
{string} phoneNumber
- phonenumber to call
{PhoneNumberTypes} type
- type of the phone number to dial
{string} data
- UUI data to set on the call
{string} memo
- free string that will be set on the call session

CancelSearchMode()
Cancel the current socialnetwork search

CloseSession()
Close the session. After this function call, the agent will be available for next socialnetwork

GetCrmKey()

HangupCall()
Hangup the call linked to this socialnetwork

HoldCall(holdMessage)
Set the call linked to this socialnetwork on hold
Parameters:
{string} holdMessage
- full path of the wav file to diffuse on customer during the hold. Empty string to use the default message defined on the campaign.

IgnoreComments(postId, commandIdList)
Set a list of comments to hidde from the search result
Parameters:
{string} postId
- the facebook post id on wich some comments have to be hidden from the search result view
{Array} commandIdList
- the list of comments id to hidde from the search result view

Like(postId)
Send a Like on a facebook postId
Parameters:
{string} postId
- the id of the facebook post to like

MustQualify()
This function allow to know if the session has to be qualified before being closed
Returns:
true if the session has to be qualified

RedialCall(number, type, data)
On communication lost, allow to redial the same customer (a new session will not be created)
Parameters:
{string} number
- phonenumber to call
{PhoneNumberTypes} type
- type of the phone number to dial
{string} data
- UUI data to set on the call

RetrieveCall()
Retrieve the holded call linked to this socialnetwork

SearchModeSelect(mediaUID, data, memo, campaignId)
Select a socialnetwork to manage. Available only on search session (check current actions allowed)
Parameters:
{string} mediaUID
- socialnetwork uid
{string} data
- unused
{string} memo
- unused
{string} campaignId
- campaign id of the socialnetwork to manage

SetCallStatus(status, detail, callbackTime, callbackNumber, callbackValidity, comment)
Qualify the session.
Parameters:
{number} status
- status code
{number} detail
- status detailed code
{string} callbackTime
- for callback and personal callbacks code, specify the datetime for callback (format yyyyMMddHHmm)
{string} callbackNumber
- phonenumber to dial on callback
{number} callbackValidity
- unused
{string} comment
- free agent comment saved with the session qualification

Transfer(number, type, data)
Transfer the fax to another party.
Parameters:
{string} number
- destinatory id
{DestinaryTypes} type
- type of destinatory (DestinaryTypes.Agent or DestinaryTypes.Campaign)
{string} data
- data to set on the socialnetwork

Wrapup()
Set the session state in wrapup. On wrapup state, agent can qualify the socialnetwork feed but not reply it.

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Nov 05 2014 12:49:33 GMT+0100 (CET)