API Docs for: 2.6
Show:

arch_dbconn Class

Module: dbconn

The architect component that exposes dbconn module.

Item Index

Methods

Methods

deleteCallerNote

(
  • id
  • cb
)

Provided by the plugins module.

Deletes the specified caller note from the caller_note database table.

Parameters:

  • id String

    The database caller note identifier

  • cb Function

    The callback function

deleteCallRecording

(
  • uniqueid
  • cb
)

Provided by the plugins module.

Deletes a call recording from the database. It updates the entry of the specified call emptying the content of the recordingfile field of the asteriskcdrdb.cdr database table.

Parameters:

  • uniqueid String

    The database identifier of the call

  • cb Function

    The callback function

deleteCtiPbContact

(
  • id
  • cb
)

Provided by the plugins module.

Deletes the specified phonebook contact from the cti_phonebook database table.

Parameters:

  • id String

    The cti database contact identifier

  • cb Function

    The callback function

deletePostit

(
  • id
  • cb
)

Provided by the plugins module.

Deletes the specified postit from the cti postit database table.

Parameters:

  • id String

    The post-it identifier

  • cb Function

    The callback function

deleteVoiceMessage

(
  • dbid
  • cb
)

Provided by the plugins module.

Delete a voice message from the database table asteriskcdrdb.voicemessages.

Parameters:

  • dbid String

    The database identifier of the voice message to delete

  • cb Function

    The callback function

getAgentsStats

(
  • day
  • cb
)

Provided by the plugins module.

Get agent statistics about work times

Parameters:

  • day String

    The query date (YYYYMMDD)

  • cb Function

    The callback function

getAllUnreadPostitOfRecipient

(
  • username
  • cb
)

Provided by the plugins module.

Returns all the unread post-it of the recipient user from the postit database table.

Parameters:

  • username String

    The username of the recipient

  • cb Function

    The callback function

getAllUserHistoryCallerNoteInterval

(
  • data
  • cb
)

Provided by the plugins module.

Gets the history caller note of all the users into the interval time. It can be possible to filter the results specifying the filter. It search the results into the caller_note database.

Parameters:

  • data Object
    • from String

      The starting date of the interval in the YYYYMMDD format (e.g. 20130521)

    • to String

      The ending date of the interval in the YYYYMMDD format (e.g. 20130528)

    • [filter] String optional

      The filter to be used in the number field. If it is omitted the function treats it as '%' string

  • cb Function

    The callback function

getAllUserHistoryPostitInterval

(
  • data
  • cb
)

Provided by the plugins module.

Gets all the history post-it of all the users into the interval time. It can be possible to filter out the results specifying the filter. It search the results into the postit database.

Parameters:

  • data Object
    • from String

      The starting date of the interval in the YYYYMMDD format (e.g. 20130521)

    • to String

      The ending date of the interval in the YYYYMMDD format (e.g. 20130528)

    • [filter] String optional

      The filter to be used in the recipient field. If it is omitted the function treats it as '%' string

  • cb Function

    The callback function

getAllUserHistorySmsInterval

(
  • data
  • cb
)

Provided by the plugins module.

Gets all the history sms of all the users into the interval time. It can be possible to filter out the results specifying the filter. It search the results into the sms_history database.

Parameters:

  • data Object
    • from String

      The starting date of the interval in the YYYYMMDD format (e.g. 20130521)

    • to String

      The ending date of the interval in the YYYYMMDD format (e.g. 20130528)

    • [filter] String optional

      The filter to be used in the recipient field. If it is omitted the function treats it as '%' string

  • cb Function

    The callback function

getAllUsersDefaultExtension

(
  • cb
)

Provided by the plugins module.

Gets default extension of all users. The settings are stored in mysql table user_settings.

Parameters:

  • cb Function

    The callback function

getAllValidCallerNotesByNum

(
  • number
  • cb
)

Provided by the plugins module.

Gets all the public and private caller notes for the specified number that hasn't expired.

Parameters:

  • number String

    The phone number used to search the associated caller note

  • cb Function

    The callback function

getCallerNote

(
  • id
  • cb
)

Provided by the plugins module.

Returns the caller note. It searches the id field in the caller_note database table.

Parameters:

  • id String

    The caller note identifier

  • cb Function

    The callback function

getCallInfo

(
  • uniqueid
  • privacyStr
  • cb
)

