[
{
"comment": "/**\n * @module\n * @name TelephonyService\n * @version 2.42.0-lts.4 - Documentation generated on 2026/04/24T11:38:22.926Z\n * @public\n * @description\n * This services manages PBX phone calls in a conversation. so it manages PBX calls between your PABX associated phone and a recipient's phone. If you don't have this service activated for your Rainbow user, all these methods will return an error when called.
\n * The main methods and events proposed in that service allow to:
\n * - Know if this service is activated or not for the connected user,
\n * - Know the version of the agent (deployed on the PBX) that monitors your line,
\n * - Handle the basic telephony services: Make a call, take a call, hold a call, retrieve a call and release a call,
\n * - Listen to the call state change
\n * Depending the agent version deployed, some services can return an error (unavailable service) when called
\n *\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 24,
"columnno": 0,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"kind": "module",
"name": "TelephonyService",
"version": "2.42.0-lts.4 - Documentation generated on 2026/04/24T11:38:22.926Z",
"access": "public",
"description": "This services manages PBX phone calls in a conversation. so it manages PBX calls between your PABX associated phone and a recipient's phone. If you don't have this service activated for your Rainbow user, all these methods will return an error when called.
\n The main methods and events proposed in that service allow to:
\n - Know if this service is activated or not for the connected user,
\n - Know the version of the agent (deployed on the PBX) that monitors your line,
\n - Handle the basic telephony services: Make a call, take a call, hold a call, retrieve a call and release a call,
\n - Listen to the call state change
\n Depending the agent version deployed, some services can return an error (unavailable service) when called
",
"longname": "module:TelephonyService",
"$longname": "TelephonyService",
"$kind": "module"
},
{
"comment": "",
"meta": {
"range": [
2642,
4161
],
"filename": "TelephonyService.js",
"lineno": 44,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {
"id": "astnode100000260",
"name": "TelephonyService_1",
"type": "MethodDefinition",
"paramnames": [
"_core",
"_eventEmitter",
"logger",
"_startConfig"
]
},
"vars": {
"": null
}
},
"undocumented": true,
"name": "TelephonyService_1",
"longname": "module:TelephonyService.TelephonyService_1",
"kind": "class",
"memberof": "module:TelephonyService",
"scope": "static",
"params": [],
"$longname": "TelephonyService.TelephonyService_1",
"$kind": "constructor"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method answerCall\n * @async\n * @category Telephony CALL\n * @instance\n * @description\n * Answer a call
\n * Return a promise
\n * @param {Call} call The call to answer\n * @return {Promise} Return a promise with the answered call.\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 1232,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "answerCall",
"async": true,
"scope": "instance",
"description": "Answer a call
\n Return a promise
",
"params": [
{
"type": {
"names": [
"Call"
]
},
"description": "The call to answer",
"name": "call"
}
],
"returns": [
{
"type": {
"names": [
"Promise."
]
},
"description": "Return a promise with the answered call."
}
],
"longname": "module:TelephonyService#answerCall",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#answerCall",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method cancelForward\n * @async\n * @category Telephony CALL\n * @instance\n * @description\n * Cancel the forward
\n * Return a promise
\n * @return {Promise} Return a promise with the canceled forward call.\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 1791,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "cancelForward",
"async": true,
"scope": "instance",
"description": "Cancel the forward
\n Return a promise
",
"returns": [
{
"type": {
"names": [
"Promise."
]
},
"description": "Return a promise with the canceled forward call."
}
],
"longname": "module:TelephonyService#cancelForward",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#cancelForward",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method conferenceCall\n * @async\n * @category Telephony CALL\n * @instance\n * @description\n * Create a conference with a held call and the active call
\n * User should have conference rights
\n * Return a promise
\n * @param {Call} activeCall The active call\n * @param {Call} heldCall The held call to transfer to the activeCall\n * @return {Promise} Return a resolved promise .\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 1632,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "conferenceCall",
"async": true,
"scope": "instance",
"description": "Create a conference with a held call and the active call
\n User should have conference rights
\n Return a promise
",
"params": [
{
"type": {
"names": [
"Call"
]
},
"description": "The active call",
"name": "activeCall"
},
{
"type": {
"names": [
"Call"
]
},
"description": "The held call to transfer to the activeCall",
"name": "heldCall"
}
],
"returns": [
{
"type": {
"names": [
"Promise"
]
},
"description": "Return a resolved promise ."
}
],
"longname": "module:TelephonyService#conferenceCall",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#conferenceCall",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method deflectCall\n * @async\n * @category Telephony CALL\n * @instance\n * @description\n * Deflect a call to an other telephone number
\n * Return a promise
\n * @param {Call} call The call to deflect\n * @param {Object} callee The callee phone number informations where the call shopuld be deflecte'd.\n * @param {string} callee.calleeExtNumber : The phone number where the call is deflected, the format could be anything the user can type, it will be transformed in E164 format.,\n * @param {string} callee.calleeIntNumber : Internal number if available,\n * @param {string} callee.calleePbxId : The pbx id if available,\n * @param {string} [callee.calleeShortNumber] : Short number,\n * @param {string} [callee.calleeDisplayName] : The displayed name,\n * @param {string} [callee.calleeCountry] : The contry whe the call will be deflected.\n * @return {Promise} Return resolved promise if succeed, and a rejected else.\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 1523,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "deflectCall",
"async": true,
"scope": "instance",
"description": "Deflect a call to an other telephone number
\n Return a promise
",
"params": [
{
"type": {
"names": [
"Call"
]
},
"description": "The call to deflect",
"name": "call"
},
{
"type": {
"names": [
"Object"
]
},
"description": "The callee phone number informations where the call shopuld be deflecte'd.",
"name": "callee"
},
{
"type": {
"names": [
"string"
]
},
"description": ": The phone number where the call is deflected, the format could be anything the user can type, it will be transformed in E164 format.,",
"name": "callee.calleeExtNumber"
},
{
"type": {
"names": [
"string"
]
},
"description": ": Internal number if available,",
"name": "callee.calleeIntNumber"
},
{
"type": {
"names": [
"string"
]
},
"description": ": The pbx id if available,",
"name": "callee.calleePbxId"
},
{
"type": {
"names": [
"string"
]
},
"optional": true,
"description": ": Short number,",
"name": "callee.calleeShortNumber"
},
{
"type": {
"names": [
"string"
]
},
"optional": true,
"description": ": The displayed name,",
"name": "callee.calleeDisplayName"
},
{
"type": {
"names": [
"string"
]
},
"optional": true,
"description": ": The contry whe the call will be deflected.",
"name": "callee.calleeCountry"
}
],
"returns": [
{
"type": {
"names": [
"Promise"
]
},
"description": "Return resolved promise if succeed, and a rejected else."
}
],
"longname": "module:TelephonyService#deflectCall",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#deflectCall",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method deflectCallToVM\n * @async\n * @category Telephony CALL\n * @instance\n * @description\n * Deflect a call to the voice mail
\n * Return a promise
\n * @param {Call} call The call to deflect\n * @return {Promise} Return resolved promise if succeed, and a rejected else.\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 1459,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "deflectCallToVM",
"async": true,
"scope": "instance",
"description": "Deflect a call to the voice mail
\n Return a promise
",
"params": [
{
"type": {
"names": [
"Call"
]
},
"description": "The call to deflect",
"name": "call"
}
],
"returns": [
{
"type": {
"names": [
"Promise"
]
},
"description": "Return resolved promise if succeed, and a rejected else."
}
],
"longname": "module:TelephonyService#deflectCallToVM",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#deflectCallToVM",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method deleteAllMyVoiceMessagesFromPbx\n * @async\n * @category Telephony Voice Messages\n * @instance\n * @description\n * This api allows to Delete all user's present (read and unread) voice messages from the Pbx.
\n * This command is to be used to remove all read and unread messages for one user, on the pbx side, it has no effect on the file storage side.
\n * Do not use this API command to delete the voice messages file from the file storage.
\n *\n * return :\n *\n * | Champ | Type | Description |\n * | --- | --- | --- |\n * | status | String | |\n *\n * @return {Promise} Return resolved promise if succeed, and a rejected else.\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 2492,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony Voice Messages",
"value": "Telephony Voice Messages"
}
],
"kind": "function",
"name": "deleteAllMyVoiceMessagesFromPbx",
"async": true,
"scope": "instance",
"description": "This api allows to Delete all user's present (read and unread) voice messages from the Pbx.
\n This command is to be used to remove all read and unread messages for one user, on the pbx side, it has no effect on the file storage side.
\n Do not use this API command to delete the voice messages file from the file storage.
\n\n return :\n\n | Champ | Type | Description |\n | --- | --- | --- |\n | status | String | |",
"returns": [
{
"type": {
"names": [
"Promise"
]
},
"description": "Return resolved promise if succeed, and a rejected else."
}
],
"longname": "module:TelephonyService#deleteAllMyVoiceMessagesFromPbx",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#deleteAllMyVoiceMessagesFromPbx",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method deleteAVoiceMessageFromPbx\n * @async\n * @category Telephony Voice Messages\n * @instance\n * @param {string} messageId The message Id\n * @description\n * This api allows to Delete a voice message from the Pbx, using it's unique identifier (messageId), which is the one given in the messages list.
\n * This command is to be used to remove the message on the pbx side; it has no effect on the file storage side.
\n * Do not use this API command to delete the voice message file from the file storage.
\n *\n * return :\n *\n * | Champ | Type | Description |\n * | --- | --- | --- |\n * | status | String | |\n *\n * @return {Promise} Return resolved promise if succeed, and a rejected else.\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 2519,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony Voice Messages",
"value": "Telephony Voice Messages"
}
],
"kind": "function",
"name": "deleteAVoiceMessageFromPbx",
"async": true,
"scope": "instance",
"params": [
{
"type": {
"names": [
"string"
]
},
"description": "The message Id",
"name": "messageId"
}
],
"description": "This api allows to Delete a voice message from the Pbx, using it's unique identifier (messageId), which is the one given in the messages list.
\n This command is to be used to remove the message on the pbx side; it has no effect on the file storage side.
\n Do not use this API command to delete the voice message file from the file storage.
\n\n return :\n\n | Champ | Type | Description |\n | --- | --- | --- |\n | status | String | |",
"returns": [
{
"type": {
"names": [
"Promise"
]
},
"description": "Return resolved promise if succeed, and a rejected else."
}
],
"longname": "module:TelephonyService#deleteAVoiceMessageFromPbx",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#deleteAVoiceMessageFromPbx",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method forwardToDevice\n * @async\n * @category Telephony CALL\n * @instance\n * @description\n * Activate the forward to a number
\n * Return a promise
\n * @param {String} phoneNumber The number to call\n * @return {Promise} Return a promise resolved.\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 1688,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "forwardToDevice",
"async": true,
"scope": "instance",
"description": "Activate the forward to a number
\n Return a promise
",
"params": [
{
"type": {
"names": [
"String"
]
},
"description": "The number to call",
"name": "phoneNumber"
}
],
"returns": [
{
"type": {
"names": [
"Promise"
]
},
"description": "Return a promise resolved."
}
],
"longname": "module:TelephonyService#forwardToDevice",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#forwardToDevice",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method forwardToVoicemail\n * @async\n * @category Telephony CALL\n * @instance\n * @description\n * Activate the forward to VM
\n * Return a promise
\n * @return {Promise} Return a promise resolved.\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 1739,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "forwardToVoicemail",
"async": true,
"scope": "instance",
"description": "Activate the forward to VM
\n Return a promise
",
"returns": [
{
"type": {
"names": [
"Promise"
]
},
"description": "Return a promise resolved."
}
],
"longname": "module:TelephonyService#forwardToVoicemail",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#forwardToVoicemail",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method getActiveCall\n * @category Telephony CALL\n * @instance\n * @description\n * get the active call
\n * @return {Call} The active call\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 669,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "getActiveCall",
"scope": "instance",
"description": "get the active call
",
"returns": [
{
"type": {
"names": [
"Call"
]
},
"description": "The active call"
}
],
"longname": "module:TelephonyService#getActiveCall",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#getActiveCall",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method getActiveCall\n * @param {Contact} contact The contact with an active call with us.\n * @category Telephony CALL\n * @instance\n * @description\n * get the active call for a contact
\n * @return {Call} The active call\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 761,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "getActiveCall",
"params": [
{
"type": {
"names": [
"Contact"
]
},
"description": "The contact with an active call with us.",
"name": "contact"
}
],
"scope": "instance",
"description": "get the active call for a contact
",
"returns": [
{
"type": {
"names": [
"Call"
]
},
"description": "The active call"
}
],
"longname": "module:TelephonyService#getActiveCall",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#getActiveCall",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method getActiveCalls\n * @category Telephony CALL\n * @instance\n * @description\n * get active calls
\n * @return {Call} The active call\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 691,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "getActiveCalls",
"scope": "instance",
"description": "get active calls
",
"returns": [
{
"type": {
"names": [
"Call"
]
},
"description": "The active call"
}
],
"longname": "module:TelephonyService#getActiveCalls",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#getActiveCalls",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method getAgentVersion\n * @instance\n * @category Telephony MANAGEMENT\n * @description\n * Get the associated PBX agent version
\n * @return {string} Return the version of the agent or \"unknown\"\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 339,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony MANAGEMENT",
"value": "Telephony MANAGEMENT"
}
],
"kind": "function",
"name": "getAgentVersion",
"scope": "instance",
"description": "Get the associated PBX agent version
",
"returns": [
{
"type": {
"names": [
"string"
]
},
"description": "Return the version of the agent or \"unknown\""
}
],
"longname": "module:TelephonyService#getAgentVersion",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#getAgentVersion",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method getAVoiceMessageFromPbx\n * @async\n * @category Telephony Voice Messages\n * @instance\n * @param {string} messageId The message Id\n * @param {string} messageDate The date in ISO 8601 format, used form : YYYY-MM-DDTHH:MM:SSTZ\n * @param {string} messageFrom The message sender phone number (can an external number in E164 form or an internal short).\n * @description\n * This api allows to Get a voice message from the Pbx, using it's unique identifier (messageId), which is the one given in the messages list.
\n * But, in order to build a proper file name, we also need the message's creation date (ISO 8601) and the distant user's phone number.
\n * Initialy all voice messages are stored in the pbx, therefore they have to be transfered to Rainbow server before being given to the asking client.
\n * The positive acknowledged of this request only signifies that the pbx has accepted the download request. The client will be informed further once the message is available on file storage server. In the case the file transfer should fail, the client will also be informed..
\n *\n * parameters:
\n * * messageDate : mandatory, date in ISO 8601 format, used form : YYYY-MM-DDTHH:MM:SSTZ.
\n * * messageFrom : the message sender phone number (can an external number in E164 form or an internal short).
\n *\n * return :\n *\n * | Champ | Type | Description |\n * | --- | --- | --- |\n * | status | String | |\n * | resultCode | String | Pbx result code |\n *\n * @return {Promise} Return resolved promise if succeed, and a rejected else.\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 2547,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony Voice Messages",
"value": "Telephony Voice Messages"
}
],
"kind": "function",
"name": "getAVoiceMessageFromPbx",
"async": true,
"scope": "instance",
"params": [
{
"type": {
"names": [
"string"
]
},
"description": "The message Id",
"name": "messageId"
},
{
"type": {
"names": [
"string"
]
},
"description": "The date in ISO 8601 format, used form : YYYY-MM-DDTHH:MM:SSTZ",
"name": "messageDate"
},
{
"type": {
"names": [
"string"
]
},
"description": "The message sender phone number (can an external number in E164 form or an internal short).",
"name": "messageFrom"
}
],
"description": "This api allows to Get a voice message from the Pbx, using it's unique identifier (messageId), which is the one given in the messages list.
\n But, in order to build a proper file name, we also need the message's creation date (ISO 8601) and the distant user's phone number.
\n Initialy all voice messages are stored in the pbx, therefore they have to be transfered to Rainbow server before being given to the asking client.
\n The positive acknowledged of this request only signifies that the pbx has accepted the download request. The client will be informed further once the message is available on file storage server. In the case the file transfer should fail, the client will also be informed..
\n\n parameters:
\n * messageDate : mandatory, date in ISO 8601 format, used form : YYYY-MM-DDTHH:MM:SSTZ.
\n * messageFrom : the message sender phone number (can an external number in E164 form or an internal short).
\n\n return :\n\n | Champ | Type | Description |\n | --- | --- | --- |\n | status | String | |\n | resultCode | String | Pbx result code |",
"returns": [
{
"type": {
"names": [
"Promise"
]
},
"description": "Return resolved promise if succeed, and a rejected else."
}
],
"longname": "module:TelephonyService#getAVoiceMessageFromPbx",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#getAVoiceMessageFromPbx",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method getCalls\n * @category Telephony CALL\n * @instance\n * @description\n * get calls
\n * @return {Call} The calls\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 718,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "getCalls",
"scope": "instance",
"description": "get calls
",
"returns": [
{
"type": {
"names": [
"Call"
]
},
"description": "The calls"
}
],
"longname": "module:TelephonyService#getCalls",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#getCalls",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method getCallsSize\n * @category Telephony CALL\n * @instance\n * @description\n * get calls tab size. Warning do not use length on the getCalls method result because it is the last index id +1
\n * @return {Call} The calls tab size\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 737,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "getCallsSize",
"scope": "instance",
"description": "get calls tab size. Warning do not use length on the getCalls method result because it is the last index id +1
",
"returns": [
{
"type": {
"names": [
"Call"
]
},
"description": "The calls tab size"
}
],
"longname": "module:TelephonyService#getCallsSize",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#getCallsSize",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method getCallToHangOut\n * @category Telephony CALL\n * @instance\n * @description\n * Get the call which can be hang out
\n * @return {Call} The call with the ability to be hang out.\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 646,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "getCallToHangOut",
"scope": "instance",
"description": "Get the call which can be hang out
",
"returns": [
{
"type": {
"names": [
"Call"
]
},
"description": "The call with the ability to be hang out."
}
],
"longname": "module:TelephonyService#getCallToHangOut",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#getCallToHangOut",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method getDetailedListOfVoiceMessages\n * @async\n * @category Telephony Voice Messages\n * @instance\n * @description\n * This api allows to Get the detailed list of all available voice messages.
\n * For a user, which has a voice mail box, it is possible to get the detailed list of it's messages.
\n * A voice message can be :
\n * * a message recorded by a calling party which couldn't reach the user,
\n * * a conversation recorded by the user itself.
\n *\n * return :\n *\n * | Champ | Type | Description |\n * | --- | --- | --- |\n * | status | String | |\n * | data | Object | |\n * | voicemessages | Object | |\n * | voiceMessageList | Object\\[\\] | Table of message descriptor. |\n * | id | String | Message unique id. |\n * | unread | String | Message state, false for already read, true elsewhere. |\n * | length | String | Message length is seconds. |\n * | date | Date-Time | Message date in ISO 8601 (usual form : YYYY-MM-DDTHH:MM:SSTZ). |\n * | from | String | Message sender's number. |\n * | jid | String | Message sender's jid. |\n * | callable | String | Message sender can be called back or not. |\n * | identity | Object | Message sender names. |\n * | displayName | String | Message sender's display name. |\n * | firstName | String | Message sender's first name. |\n * | lastName | String | Message sender's last name. |\n *\n * @return {Promise} Return resolved promise if succeed, and a rejected else.\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 2583,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony Voice Messages",
"value": "Telephony Voice Messages"
}
],
"kind": "function",
"name": "getDetailedListOfVoiceMessages",
"async": true,
"scope": "instance",
"description": "This api allows to Get the detailed list of all available voice messages.
\n For a user, which has a voice mail box, it is possible to get the detailed list of it's messages.
\n A voice message can be :
\n * a message recorded by a calling party which couldn't reach the user,
\n * a conversation recorded by the user itself.
\n\n return :\n\n | Champ | Type | Description |\n | --- | --- | --- |\n | status | String | |\n | data | Object | |\n | voicemessages | Object | |\n | voiceMessageList | Object\\[\\] | Table of message descriptor. |\n | id | String | Message unique id. |\n | unread | String | Message state, false for already read, true elsewhere. |\n | length | String | Message length is seconds. |\n | date | Date-Time | Message date in ISO 8601 (usual form : YYYY-MM-DDTHH:MM:SSTZ). |\n | from | String | Message sender's number. |\n | jid | String | Message sender's jid. |\n | callable | String | Message sender can be called back or not. |\n | identity | Object | Message sender names. |\n | displayName | String | Message sender's display name. |\n | firstName | String | Message sender's first name. |\n | lastName | String | Message sender's last name. |",
"returns": [
{
"type": {
"names": [
"Promise"
]
},
"description": "Return resolved promise if succeed, and a rejected else."
}
],
"longname": "module:TelephonyService#getDetailedListOfVoiceMessages",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#getDetailedListOfVoiceMessages",
"$kind": "method"
},
{
"comment": "/**\n *\n /**\n * @public\n * @nodered true\n * @method getMediaPillarInfo\n * @instance\n * @category Telephony MANAGEMENT\n * @description\n * This API allows user to retrieve the Jabber id of the Media Pillar linked to the system he belongs, or Media Pillar user to retrieve the Jabber id credentials and data of the Media Pillar he belongs.
\n * @async\n * @return {Promise}\n * @category async\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 429,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"description": "This API allows user to retrieve the Jabber id of the Media Pillar linked to the system he belongs, or Media Pillar user to retrieve the Jabber id credentials and data of the Media Pillar he belongs.
",
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony MANAGEMENT",
"value": "Telephony MANAGEMENT"
},
{
"originalTitle": "category",
"title": "category",
"text": "async",
"value": "async"
}
],
"kind": "function",
"name": "getMediaPillarInfo",
"scope": "instance",
"async": true,
"returns": [
{
"type": {
"names": [
"Promise."
]
}
}
],
"longname": "module:TelephonyService#getMediaPillarInfo",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#getMediaPillarInfo",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method getNomadicStatus\n * @async\n * @category Telephony NOMADIC\n * @instance\n * @description\n * This api allows to get the nomadic status.
\n * @return {Promise} Return resolved promise if succeed, and a rejected else.\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 2382,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony NOMADIC",
"value": "Telephony NOMADIC"
}
],
"kind": "function",
"name": "getNomadicStatus",
"async": true,
"scope": "instance",
"description": "This api allows to get the nomadic status.
",
"returns": [
{
"type": {
"names": [
"Promise"
]
},
"description": "Return resolved promise if succeed, and a rejected else."
}
],
"longname": "module:TelephonyService#getNomadicStatus",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#getNomadicStatus",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method getNumbersOfVoiceMessages\n * @async\n * @category Telephony Voice Messages\n * @instance\n * @description\n * This api allows to Get voice messages counters, total and unlistened.
\n * For a user, which has a voice mail box, it is possible to get the number of not yet listened message (aka unread messages).
\n * When possible the total number of messages is also given.
\n * Some VoiceMail units only gives if the users has or not one or more messages in his box, the number of them is unknown.
\n *\n *\n * return :\n *\n * | Champ | Type | Description |\n * | --- | --- | --- |\n * | status | String | |\n * | data | Object | |\n * | voicemessages | Object | |\n * | unread | Number | Number of unlistened messages |\n * | total | Number | Total number of voice messages |\n * | present optionnel | Boolean | Pbx doesn't know how much messages a user has, only that one or more are present |\n *\n * @return {Promise} Return resolved promise if succeed, and a rejected else.\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 2626,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony Voice Messages",
"value": "Telephony Voice Messages"
}
],
"kind": "function",
"name": "getNumbersOfVoiceMessages",
"async": true,
"scope": "instance",
"description": "This api allows to Get voice messages counters, total and unlistened.
\n For a user, which has a voice mail box, it is possible to get the number of not yet listened message (aka unread messages).
\n When possible the total number of messages is also given.
\n Some VoiceMail units only gives if the users has or not one or more messages in his box, the number of them is unknown.
\n\n\n return :\n\n | Champ | Type | Description |\n | --- | --- | --- |\n | status | String | |\n | data | Object | |\n | voicemessages | Object | |\n | unread | Number | Number of unlistened messages |\n | total | Number | Total number of voice messages |\n | present optionnel | Boolean | Pbx doesn't know how much messages a user has, only that one or more are present |",
"returns": [
{
"type": {
"names": [
"Promise"
]
},
"description": "Return resolved promise if succeed, and a rejected else."
}
],
"longname": "module:TelephonyService#getNumbersOfVoiceMessages",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#getNumbersOfVoiceMessages",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method getPhoneAPIStatus\n * @instance\n * @category Telephony MANAGEMENT\n * @description\n * Get the status of the Phone API status for the PBX Agent
\n * @return {string} Return the Phone API status for to this Agent or \"unknown\"\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 369,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony MANAGEMENT",
"value": "Telephony MANAGEMENT"
}
],
"kind": "function",
"name": "getPhoneAPIStatus",
"scope": "instance",
"description": "Get the status of the Phone API status for the PBX Agent
",
"returns": [
{
"type": {
"names": [
"string"
]
},
"description": "Return the Phone API status for to this Agent or \"unknown\""
}
],
"longname": "module:TelephonyService#getPhoneAPIStatus",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#getPhoneAPIStatus",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method getVoiceMessageCounter\n * @async\n * @category Telephony CALL\n * @instance\n * @description\n * Get the number of voice message
\n * @return {Promise} Return resolved promise if succeed with the number of messages, and a rejected else.\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 606,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "getVoiceMessageCounter",
"async": true,
"scope": "instance",
"description": "Get the number of voice message
",
"returns": [
{
"type": {
"names": [
"Promise."
]
},
"description": "Return resolved promise if succeed with the number of messages, and a rejected else."
}
],
"longname": "module:TelephonyService#getVoiceMessageCounter",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#getVoiceMessageCounter",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method getXMPPAgentStatus\n * @instance\n * @category Telephony MANAGEMENT\n * @description\n * Get the status of the XMPP connection to the PBX Agent
\n * @return {string} Return the status of the connections to the agent or \"unknown\"\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 354,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony MANAGEMENT",
"value": "Telephony MANAGEMENT"
}
],
"kind": "function",
"name": "getXMPPAgentStatus",
"scope": "instance",
"description": "Get the status of the XMPP connection to the PBX Agent
",
"returns": [
{
"type": {
"names": [
"string"
]
},
"description": "Return the status of the connections to the agent or \"unknown\""
}
],
"longname": "module:TelephonyService#getXMPPAgentStatus",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#getXMPPAgentStatus",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method holdCall\n * @category Telephony CALL\n * @instance\n * @description\n * Hold a call
\n * Return a promise
\n * @param {Call} call The call to hold\n * @return {Call} Return a promise with the held call.\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 1312,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "holdCall",
"scope": "instance",
"description": "Hold a call
\n Return a promise
",
"params": [
{
"type": {
"names": [
"Call"
]
},
"description": "The call to hold",
"name": "call"
}
],
"returns": [
{
"type": {
"names": [
"Call"
]
},
"description": "Return a promise with the held call."
}
],
"longname": "module:TelephonyService#holdCall",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#holdCall",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @method isTelephonyAvailable\n * @category Telephony MANAGEMENT\n * @instance\n * @description\n * Check if the telephony service can be used or not (if the connected user has a phone monitored by a PBX)
\n * @return {boolean} Return true if the telephony service is configured\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 325,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"kind": "function",
"name": "isTelephonyAvailable",
"tags": [
{
"originalTitle": "category",
"title": "category",
"text": "Telephony MANAGEMENT",
"value": "Telephony MANAGEMENT"
}
],
"scope": "instance",
"description": "Check if the telephony service can be used or not (if the connected user has a phone monitored by a PBX)
",
"returns": [
{
"type": {
"names": [
"boolean"
]
},
"description": "Return true if the telephony service is configured"
}
],
"longname": "module:TelephonyService#isTelephonyAvailable",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#isTelephonyAvailable",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method logoff\n * @async\n * @category Telephony CALL\n * @instance\n * @param {String} endpointTel The endpoint device phone number.\n * @param {String} agentId optionnel CCD Agent identifier (agent device number).\n * @param {String} password optionnel Password or authorization code.\n * @param {String} groupId optionnel CCD Agent's group number\n * @description\n * This api allows an CCD Agent logoff logon from the CCD system.
\n * @return {Promise} Return resolved promise if succeed, and a rejected else.\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 2108,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "logoff",
"async": true,
"scope": "instance",
"params": [
{
"type": {
"names": [
"String"
]
},
"description": "The endpoint device phone number.",
"name": "endpointTel"
},
{
"type": {
"names": [
"String"
]
},
"description": "optionnel CCD Agent identifier (agent device number).",
"name": "agentId"
},
{
"type": {
"names": [
"String"
]
},
"description": "optionnel Password or authorization code.",
"name": "password"
},
{
"type": {
"names": [
"String"
]
},
"description": "optionnel CCD Agent's group number",
"name": "groupId"
}
],
"description": "This api allows an CCD Agent logoff logon from the CCD system.
",
"returns": [
{
"type": {
"names": [
"Promise"
]
},
"description": "Return resolved promise if succeed, and a rejected else."
}
],
"longname": "module:TelephonyService#logoff",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#logoff",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method logon\n * @async\n * @category Telephony CALL\n * @instance\n * @param {String} endpointTel The endpoint device phone number.\n * @param {String} agentId optionnel CCD Agent identifier (agent device number).\n * @param {String} password optionnel Password or authorization code.\n * @param {String} groupId optionnel CCD Agent's group number\n * @description\n * This api allows an CCD Agent to logon into the CCD system.
\n * @return {Promise} Return resolved promise if succeed, and a rejected else.\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 2073,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "logon",
"async": true,
"scope": "instance",
"params": [
{
"type": {
"names": [
"String"
]
},
"description": "The endpoint device phone number.",
"name": "endpointTel"
},
{
"type": {
"names": [
"String"
]
},
"description": "optionnel CCD Agent identifier (agent device number).",
"name": "agentId"
},
{
"type": {
"names": [
"String"
]
},
"description": "optionnel Password or authorization code.",
"name": "password"
},
{
"type": {
"names": [
"String"
]
},
"description": "optionnel CCD Agent's group number",
"name": "groupId"
}
],
"description": "This api allows an CCD Agent to logon into the CCD system.
",
"returns": [
{
"type": {
"names": [
"Promise"
]
},
"description": "Return resolved promise if succeed, and a rejected else."
}
],
"longname": "module:TelephonyService#logon",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#logon",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method makeCall\n * @instance\n * @async\n * @category Telephony CALL\n * @description\n * Call a number
\n * Contacts and numbers are allowed
\n * Return a promise
\n * @param {Contact} contact - contact object that you want to call\n * @param {String} phoneNumber The number to call\n * @param {String} correlatorData contains User-to-User information to be sent out as a SIP header via underlying PBX trunk for a given call\n * @return {Promise} Return a promise with the call created\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 793,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "makeCall",
"scope": "instance",
"async": true,
"description": "Call a number
\n Contacts and numbers are allowed
\n Return a promise
",
"params": [
{
"type": {
"names": [
"Contact"
]
},
"description": "contact object that you want to call",
"name": "contact"
},
{
"type": {
"names": [
"String"
]
},
"description": "The number to call",
"name": "phoneNumber"
},
{
"type": {
"names": [
"String"
]
},
"description": "contains User-to-User information to be sent out as a SIP header via underlying PBX trunk for a given call",
"name": "correlatorData"
}
],
"returns": [
{
"type": {
"names": [
"Promise."
]
},
"description": "Return a promise with the call created"
}
],
"longname": "module:TelephonyService#makeCall",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#makeCall",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method makeCall\n * @async\n * @category Telephony CALL\n * @instance\n * @description\n * Call a number
\n * Return a promise
\n * @param {String} phoneNumber The number to call\n * @param {String} correlatorData contains User-to-User information to be sent out as a SIP header via underlying PBX trunk for a given call\n * @return {Promise} Return a promise with the call created\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 1017,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "makeCall",
"async": true,
"scope": "instance",
"description": "Call a number
\n Return a promise
",
"params": [
{
"type": {
"names": [
"String"
]
},
"description": "The number to call",
"name": "phoneNumber"
},
{
"type": {
"names": [
"String"
]
},
"description": "contains User-to-User information to be sent out as a SIP header via underlying PBX trunk for a given call",
"name": "correlatorData"
}
],
"returns": [
{
"type": {
"names": [
"Promise."
]
},
"description": "Return a promise with the call created"
}
],
"longname": "module:TelephonyService#makeCall",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#makeCall",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method releaseCall\n * @async\n * @category Telephony CALL\n * @instance\n * @description\n * Release a call
\n * Return a promise
\n * @param {Call} call The call to release\n * @return {Promise} Return a promise with the call released\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 1174,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "releaseCall",
"async": true,
"scope": "instance",
"description": "Release a call
\n Return a promise
",
"params": [
{
"type": {
"names": [
"Call"
]
},
"description": "The call to release",
"name": "call"
}
],
"returns": [
{
"type": {
"names": [
"Promise."
]
},
"description": "Return a promise with the call released"
}
],
"longname": "module:TelephonyService#releaseCall",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#releaseCall",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method retrieveCall\n * @async\n * @category Telephony CALL\n * @instance\n * @description\n * Retrieve a call
\n * Return a promise
\n * @param {Call} call The call to retrieve\n * @return {Promise} Return a promise with the call retrieved\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 1377,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "retrieveCall",
"async": true,
"scope": "instance",
"description": "Retrieve a call
\n Return a promise
",
"params": [
{
"type": {
"names": [
"Call"
]
},
"description": "The call to retrieve",
"name": "call"
}
],
"returns": [
{
"type": {
"names": [
"Promise."
]
},
"description": "Return a promise with the call retrieved"
}
],
"longname": "module:TelephonyService#retrieveCall",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#retrieveCall",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method sendDtmf\n * @async\n * @category Telephony CALL\n * @instance\n * @description\n * send dtmf to the remote party
\n * @param {string} connectionId\n * @param {string} dtmf\n * @return {Promise} Return resolved promise if succeed, and a rejected else.\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 1866,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "sendDtmf",
"async": true,
"scope": "instance",
"description": "send dtmf to the remote party
",
"params": [
{
"type": {
"names": [
"string"
]
},
"name": "connectionId"
},
{
"type": {
"names": [
"string"
]
},
"name": "dtmf"
}
],
"returns": [
{
"type": {
"names": [
"Promise"
]
},
"description": "Return resolved promise if succeed, and a rejected else."
}
],
"longname": "module:TelephonyService#sendDtmf",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#sendDtmf",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method transfertCall\n * @async\n * @category Telephony CALL\n * @instance\n * @description\n * Transfer a held call to the active call
\n * User should have transfer rights
\n * Return a promise
\n * @param {Call} activeCall The active call\n * @param {Call} heldCall The held call to transfer to the activeCall\n * @return {Promise} Return resolved promise if succeed, and a rejected else.\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 1574,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "transfertCall",
"async": true,
"scope": "instance",
"description": "Transfer a held call to the active call
\n User should have transfer rights
\n Return a promise
",
"params": [
{
"type": {
"names": [
"Call"
]
},
"description": "The active call",
"name": "activeCall"
},
{
"type": {
"names": [
"Call"
]
},
"description": "The held call to transfer to the activeCall",
"name": "heldCall"
}
],
"returns": [
{
"type": {
"names": [
"Promise"
]
},
"description": "Return resolved promise if succeed, and a rejected else."
}
],
"longname": "module:TelephonyService#transfertCall",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#transfertCall",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method withdrawal\n * @async\n * @category Telephony CALL\n * @instance\n * @param {String} agentId optionnel CCD Agent identifier (agent device number).\n * @param {String} groupId optionnel CCD Agent's group number\n * @param {String} status optionnel Used to deactivate the withdrawal state. Values: 'on', 'off'; 'on' is optional.\n * @description\n * This api allows an CCD Agent to change to the state 'Not Ready' on the CCD system. When the parameter 'status' is passed and has the value 'off', the state is changed to 'Ready'
\n * @return {Promise} Return resolved promise if succeed, and a rejected else.\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 2143,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "withdrawal",
"async": true,
"scope": "instance",
"params": [
{
"type": {
"names": [
"String"
]
},
"description": "optionnel CCD Agent identifier (agent device number).",
"name": "agentId"
},
{
"type": {
"names": [
"String"
]
},
"description": "optionnel CCD Agent's group number",
"name": "groupId"
},
{
"type": {
"names": [
"String"
]
},
"description": "optionnel Used to deactivate the withdrawal state. Values: 'on', 'off'; 'on' is optional.",
"name": "status"
}
],
"description": "This api allows an CCD Agent to change to the state 'Not Ready' on the CCD system. When the parameter 'status' is passed and has the value 'off', the state is changed to 'Ready'
",
"returns": [
{
"type": {
"names": [
"Promise"
]
},
"description": "Return resolved promise if succeed, and a rejected else."
}
],
"longname": "module:TelephonyService#withdrawal",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#withdrawal",
"$kind": "method"
},
{
"comment": "/**\n * @public\n * @nodered true\n * @method wrapup\n * @async\n * @category Telephony CALL\n * @instance\n * @param {String} agentId CCD Agent identifier (agent device number).\n * @param {String} groupId CCD Agent's group number\n * @param {String} password optionnel Password or authorization code.\n * @param {String} status optionnel Used to deactivate the WrapUp state. Values: 'on', 'off'; 'on' is optional.\n * @description\n * This api allows an CCD Agent to change to the state Working After Call in the CCD system. When the parameter 'status' is passed and has the value 'off', the state is changed to 'Ready'.
\n * @return {Promise} Return resolved promise if succeed, and a rejected else.\n */",
"meta": {
"filename": "TelephonyService.js",
"lineno": 2183,
"columnno": 4,
"path": "/home/jenkins/workspace/cts_Rainbow-Node-SDK_LTSDelivery/lib/services",
"code": {}
},
"access": "public",
"tags": [
{
"originalTitle": "nodered",
"title": "nodered",
"text": "true",
"value": "true"
},
{
"originalTitle": "category",
"title": "category",
"text": "Telephony CALL",
"value": "Telephony CALL"
}
],
"kind": "function",
"name": "wrapup",
"async": true,
"scope": "instance",
"params": [
{
"type": {
"names": [
"String"
]
},
"description": "CCD Agent identifier (agent device number).",
"name": "agentId"
},
{
"type": {
"names": [
"String"
]
},
"description": "CCD Agent's group number",
"name": "groupId"
},
{
"type": {
"names": [
"String"
]
},
"description": "optionnel Password or authorization code.",
"name": "password"
},
{
"type": {
"names": [
"String"
]
},
"description": "optionnel Used to deactivate the WrapUp state. Values: 'on', 'off'; 'on' is optional.",
"name": "status"
}
],
"description": "This api allows an CCD Agent to change to the state Working After Call in the CCD system. When the parameter 'status' is passed and has the value 'off', the state is changed to 'Ready'.
",
"returns": [
{
"type": {
"names": [
"Promise"
]
},
"description": "Return resolved promise if succeed, and a rejected else."
}
],
"longname": "module:TelephonyService#wrapup",
"memberof": "module:TelephonyService",
"$longname": "TelephonyService#wrapup",
"$kind": "method"
}
]