Provided by the plugins module.

Get call info of speciefied uniqueid. It searches the results into the database specified into the key names of one of the /etc/nethcti/dbstatic.json or /etc/nethcti/dbdynamic.json files.

Parameters:

  • uniqueid String

    The call uniqueid

  • privacyStr String

    The privacy string to be used to hide the phone numbers. It can be undefined

  • cb Function

    The callback function

getCallRecordingFileData

(
  • uniqueid
  • cb
)

Provided by the plugins module.

Returns the data about the call recording audio file as an object, or a false value if no data has been found.

Parameters:

  • uniqueid String

    The call identifier in the database

  • cb Function

    The callback function

getCallTrace

(
  • link
  • privacyStr
  • cb
)

Provided by the plugins module.

Get call trace of speciefied linkedid. It searches the results into the database specified into the key names of one of the /etc/nethcti/dbstatic.json or /etc/nethcti/dbdynamic.json files.

Parameters:

  • link String

    The call linkedid

  • privacyStr String

    The privacy string to be used to hide the phone numbers. It can be undefined

  • cb Function

    The callback function

getCtiPbContact

(
  • id
  • cb
)

Provided by the plugins module.

Returns the cti phonebook contact. It searches the id field in the cti_phonebook database table.

Parameters:

  • id String

    The cti database contact identifier

  • cb Function

    The callback function

getCtiPbContactsByNum

(
  • number
  • cb
)

Provided by the plugins module.

Gets the phonebook contacts from the cti address book. It searches the number in the fields: workphone, homephone, cellphone and extension. It orders the results by name and company ascending. The cti address book is the mysql cti_phonebook.

Parameters:

  • number String

    The phone number term to search

  • cb Function

    The callback function

getCtiPbContactsContains

(
  • term
  • username
  • cb
)

Provided by the plugins module.

Gets the phonebook contacts searching in the NethCTI phonebook database. The specified term is wrapped with '%' characters, so it searches any occurrences of the term in the following fields: name, company, workphone, homephone, cellphone and extension. It orders the results by name and company ascending. The NethCTI phonebook is the mysql cti_phonebook.

Parameters:

  • term String

    The term to search. It can be a name or a number

  • username String

    The name of the user used to search contacts

  • cb Function

    The callback function

getCtiPbContactsStartsWith

(
  • term
  • username
  • cb
)

Provided by the plugins module.

Gets the phonebook contacts searching in the NethCTI phonebook database. At the end of the specified term is added the '%' character, so it searches the entries whose fields name and company starts with the term. It orders the results by name and company ascending. The NethCTI phonebook is the mysql cti_phonebook.

Parameters:

  • term String

    The term to search. It can be a name or a number

  • username String

    The name of the user used to search contacts

  • cb Function

    The callback function

getCtiPbContactsStartsWithDigit

(
  • username
  • cb
)

Provided by the plugins module.

Gets the phonebook contacts searching in the NethCTI phonebook database. Tt searches the entries whose fields name and company starts with a digit. It orders the results by name and company ascending. The NethCTI phonebook is the mysql cti_phonebook.

Parameters:

  • username String

    The name of the user used to search contacts

  • cb Function

    The callback function

getCtiPbSpeeddialContacts

(
  • username
  • cb
)

Provided by the plugins module.

Gets all the speeddial contacts of the specified user searching in the NethCTI phonebook database. It searches all entries of he user where type field is equal to "speeddial". It orders the results by name and company ascending. The NethCTI phonebook is the mysql cti_phonebook.

Parameters:

  • username String

    The name of the user used to search speeddial contacts

  • cb Function

    The callback function

getCustomerCardByNum

(
  • type
  • num
  • cb
)

Provided by the plugins module.

Get the customer card of the specified type. It search the results into the database specified into the key names of one of the /etc/nethcti/dbstatic.json or /etc/nethcti/dbdynamic.json files.

Parameters:

  • type String

    The type of the customer card to retrieve

  • num String

    The phone number used to search in channel and dstchannel mysql fields. It is used to filter. It is preceded by '%' character

  • cb Function

    The callback function

getHistoryCallerNoteInterval

(
  • data
  • cb
)

Provided by the plugins module.

Gets the history caller note of the specified user into the interval time. If the username information is omitted, the results contains the history caller note of all users. Moreover, it can be possible to filter the results specifying the filter. It search the results into the caller_note database.

Parameters:

  • data Object
    • [username] String optional

      The user involved in the research. It is used to filter out the creator. If it is omitted the function treats it as '%' string. The '%' matches any number of characters, even zero character.

    • from String

      The starting date of the interval in the YYYYMMDD format (e.g. 20130521)

    • to String

      The ending date of the interval in the YYYYMMDD format (e.g. 20130528)

    • [filter] String optional

      The filter to be used in the number field. If it is omitted the function treats it as '%' string

  • cb Function

    The callback function

getHistoryCallInterval

(
  • data
  • cb
)

Provided by the plugins module.

Get the history call of the specified endpoint into the interval time. If the endpoint information is omitted, the results contains the history call of all endpoints. Moreover, it can be possible to filter the results specifying the filter and hide the phone numbers specifying the privacy sequence to be used. It search the results into the asteriskcdrdb.cdr database.

Parameters:

  • data Object
    • [endpoint] String optional

      The endpoint involved in the research, e.g. the extesion identifier. It is used to filter out the channel and dstchannel. It is wrapped with '%' characters. If it is omitted the function treats it as '%' string. The '%' matches any number of characters, even zero character

    • from String

      The starting date of the interval in the YYYYMMDD format (e.g. 20130521)

    • to String

      The ending date of the interval in the YYYYMMDD format (e.g. 20130528)

    • recording Boolean

      True if the data about recording audio file must be returned

    • [filter] String optional

      The filter to be used in the src, clid and dst fields. If it is omitted the function treats it as '%' string

    • [privacyStr] String optional

      The sequence to be used to hide the numbers to respect the privacy

  • cb Function

    The callback function

getHistoryPostitInterval

(
  • data
  • cb
)

Provided by the plugins module.

Get the history post-it of the specified user into the interval time. If the username information is omitted, the results contains the history post-it of all users. Moreover, it can be possible to filter the results specifying the filter. It search the results into the postit database.

Parameters:

  • data Object
    • [username] String optional

      The user involved in the research. It is used to filter out the creator. If it is omitted the function treats it as '%' string. The '%' matches any number of characters, even zero character.

    • from String

      The starting date of the interval in the YYYYMMDD format (e.g. 20130521)

    • to String

      The ending date of the interval in the YYYYMMDD format (e.g. 20130528)

    • [filter] String optional

      The filter to be used in the recipient field. If it is omitted the function treats it as '%' string

  • cb Function

    The callback function

getHistorySmsInterval

(
  • data
  • cb
)

Provided by the plugins module.

Get the history sms sent by the specified user into the interval time. If the username information is omitted, the results contains the history sms of all users. Moreover, it can be possible to filter the results specifying the filter. It search the results into the sms_history database.

Parameters:

  • data Object
    • [username] String optional

      The user involved in the research. It is used to filter out the sender. If it is omitted the function treats it as '%' string. The '%' matches any number of characters, even zero character.

    • from String

      The starting date of the interval in the YYYYMMDD format (e.g. 20130521)

    • to String

      The ending date of the interval in the YYYYMMDD format (e.g. 20130528)

    • [filter] String optional

      The filter to be used in the destination field. If it is omitted the function treats it as '%' string

  • cb Function

    The callback function

getPbContactsByNum

(
  • number
  • cb
)

Provided by the plugins module.

Gets the phonebook contacts from the centralized address book. It searches the number in the fields: workphone, homephone and cellphone. It orders the results by name and company ascending. The centralized address book is the mysql phonebook.phonebook.

Parameters:

  • number String

    The phone number term to search

  • cb Function

    The callback function

getPbContactsContains

(
  • term
  • cb
)

Provided by the plugins module.

Gets the phonebook contacts from the centralized address book. The specified term is wrapped with '%' characters, so it search any occurrences of the term in the fields: name, company, workphone, homephone and cellphone. It orders the results by name and company ascending. The centralized address book is the mysql phonebook.phonebook.

Parameters:

  • term String

    The term to search. It can be a name or a number. It will wrapped with '%' characters to search any occurrences of the term in the database fields.

  • cb Function

    The callback function

getPbContactsStartsWith

(
  • term
  • cb
)

Provided by the plugins module.

Gets the phonebook contacts from the centralized address book. At the end of the specified term is added the '%' character, so it searches the entries whose fields name and company starts with the term. It orders the results by name and company ascending. The centralized address book is the mysql phonebook.phonebook.

Parameters:

  • term String

    The term to search. It can be a name or a number. It will ended with '%' character to search any contacts with names that starts with the term.

  • cb Function

    The callback function

getPbContactsStartsWithDigit

(
  • cb
)

Provided by the plugins module.

Gets the phonebook contacts from the centralized address book. It searches the entries whose fields name and company starts with a digit. It orders the results by name and company ascending. The centralized address book is the mysql phonebook.phonebook.

Parameters:

  • cb Function

    The callback function

getPostit

(
  • id
  • cb
)

Provided by the plugins module.

Returns the post-it from the postit database table using its unique database identifier. Then it sets the status read for the required postit updating the readdate column of the postit database table.

Parameters:

  • id String

    The post-it unique identifier. It's the id column of the postit database table

  • cb Function

    The callback function

getQueueMemberLastPausedInData

(
  • memberName
  • queueId
  • memberId
  • cb
)

Provided by the plugins module.

Gets the data of the more recent started pause of the queue member in the specified queue. It searches the results into the asteriskcdrdb.queue_log database. If the queue member has never started a pause, the data values isn't present in the database. So, in this case, the method returns some null values.

Parameters:

  • memberName String

    The queue member name

  • queueId String

    The queue identifier

  • memberId String

    The queue member identifier

  • cb Function

    The callback function

getQueueMemberLastPausedOutData

(
  • memberName
  • queueId
  • memberId
  • cb
)

Provided by the plugins module.

Gets the data of the more recent ended pause of the queue member in the specified queue. It searches the results into the asteriskcdrdb.queue_log database. If the queue member has never ended a pause, the data values isn't present in the database. So, in this case, the method returns some null values.

Parameters:

  • memberName String

    The queue member name

  • queueId String

    The queue identifier

  • memberId String

    The queue member identifier

  • cb Function

    The callback function

getQueueRecall

(
  • data
  • cb
)

Provided by the plugins module.

Gets the last calls from queue_recall db table basing the search into the last X hours or a specific day in YYYYMMDD format.

Parameters:

  • data Object
    • type String

      The type of search ("hours" || "day")

    • val String

      The value of the interval time to be searched (or X hours or YYYYMMDD specific day)

    • qid String

      The queue identifier

  • cb Function

    The callback function

getQueueRecallInfo

(
  • data
  • cb
)

Provided by the plugins module.

Gets the details about caller id from queue_recall db table.

Parameters:

  • data Object
    • type String

      The type of search ("hours" || "day")

    • val String

      The value of the interval time to be searched

    • cid String

      The caller identifier

  • cb Function

    The callback function

getQueueRecallQueryTable

(
  • type
  • val
)
String private

Provided by the plugins module.

Gets the query that returns the entries corresponding to queue recalls table.

Parameters:

  • type String

    The type of search ("hours" || "day")

  • val String

    The value of the interval time to be searched

Returns:

String:

The query to obtain the entries about queue recall table

getQueuesQOS

(
  • day
  • cb
)

Provided by the plugins module.

Get answered calls statistics by hold time

Parameters:

  • day String

    The query date (YYYYMMDD)

  • cb Function

    The callback function

getQueuesStats

(
  • day
  • cb
)

Provided by the plugins module.

Gets statistics about queues.

Parameters:

  • day String

    The query date (YYYYMMDD)

  • cb Function

    The callback function

getUserSettings

(
  • username
  • cb
)

Provided by the plugins module.

Gets the settings of the user. The settings are stored in mysql table user_settings.

Parameters:

  • username String

    The user identifier

  • cb Function

    The callback function

getVmMailboxFromDbId

(
  • dbid
  • cb
)

Provided by the plugins module.

Returns the voicemail mailbox from the identifier of the voicemail in the database.

Parameters:

  • dbid String

    The voicemail identifier in the database

  • cb Function

    The callback function

getVoicemailMsg

(
  • vmId
  • type
  • cb
)

Provided by the plugins module.

Gets all the voice messages of a voicemail of the specified type. It search the results into the asteriskcdrdb.voicemessages database. The type can be "new" or "old".

Parameters:

  • vmId String

    The voicemail identifier

  • type String

    The type of the voicemail to retrieve. It can be "new" or "old"

  • cb Function

    The callback function

getVoicemailNewMsg

(
  • vmId
  • cb
)

Provided by the plugins module.

Gets all the new voice messages of a voicemail. It search the results into the asteriskcdrdb.voicemessages database.

Parameters:

  • vmId String

    The voicemail identifier

  • cb Function

    The callback function

getVoicemailOldMsg

(
  • vmId
  • cb
)

Provided by the plugins module.

Gets all the old voice messages of a voicemail. It search the results into the asteriskcdrdb.voicemessages database.

Parameters:

  • vmId String

    The voicemail identifier

  • cb Function

    The callback function

isAtLeastExtenInCall

(
  • uniqueid
  • extensions
  • cb
)

Provided by the plugins module.

Checks if at least one of the specified list of extensions is implied in the recorded call.

Parameters:

  • uniqueid String

    The call identifier: is the uniqueid field of the asteriskcdrdb.cdr database table

  • extensions Array

    The list of the extensions to check

  • cb Function

    The callback function. If none of the extensions is involved in the call, the callback is called with a false boolean value. Otherwise it's called with the entry of the database

listenVoiceMessage

(
  • dbid
  • cb
)

Provided by the plugins module.

Returns audio file from the id mailbox.

Parameters:

  • dbid String

    The voicemail identifier in the database

  • cb Function

    The callback function

modifyCallerNote

(
  • data
  • cb
)

Provided by the plugins module.

Modify the specified caller note in the caller_note database table.

Parameters:

  • data Object
    • id String

      The unique identifier of the caller note in the database

    • [number] String optional

      The caller/called number that is associated with the note

    • [text] String optional

      The text of the note

    • [reservation] Boolean optional

      The reservation option. If the creator has booked the callback from the expressed number

    • [public] Boolean optional

      True if the caller note visibility is public, false otherwise

    • [expiration] String optional

      The expiration date and time of the caller note. It must be expressed in YYYY-MM-DD HH:mm:ss format

  • cb Function

    The callback function

modifyCtiPbContact

(
  • data
  • cb
)

Provided by the plugins module.

Modify the specified phonebook contact in the cti_phonebook database table.

Parameters:

  • data Object
    • id String

      The unique identifier of the contact

    • [type] String optional

      The type of the contact

    • [name] String optional

      The name of the contact

    • [homeemail] String optional
    • [workemail] String optional
    • [homephone] String optional
    • [workphone] String optional
    • [cellphone] String optional
    • [fax] String optional
    • [title] String optional
    • [company] String optional
    • [notes] String optional
    • [homestreet] String optional
    • [homepob] String optional
    • [homecity] String optional
    • [homeprovince] String optional
    • [homepostalcode] String optional
    • [homecountry] String optional
    • [workstreet] String optional
    • [workpob] String optional
    • [workcity] String optional
    • [workprovince] String optional
    • [workpostalcode] String optional
    • [workcountry] String optional
    • [url] String optional
    • [extension] String optional
    • [speeddial_num] String optional
  • cb Function

    The callback function

modifyPostit

(
  • id
  • text
  • cb
)

Provided by the plugins module.

Changes the specified postit from the cti postit database table.

Parameters:

  • id String

    The post-it identifier

  • text String

    The text of the post-it

  • cb Function

    The callback function

saveCallerNote

(
  • data
  • cb
)

Provided by the plugins module.

Save the the caller note in the database.

Parameters:

  • data Object
    • number String

      The caller/called number that is associated with the note

    • creator String

      The creator of the caller note

    • text String

      The text of the note

    • reservation Boolean

      The reservation option. If the creator has booked the callback from the expressed number

    • public Boolean

      True if the caller note visibility is public, false otherwise

    • expiration String

      The expiration date and time of the caller note. It must be expressed in YYYY-MM-DD HH:mm:ss format

  • cb Function

    The callback function

saveCtiPbContact

(
  • data
  • cb
)

Provided by the plugins module.

Saves the new contact in the NethCTI phonebook that is in the cti_phonebook database table.

Parameters:

  • data Object

    All the contact information to save in the database

    • owner_id String

      The owner of the contact

    • type String

      The type

    • name String

      The name

    • [homeemail] String optional
    • [workemail] String optional
    • [homephone] String optional
    • [workphone] String optional
    • [cellphone] String optional
    • [fax] String optional
    • [title] String optional
    • [company] String optional
    • [notes] String optional
    • [homestreet] String optional
    • [homepob] String optional
    • [homecity] String optional
    • [homeprovince] String optional
    • [homepostalcode] String optional
    • [homecountry] String optional
    • [workstreet] String optional
    • [workpob] String optional
    • [workcity] String optional
    • [workprovince] String optional
    • [workpostalcode] String optional
    • [workcountry] String optional
    • [url] String optional
    • [extension] String optional
    • [speeddial_num] String optional
  • cb Function

    The callback function

savePostit

(
  • creator
  • text
  • recipient
  • cb
)

Provided by the plugins module.

Save new post-it in the database.

Parameters:

  • creator String

    The creator name of the post-it

  • text String

    The message text

  • recipient String

    The recipient of the message

  • cb Function

    The callback function

saveUserAutoDndOffLogin

(
  • data
  • cb
)

Provided by the plugins module.

Save the user automatic DND OFF status when user login to cti into mysql table user_settings.

Parameters:

  • data Object
    • username String

      The username to set the notification setting

    • enable String

      The value

  • cb Function

    The callback function

saveUserAutoDndOnLogout

(
  • data
  • cb
)

Provided by the plugins module.

Save the user automatic DND ON status when user logout from cti into mysql table user_settings.

Parameters:

  • data Object
    • username String

      The username to set the notification setting

    • enable String

      The value

  • cb Function

    The callback function

saveUserAutoQueueLogin

(
  • data
  • cb
)

Provided by the plugins module.

Save the user automatic queue login setting into mysql table user_settings.

Parameters:

  • data Object
    • username String

      The username to set the notification setting

    • enable String

      The value

  • cb Function

    The callback function

saveUserAutoQueueLogout

(
  • data
  • cb
)

Provided by the plugins module.

Save the user automatic queue logout setting into mysql table user_settings.

Parameters:

  • data Object
    • username String

      The username to set the notification setting

    • enable String

      The value

  • cb Function

    The callback function

saveUserClick2CallSetting

(
  • data
  • cb
)

Provided by the plugins module.

Save the user click 2 call setting into mysql table user_settings.

Parameters:

  • data Object
    • username String

      The user identifier

    • type String

      The click to call type

    • [user] String optional

      The username of the device

    • [password] String optional

      The password of the device

  • cb Function

    The callback function

saveUserDefaultExtension

(
  • data
  • cb
)

Provided by the plugins module.

Save the user default extension setting into mysql table user_settings.

Parameters:

  • data Object
    • username String

      The username to set the notification setting

    • exten String

      The extension identifier

  • cb Function

    The callback function

saveUserNotifySetting

(
  • data
  • cb
)

Provided by the plugins module.

Save the user notification settings. The settings are stored in mysql table user_settings.

Parameters:

  • data Object
    • type String

      The type of the notification, e.g. "voicemail"

    • when String

      When receive the notification type

    • method String

      The method to use by the notification, e.g. "email"

    • username String

      The username to set the notification setting

  • cb Function

    The callback function

saveUserSetting

(
  • username
  • keyName
  • value
  • cb
)

Provided by the plugins module.

Saves a key-value pair representing a user setting. The setting are stored in mysql table user_settings.

Parameters:

  • username String

    The username to set the setting

  • keyName String

    The name of the key to store

  • value String

    The value of the key

  • cb Function

    The callback function

setCompDbconnMain

(
  • comp
)
static

Provided by the plugins module.

Set the main dbconn architect component.

Parameters:

  • comp Object

    The architect main dbconn component

setCompDbconnMain

(
  • comp
)
static

Provided by the plugins module.

Set the main dbconn architect component.

Parameters:

  • comp Object

    The architect main dbconn component

setCompDbconnMain

(
  • comp
)
static

Provided by the plugins module.

Set the main dbconn architect component.

Parameters:

  • comp Object

    The architect main dbconn component

setCompDbconnMain

(
  • comp
)
static

Provided by the plugins module.

Set the main dbconn architect component.

Parameters:

  • comp Object

    The architect main dbconn component

setCompDbconnMain

(
  • comp
)
static

Provided by the plugins module.

Set the main dbconn architect component.

Parameters:

  • comp Object

    The architect main dbconn component

setCompDbconnMain

(
  • comp
)
static

Provided by the plugins module.

Set the main dbconn architect component.

Parameters:

  • comp Object

    The architect main dbconn component

setCompDbconnMain

(
  • comp
)
static

Provided by the plugins module.

Set the main dbconn architect component.

Parameters:

  • comp Object

    The architect main dbconn component

setCompDbconnMain

(
  • comp
)
static

Provided by the plugins module.

Set the main dbconn architect component.

Parameters:

  • comp Object

    The architect main dbconn component

setCompDbconnMain

(
  • comp
)
static

Provided by the plugins module.

Set the main dbconn architect component.

Parameters:

  • comp Object

    The architect main dbconn component

setLogger

(
  • log
)
static

Provided by the plugins module.

Set the logger to be used.

Parameters:

  • log Object

    The logger object. It must have at least three methods: info, warn and error as console object.

setLogger

(
  • log
)
static

Provided by the plugins module.

Set the logger to be used.

Parameters:

  • log Object

    The logger object. It must have at least three methods: info, warn and error as console object.

setLogger

(
  • log
)
static

Provided by the plugins module.

Set the logger to be used.

Parameters:

  • log Object

    The logger object. It must have at least three methods: info, warn and error as console object.

setLogger

(
  • log
)
static

Provided by the plugins module.

Set the logger to be used.

Parameters:

  • log Object

    The logger object. It must have at least three methods: info, warn and error as console object.

setLogger

(
  • log
)
static

Provided by the plugins module.

Set the logger to be used.

Parameters:

  • log Object

    The logger object. It must have at least three methods: info, warn and error as console object.

setLogger

(
  • log
)
static

Provided by the plugins module.

Set the logger to be used.

Parameters:

  • log Object

    The logger object. It must have at least three methods: info, warn and error as console object.

setLogger

(
  • log
)
static

Provided by the plugins module.

Set the logger to be used.

Parameters:

  • log Object

    The logger object. It must have at least three methods: info, warn and error as console object.

setLogger

(
  • log
)
static

Provided by the plugins module.

Set the logger to be used.

Parameters:

  • log Object

    The logger object. It must have at least three methods: info, warn and error as console object.

setLogger

(
  • log
)
static

Provided by the plugins module.

Set the logger to be used.

Parameters:

  • log Object

    The logger object. It must have at least three methods: info, warn and error as console object.

storeSmsFailure

(
  • username
  • to
  • body
  • cb
)

Provided by the plugins module.

Save a failure in sms sending in the sms_history database table.

Parameters:

  • username String

    The name of the user who sent the sms

  • to String

    The destination number

  • body String

    The text of the message

  • cb Function

    The callback function

storeSmsSuccess

(
  • username
  • to
  • body
  • cb
)

Provided by the plugins module.

Save a successfully sms sending in the sms_history database table.

Parameters:

  • username String

    The name of the user who sent the sms

  • to String

    The destination number

  • body String

    The text of the message

  • cb Function

    The callback function

updatePostitReadIt

(
  • id
  • cb
)

Provided by the plugins module.

Updates the readdate column of the specified postit with the current date.

Parameters:

  • id String

    The post-it unique identifier. It's the id column of the postit database table

  • cb Funcion

    The callback function

Properties

apiList

Object

Provided by the plugins module.

The exported apis.

apiList

Object

Provided by the plugins module.

The exported apis.

apiList

Object

Provided by the plugins module.

The exported apis.

apiList

Object

Provided by the plugins module.

The exported apis.

apiList

Object

Provided by the plugins module.

The exported apis.

apiList

Object

Provided by the plugins module.

The exported apis.

apiList

Object

Provided by the plugins module.

The exported apis.

apiList

Object

Provided by the plugins module.

The exported apis.

apiList

Object

Provided by the plugins module.

The exported apis.

compDbconnMain

Object private

Provided by the plugins module.

The main architect dbconn component.

compDbconnMain

Object private

Provided by the plugins module.

The main architect dbconn component.

compDbconnMain

Object private

Provided by the plugins module.

The main architect dbconn component.

compDbconnMain

Object private

Provided by the plugins module.

The main architect dbconn component.

compDbconnMain

Object private

Provided by the plugins module.

The main architect dbconn component.

compDbconnMain

Object private

Provided by the plugins module.

The main architect dbconn component.

compDbconnMain

Object private

Provided by the plugins module.

The main architect dbconn component.

compDbconnMain

Object private

Provided by the plugins module.

The main architect dbconn component.

compDbconnMain

Object private

Provided by the plugins module.

The main architect dbconn component.

CUSTOMER_CARD

Object private

Provided by the plugins module.

The prefix for all customer card name.

Default: { PREFIX_NAME: 'customer_card_' }

EVT_DELETED_POSTIT

String

Provided by the plugins module.

The name of the deleted post-it message event.

Default: "deletedPostit"

EVT_DELETED_VOICE_MESSAGE

String

Provided by the plugins module.

The name of the listened voice message event.

Default: "deleteVoiceMessage"

EVT_LISTENED_VOICE_MESSAGE

String

Provided by the plugins module.

The name of the listened voice message event.

Default: "listenedVoiceMessage"

EVT_MODIFIED_POSTIT

String

Provided by the plugins module.

The name of the modified post-it message event.

Default: "modifiedPostit"

EVT_POSTIT_READIT

String

Provided by the plugins module.

The name of the "udpate post-it read it" message event.

Default: "postitReadIt"

IDLOG

String private final

Provided by the plugins module.

The module identifier used by the logger.

Default: [plugins/dbconn_ast_proxy]

IDLOG

String private final

Provided by the plugins module.

The module identifier used by the logger.

Default: [plugins/dbconn_caller_note]

IDLOG

String private final

Provided by the plugins module.

The module identifier used by the logger.

Default: [plugins/dbconn_postit]

IDLOG

String private final

The module identifier used by the logger.

Default: [arch_dbconn]

IDLOG

String private final

Provided by the plugins module.

The module identifier used by the logger.

Default: [plugins/dbconn_config_manager]

IDLOG

String private final

Provided by the plugins module.

The module identifier used by the logger.

Default: [plugins/dbconn_phonebook]

IDLOG

String private final

Provided by the plugins module.

The module identifier used by the logger.

Default: [plugins/dbconn_voicemail]

IDLOG

String private final

Provided by the plugins module.

The module identifier used by the logger.

Default: [plugins/dbconn_customer_card]

IDLOG

String private final

Provided by the plugins module.

The module identifier used by the logger.

Default: [plugins/dbconn_history]

IDLOG

String private final

Provided by the plugins module.

The module identifier used by the logger.

Default: [plugins/dbconn_sms]

logger

Object private

Provided by the plugins module.

The logger. It must have at least three methods: info, warn and error.

Default: console

logger

Object private

Provided by the plugins module.

The logger. It must have at least three methods: info, warn and error.

Default: console

logger

Object private

Provided by the plugins module.

The logger. It must have at least three methods: info, warn and error.

Default: console

logger

Object private

Provided by the plugins module.

The logger. It must have at least three methods: info, warn and error.

Default: console

logger

Object private

Provided by the plugins module.

The logger. It must have at least three methods: info, warn and error.

Default: console

logger

Object private

Provided by the plugins module.

The logger. It must have at least three methods: info, warn and error.

Default: console

logger

Object private

Provided by the plugins module.

The logger. It must have at least three methods: info, warn and error.

Default: console

logger

Object private

Provided by the plugins module.

The logger. It must have at least three methods: info, warn and error.

Default: console

logger

Object private

Provided by the plugins module.

The logger. It must have at least three methods: info, warn and error.

Default: console

NETHCTI_CENTRAL_TYPE

String private

Provided by the plugins module.

The type name of the cti contacts imported into the centralized phonebook.

Default: "nethcti"

Events

deletedPostit

Provided by the plugins module.

Fired when a post-it has been deleted from the database by the deletePostit method.

Event Payload:

  • user Object

    The recipient of the deleted post-it

deleteVoiceMessage

Provided by the plugins module.

Fired when a voice message has been deleted from the database by the deleteVoiceMessage method.

Event Payload:

  • voicemail Object

    The voicemail identifier

listenedVoiceMessage

Provided by the plugins module.

Fired when a voice message content has been read from the database by the listenVoiceMessage method.

Event Payload:

  • voicemail Object

    The voicemail identifier

modifiedPostit

Provided by the plugins module.

Fired when a post-it has been modified from the database by the modifyPostit method.

Event Payload:

  • user Object

    The recipient of the modified post-it

postitReadIt

Provided by the plugins module.

Fired when the read status of a post-it has been set in the database by the updatePostitReadIt method.

Event Payload:

  • user Object

    The recipient of the read post-it