{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":163,"path":"api-reference/NotifyOnTaskClient.md","title":"NotifyOnTaskClient - Client","bundle":null,"doc_type":null,"release":"australia","body":"\n# NotifyOnTaskClient- Client\n\nThe NotifyOnTaskClient API provides methods for sending SMS messages or starting/managing a conference call for various telephony service providers, such as Zoom and Webex.\n\nAny UI can consume the NotifyOnTaskClient API by explicitly including the NotifyOnTaskClient UI script.\n\nUsing the NotifyOnTaskClient API you can:\n\n- Start a conference call\n- End a conference call\n- Add participants\n- Perform actions that are available through the telephony driver such as:\n - mute/unmute participants\n - remove participants from a conference call\n - add participants to a conference call\n - start a conference call\n - end a conference call\n\nThe Notify \\(com.snc.notify\\) plugin requires a separate subscription. For additional information on activating the Notify plugin, see [Activate Notify](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/t_ActivateNotify.md).\n\n**Parent Topic:**[Client API reference](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/api-client.md)\n\n## NotifyOnTaskClient - addParticipants\\(Object data\\)\n\nAdds the specified participants to a specified conference call.\n\n\n
\n\nName\n\n\n\nType\n\n\n\nDescription\n\n
\n\ndata\n\n\n\nObject\n\n\n\nObject that describes the conference call.\n\n
\n\ndata.addToWorkNotes\n\n\n\nBoolean\n\n\n\nFlag that indicates whether to add information about the participants that were included in the conference call in the work notes field of the associated record. For this functionality to work, you must also specify values in the **data.table** and **data.sysId** parameters. These parameters identify the record in which to add the work notes.\n\nDefault: false\n\n
\n\ndata.confId\n\n\n\nString\n\n\n\nSys\\_id of the conference call. Table: Notify Conference Call \\[notify\\_conference\\_call\\]\n\n
\n\ndata.items\n\n\n\nArray\n\n\n\nInformation for each participant to include in the conference call. ```\n\"items\": [\n \"email\": \"String\",\n \"id\": \"String\",\n \"notifyParticipantId\": \"String\",\n \"phoneNumber\": \"String\"\n]\n```\n\n
\n\ndata.items.email\n\n\n\nString\n\n\n\nEmail address of the participant.\n\n
\n\ndata.items.id\n\n\n\nString\n\n\n\nUser sys\\_id.Table: User \\[sys\\_User\\]\n\n
\n\ndata.items.notifyParticipantId\n\n\n\nString\n\n\n\nParticipant sys\\_id.Table: Notify Participant \\[notify\\_participant\\]\n\n
\n\ndata.items.phoneNumber\n\n\n\nString\n\n\n\nPhone number of the participant. If this value is passed in conjunction with either the **id** or **notifyParticipantId** parameter, this value supersedes the phone numbers in the user/participant record and is used to place the call.\n\n
\n\ndata.message\n\n\n\nString\n\n\n\nMessage that is read aloud when a user answers the call, such as, \"P1 incident has been created please login to instance.\"\n\n
\n\ndata.serviceProvider\n\n\n\nString\n\n\n\nRequired. Name of conference service provider, such as Zoom or Webex.\n\n
\n\ndata.sysId\n\n\n\nString\n\n\n\nSys\\_id of the source record to associate with the conference call. For example, if a conference call is held to discuss a specific incident or problem, put the sys\\_id of the incident or problem record in this value. This sys\\_id is stored in the Source column of the NotifyConference Call \\[notify\\_conference\\_call\\] table and can later be tracked.\n\nThis parameter is used in conjunction with the **data.Table**, **data.addToWorkNotes**, and **allowMulticonference** parameters.\n\nYou should configure this value when the conference call is initially created through a \"start\" action. If required, you can also set this value through this method.\n\n
\n\ndata.table\n\n\n\nString\n\n\n\nTable that contains the source record to associate with the conference call. A source record can be any record, such as an \"incident\" or \"problem\", that is the topic of discussion in the conference call. This table name is stored in the Table column of the NotifyConference Call \\[notify\\_conference\\_call\\] table and can be tracked.\n\nThis parameter is used in conjunction with the **data.sysId**, **data.addToWorkNotes**, and **allowMulticonference** parameters.\n\nYou should configure this value when the conference call is initially created through a \"start\" action. If required, you can also set this value through this method.\n\n
\n
\n\nType\n\n\n\nDescription\n\n
\n\nObject\n\n\n\nResults of the conference action.`.status`: Status of the conference action.\n\n- Data type: Boolean\n- Possible values:\n - true: Conference action succeeded\n - false: Conference action failed\n\n`.successMessages`: If *status* is true, success message\\(s\\), else empty.\n\n- Data type: Array of Strings\n\n`.warnMessages`: If *status* is false, any warning messages thrown during processing.\n\n- Data type: Array of Strings\n\n`.errorMessages`: If *status* is false, any error messages thrown during processing.\n\n- Data type: Array of Strings\n\n
The following code example shows how to call this method.\n\n```\nfunction addToConferenceCall() {\n var data = NotifyOnTaskClient.getNotifyActionTemplate();\n data.serviceProvider = 'Telephony'; // e.g 'Zoom', 'WebEx'\n data.confId = 'Active conference sysId';\n data.items.push({ id: 'userSysId' });\n data.items.push({ phoneNumber: '+917799555331' });\n data.items.push({ email: 'yln99518@gmail.com' });\n\n NotifyOnTaskClient.addParticipants(data).then(function (result) {\n var joinActionResult = result[0];\n if(joinActionResult.status) {\n joinActionResult.successMessages.forEach(function(msg) {\n console.log(msg);\n });\n return;\n }\n\n joinActionResult.warnMessages.forEach(function(msg) {\n console.warn(msg);\n });\n joinActionResult.errorMessages.forEach(function(msg) {\n console.error(msg);\n });\n }, function (errMsg) {\n console.log(errMsg);\n });\n}\n```\n\n## NotifyOnTaskClient - doConferenceAction\\(String action, Object data\\)\n\nPerforms the specified conference call action, such as starting/ending a conference call or joining, removing, muting, or unmuting participants from a conference call.\n\nYou can start a new conference call and add participants within a single call to this method or call the method multiple times to start the call and then manage participants separately. In addition, through the passed in data object, you can configure the method to:\n\n- Save pointers in the conference call record to the specific record \\(source record\\), such as an incident or problem, that is the topic of discussion for the conference call.\n- Allow/disallow multiple conference calls for a source record.\n- Automatically log the participants that were in the conference call in the **Work notes** field of the source record.\n- Have a message read aloud when a participant answers an outgoing call from the conference.\n\n\n
\n\nName\n\n\n\nType\n\n\n\nDescription\n\n
\n\naction\n\n\n\nString\n\n\n\nDefines the conference call action to perform.The following are the available conference call actions:\n\n- end: Terminates the conference call identified in **data.confId**.\n- join: Adds the participant specified in the **data.items** array to the conference call identified in **data.confId**.\n- kick: Removes the participant specified in the **data.items** array from the conference call identified in **data.confId**.\n- multiJoin: Adds the participants specified in the **data.items** array to the conference call identified in **data.confId**\n- multiKick: Removes the participants specified in the **data.items** array from the conference call identified in **data.confId**.\n- multiMute: Mutes the participants specified in the **data.items** array on the conference call identified in **data.confId**.\n- multiUnmute: Unmutes the participants specified in the **data.items** array from the conference call identified in **data.confId**.\n- mute: Mutes the participant specified in the **data.items** array on the conference call identified in **data.confId**.\n- selfJoin: Adds the currently logged in user to the conference call \\(no entry in **data.items** required.\\)\n- start: Starts the conference call identified in **data.confId**.\n- unmute: Unmutes the participant specified in the **data.items** array from the conference call identified in **data.confId**.\n\n
\n\ndata\n\n\n\nObject\n\n\n\nObject that describes the conference call.\n\n
\n\ndata.addToWorkNotes\n\n\n\nBoolean\n\n\n\nFlag that indicates whether to add information about the participants that were included in the conference call in the work notes field of the associated record. For this functionality to work, you must also specify values in the **data.table** and **data.sysId** parameters. These parameters identify the record in which to add the work notes.\n\nDefault: false\n\nActions for which this parameter is valid:\n\n- join\n- multiJoin\n- selfJoin\n- start\n\n
\n\ndata.allowMulticonference\n\n\n\nBoolean\n\n\n\nFlag that indicates whether to allow multiple conference calls for a specific record at one time. For this functionality to work, you must also specify values in the **data.table** and **data.sysId** parameters. These parameters identify the record that is allowed to have multiple conference calls.\n\nDefault: false\n\nActions for which this parameter is valid:\n\n- start\n\n
\n\ndata.confId\n\n\n\nString\n\n\n\nSys\\_id of the conference call. Table: Notify Conference Call \\[notify\\_conference\\_call\\]\n\nActions for which this parameter is required:\n\n- end\n- join\n- multiJoin\n- selfJoin\n\n**Note:** Participant actions such as mute, unmute, and kick don't require this parameter to be set as the method obtains this information from the Notify Conference Call Participant \\[notify\\_participant\\] table.\n\n
\n\ndata.fromNumber\n\n\n\nString\n\n\n\nService provider number to call into for the conference call. Locate this value in the Number or Phone number column of the Notify Phone Number \\[notify\\_number\\] table.\n\nActions for which this parameter is required:\n\n- start\n\n
\n\ndata.isNewConference\n\n\n\nBoolean\n\n\n\nFlag that indicates whether this is a new or an existing conference call. Valid values:\n\n- true: New conference call\n- false: Existing conference call\n\nDefault: false\n\nActions for which this parameter is valid:\n\n- start\n\n
\n\ndata.message\n\n\n\nString\n\n\n\nMessage that is read aloud when a user answers the call, such as, \"P1 incident has been created please login to instance.\" Actions for which this parameter is valid:\n\n- join\n- multiJoin\n- start\n\n
\n\ndata.items\n\n\n\nArray\n\n\n\nInformation for each participant to include in the conference call. Valid array values:\n\n- id: Sys\\_id of user; located in the User \\[sys\\_User\\] table.\n\nValid actions: join, multiJoin, start\n\n- notifyParticipantId: Sys ID of the Notify participant; located in the Notify Participant \\[notify\\_participant\\] table.\n\nValid actions: join, kick, multiJoin, mute, start, unmute\n\n- phoneNumber: Phone number of the participant. If this value is passed in conjunction with either the **id** or **notifyParticipantId**, this value supersedes the phone numbers in the user/participant record and is used to place the call.\n\nValid actions: join, multiJoin, start\n\n- email: Email address of the participant.\n\nValid actions: join, multiJoin, start\n\n\n
\n\ndata.serviceProvider\n\n\n\nString\n\n\n\nRequired. Name of conference service provider, such as Zoom or Webex. Actions for which this parameter is required:\n\n- all\n\n
\n\ndata.sysId\n\n\n\nString\n\n\n\nSys\\_id of the source record to associate with the conference call. For example, if a conference call is held to discuss a specific incident or problem, put the sys\\_id of the incident or problem record in this value. This sys\\_id is stored in the Source column of the NotifyConference Call \\[notify\\_conference\\_call\\] table and can later be tracked.\n\nThis parameter is used in conjunction with the **data.Table**, **data.addToWorkNotes**, and **allowMulticonference** parameters.\n\nActions for which this parameter is valid:\n\n- start\n\n
\n\ndata.table\n\n\n\nString\n\n\n\nTable that contains the source record to associate with the conference call. A source record can be any record, such as an \"incident\" or \"problem\", that is the topic of discussion in the conference call. This table name is stored in the Table column of the NotifyConference Call \\[notify\\_conference\\_call\\] table and can be tracked.\n\nThis parameter is used in conjunction with the **data.sysId**, **data.addToWorkNotes**, and **allowMulticonference** parameters.\n\nActions for which this parameter is valid:\n\n- start\n\n
\n
\n\nType\n\n\n\nDescription\n\n
\n\nObject\n\n\n\nResults of the conference action.`.status`: Status of the conference action.\n\n- Data type: Boolean\n- Possible values:\n - true: Conference action succeeded\n - false: Conference action failed\n\n`.successMessages`: If *status* is true, success message\\(s\\), else empty.\n\n- Data type: Array of Strings\n\n`.warnMessages`: If *status* is false, any warning messages thrown during processing.\n\n- Data type: Array of Strings\n\n`.errorMessages`: If *status* is false, any error messages thrown during processing.\n\n- Data type: Array of Strings\n\n
The following example shows how to create a function to call doConferenceAction\\(\\) to manipulate the participants in a conference call by passing in the action and the participants.\n\n```\n\n/**\n * \n * @param {string} action - action to perform on the conference object or participant object\n * @param {Array} participants;\n */\nfunction doConferenceAction(action, participants) {\n var data = NotifyOnTaskClient.getNotifyActionTemplate();\n data.serviceProvider = 'Telephony'; // e.g 'Zoom', 'WebEx'\n data.confId = 'Active conference sysId';\n data.items = participants;\n\n NotifyOnTaskClient.doConferenceAction(action, data).then(function (result) {\n var kickActionResult = result[0];\n if (kickActionResult.status)\n console.log(action + ' succeeded');\n else {\n kickActionResult.warnMessages.forEach(function (msg) {\n console.warn(msg);\n });\n kickActionResult.errorMessages.forEach(function (msg) {\n console.error(msg);\n });\n }\n }, function (errMsg) {\n console.log(errMsg)\n });\n}\n\n// kick participants\n\ndoConferenceAction('kick', [{notifyParticipantId: 'notifyParticipantSysId'}]);\n\n// kick multiple participants\n\ndoConferenceAction('multiKick',\n [{notifyParticipantId: 'notifyParticipantSysId'},\n {notifyParticipantId: 'notifyParticipantSysId'}]);\n\n// Mute participants\ndoConferenceAction('mute', [{notifyParticipantId: 'notifyParticipantSysId'}]);\ndoConferenceAction('mute', [{notifyParticipantId: 'notifyParticipantSysId'}]);\n\ndoConferenceAction('multiMute',\n [{notifyParticipantId: 'notifyParticipantSysId'},\n {notifyParticipantId: 'notifyParticipantSysId'}]);\n\n// self join to any confernece. \ndoConferenceAction('selfJoin', [{id: 'logged in userId'}]);\n\n```\n\n## NotifyOnTaskClient - endConference\\(Object data\\)\n\nTerminates the specified conference call.\n\n|Name|Type|Description|\n|----|----|-----------|\n|data|Object|Object that describes the conference call.|\n|data.confId|String|Sys\\_id of the conference call.|\n|data.serviceProvider|String|Required. Name of conference service provider, such as Zoom or Webex.|\n\n\n
\n\nType\n\n\n\nDescription\n\n
\n\nObject\n\n\n\nResults of the conference action.`.status`: Status of the conference action.\n\n- Data type: Boolean\n- Possible values:\n - true: Conference action succeeded\n - false: Conference action failed\n\n`.successMessages`: If *status* is true, success message\\(s\\), else empty.\n\n- Data type: Array of Strings\n\n`.warnMessages`: If *status* is false, any warning messages thrown during processing.\n\n- Data type: Array of Strings\n\n`.errorMessages`: If *status* is false, any error messages thrown during processing.\n\n- Data type: Array of Strings\n\n
```\nfunction endConferenceCall() {\n var data = NotifyOnTaskClient.getNotifyActionTemplate();\n data.serviceProvider = 'Telephony'; // e.g 'Zoom', 'WebEx'\n data.confId = 'Active conference sysId';\n\n NotifyOnTaskClient.endConference(data).then(function (result) {\n var endActionResult = result[0];\n if (endActionResult.status)\n console.log('Conference has been ended');\n else {\n endActionResult.warnMessages.forEach(function (msg) {\n console.warn(msg);\n });\n endActionResult.errorMessages.forEach(function (msg) {\n console.error(msg);\n });\n }\n }, function (errMsg) {\n console.log(errMsg);\n });\n}\n```\n\n## NotifyOnTaskClient - getNotifyActionTemplate\\(\\)\n\nReturns a JSON data template to use with the doConferenceAction\\(\\) method. Using this template automatically structures the data object so that you don't have to manually create it.\n\nCall this method prior to calling the doConferenceAction\\(\\) method. For the desired conference call action, set the desired parameters within the template, and then pass the template in the doConferenceAction\\(\\) call. For additional information on the valid parameters for each action, see [doConferenceAction\\(\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/NotifyOnTaskClient.md).\n\n**Note:** This is a helper method. You can also manually construct this object and pass it into the doConferenceAction\\(\\) method and have the same outcome.\n\n|Name|Type|Description|\n|----|----|-----------|\n|None| | |\n\n\n
\n\nType\n\n\n\nDescription\n\n
\n\ndata\n\n\n\nObject that describes the conference call.\n\n
\n\ndata.addToWorkNotes\n\n\n\nFlag that indicates whether to add information about the participants that were included in the conference call in the work notes field of the associated record. For this functionality to work, you must also specify values in the **data.table** and **data.sysId** parameters. These parameters identify the record in which to add the work notes.\n\nDefault: false\n\nActions for which this parameter is valid:\n\n- join\n- multiJoin\n- selfJoin\n- start\n\n
\n\ndata.allowMultconference\n\n\n\nFlag that indicates whether to allow multiple conference calls for a specific record at one time. For this functionality to work, you must also specify values in the **data.table** and **data.sysId** parameters. These parameters identify the record that is allowed to have multiple conference calls.\n\nDefault: false\n\nActions for which this parameter is valid:\n\n- start\n\n
\n\ndata.confId\n\n\n\nSys\\_id of the conference call. Table: Notify Conference Call \\[notify\\_conference\\_call\\]\n\nActions for which this parameter is required:\n\n- end\n- join\n- multiJoin\n- selfJoin\n\n**Note:** Participant actions such as mute, unmute, and kick don't require this parameter to be set as the method obtains this information from the Notify Conference Call Participant \\[notify\\_participant\\] table.\n\n
\n\ndata.fromNumber\n\n\n\nService provider number to call into for the conference call. Locate this value in the Number or Phone number column of the Notify Phone Number \\[notify\\_number\\] table.\n\nActions for which this parameter is required:\n\n- start\n\n
\n\ndata.isNewConference\n\n\n\nFlag that indicates whether this is a new or an existing conference call. Valid values:\n\n- true: New conference call\n- false: Existing conference call\n\nDefault: false\n\nActions for which this parameter is valid:\n\n- start\n\n
\n\ndata.items\n\n\n\nInformation for each participant to include in the conference call. Valid array values:\n\n- id: Sys\\_id of user; located in the User \\[sys\\_User\\] table.\n\nValid actions: join, multiJoin, start\n\n- notifyParticipantId: Sys ID of the Notify participant; located in the Notify Participant \\[notify\\_participant\\] table.\n\nValid actions: join, kick, multiJoin, mute, start, unmute\n\n- phoneNumber: Phone number of the participant. If this value is passed in conjunction with either the **id** or **notifyParticipantId**, this value supersedes the phone numbers in the user/participant record and is used to place the call.\n\nValid actions: join, multiJoin, start\n\n- email: Email address of the participant.\n\nValid actions: join, multiJoin, start\n\n\n
\n\ndata.message\n\n\n\nMessage that is read aloud when a user answers the call, such as, \"P1 incident has been created please login to instance.\" Actions for which this parameter is valid:\n\n- join\n- multiJoin\n- start\n\n
\n\ndata.serviceProvider\n\n\n\nRequired. Name of conference service provider, such as Zoom or Webex. Actions for which this parameter is required:\n\n- all\n\n
\n\ndata.sysId\n\n\n\nSys\\_id of the source record to associate with the conference call. For example, if a conference call is held to discuss a specific incident or problem, put the sys\\_id of the incident or problem record in this value. This sys\\_id is stored in the Source column of the NotifyConference Call \\[notify\\_conference\\_call\\] table and can later be tracked.\n\nThis parameter is used in conjunction with the **data.Table**, **data.addToWorkNotes**, and **allowMulticonference** parameters.\n\nActions for which this parameter is valid:\n\n- start\n\n
\n\ndata.table\n\n\n\nTable that contains the source record to associate with the conference call. A source record can be any record, such as an \"incident\" or \"problem\", that is the topic of discussion in the conference call. This table name is stored in the Table column of the NotifyConference Call \\[notify\\_conference\\_call\\] table and can be tracked.\n\nThis parameter is used in conjunction with the **data.sysId**, **data.addToWorkNotes**, and **allowMulticonference** parameters.\n\nActions for which this parameter is valid:\n\n- start\n\n
The following example shows how to call getNotifyActionTemplate\\(\\) to obtain the data template necessary to define the actions for doConferenceAction\\(\\).\n\n```\n\n/**\n * \n * @param {string} action - action to perform on the conference object or participant object\n * @param {Array} participants;\n */\nfunction doConferenceAction(action, participants) {\n var data = NotifyOnTaskClient.getNotifyActionTemplate();\n data.serviceProvider = 'Telephony'; // e.g 'Zoom', 'WebEx'\n data.confId = 'Active conference sysId';\n data.items = participants;\n\n NotifyOnTaskClient.doConferenceAction(action, data).then(function (result) {\n var kickActionResult = result[0];\n if (kickActionResult.status)\n console.log(action + ' succeeded');\n else {\n kickActionResult.warnMessages.forEach(function (msg) {\n console.warn(msg);\n });\n kickActionResult.errorMessages.forEach(function (msg) {\n console.error(msg);\n });\n }\n }, function (errMsg) {\n console.log(errMsg)\n });\n}\n\n// kick participants\n\ndoConferenceAction('kick', [{notifyParticipantId: 'notifyParticipantSysId'}]);\n\n// kick multiple participants\n\ndoConferenceAction('multiKick',\n [{notifyParticipantId: 'notifyParticipantSysId'},\n {notifyParticipantId: 'notifyParticipantSysId'}]);\n\n// Mute participants\ndoConferenceAction('mute', [{notifyParticipantId: 'notifyParticipantSysId'}]);\ndoConferenceAction('mute', [{notifyParticipantId: 'notifyParticipantSysId'}]);\n\ndoConferenceAction('multiMute',\n [{notifyParticipantId: 'notifyParticipantSysId'},\n {notifyParticipantId: 'notifyParticipantSysId'}]);\n\n// self join to any confernece. \ndoConferenceAction('selfJoin', [{id: 'logged in userId'}]);\n\n```\n\n## NotifyOnTaskClient - start\\(Object data\\)\n\nStarts a new conference call.\n\n\n
\n\nName\n\n\n\nType\n\n\n\nDescription\n\n
\n\ndata\n\n\n\nObject\n\n\n\nObject that describes the conference call.\n\n
\n\ndata.addToWorkNotes\n\n\n\nBoolean\n\n\n\nOptional.Flag that indicates whether to add information about the participants that were included in the conference call in the work notes field of the associated record. For this functionality to work, you must also specify values for the **data.table** and **data.sysId** parameters to identify the record in which to add the work notes.\n\n Default: false\n\n
\n\ndata.allowMulticonference\n\n\n\nBoolean\n\n\n\nOptional. Flag that indicates whether to allow multiple conference calls for a specific record at one time. For this functionality to work, you must also specify values in the **data.table** and **data.sysId** parameters. These parameters identify the record that is allowed to have multiple conference calls.\n\n Default: false\n\n
\n\ndata.fromNumber\n\n\n\nString\n\n\n\nRequired. Service provider number to call into for the conference call. Locate this value in the Number or Phone number column of the Notify Phone Number \\[notify\\_number\\] table.\n\n
\n\ndata.items\n\n\n\nArray\n\n\n\nOptional. Information for each participant to include in the conference call. ```\n\"items\": [\n \"email\": \"String\",\n \"id\": \"String\",\n \"notifyParticipantId\": \"String\",\n \"phoneNumber\": \"String\"\n]\n```\n\n
\n\ndata.items.email\n\n\n\nString\n\n\n\nEmail address of the participant.\n\n
\n\ndata.items.id\n\n\n\nString\n\n\n\nUser sys\\_id.Table: User \\[sys\\_User\\]\n\n
\n\ndata.items.notifyParticipantId\n\n\n\nString\n\n\n\nParticipant sys\\_id.Table: Notify Participant \\[notify\\_participant\\]\n\n
\n\ndata.items.phoneNumber\n\n\n\nString\n\n\n\nPhone number of the participant. If this value is passed in conjunction with either the **id** or **notifyParticipantId** parameter, this value supersedes the phone numbers in the user/participant record and is used to place the call.\n\n
\n\ndata.message\n\n\n\nString\n\n\n\nOptional. Message that is read aloud when a user answers the call, such as, \"P1 incident has been created please login to instance.\"\n\n
\n\ndata.serviceProvider\n\n\n\nString\n\n\n\nRequired. Name of conference service provider, such as Zoom or Webex.\n\n
\n\ndata.sysId\n\n\n\nString\n\n\n\nOptional. Sys\\_id of the source record to associate with the conference call. For example, if a conference call is held to discuss a specific incident or problem, put the sys\\_id of the incident or problem record in this value. This sys\\_id is stored in the Source column of the NotifyConference Call \\[notify\\_conference\\_call\\] table and can later be tracked.\n\n This parameter is used in conjunction with the **data.Table**, **data.addToWorkNotes**, and **allowMulticonference** parameters.\n\n
\n\ndata.table\n\n\n\nString\n\n\n\nOptional. Table that contains the source record to associate with the conference call. A source record can be any record, such as an \"incident\" or \"problem\", that is the topic of discussion in the conference call. This table name is stored in the Table column of the NotifyConference Call \\[notify\\_conference\\_call\\] table and can be tracked.\n\n This parameter is used in conjunction with the **data.sysId**, **data.addToWorkNotes**, and **allowMulticonference** parameters.\n\n
\n
\n\nType\n\n\n\nDescription\n\n
\n\nObject\n\n\n\nResults of the conference action.`.status`: Status of the conference action.\n\n- Data type: Boolean\n- Possible values:\n - true: Conference action succeeded\n - false: Conference action failed\n\n`.successMessages`: If *status* is true, success message\\(s\\), else empty.\n\n- Data type: Array of Strings\n\n`.warnMessages`: If *status* is false, any warning messages thrown during processing.\n\n- Data type: Array of Strings\n\n`.errorMessages`: If *status* is false, any error messages thrown during processing.\n\n- Data type: Array of Strings\n\n
The following code example shows how to call this method.\n\n```\nfunction startConferenceCall() {\n var data = NotifyOnTaskClient.getNotifyActionTemplate();\n data.table = 'incident';\n data.sysId = '1234';\n data.serviceProvider = serviceProvider;\n data.addToWorkNotes = true;\n data.fromNumber = 'Telephony Number';\n data.items.push({ id: 'userSysId' });\n data.items.push({ phoneNumber: '+917799555332' });\n data.items.push({ email: 'yln99517@gmail.com' });\n\n NotifyOnTaskClient.start(data).then(function (result) {\n var startActionResult = result[0];\n if(startActionResult.status) {\n startActionResult.successMessages.forEach(function(msg) {\n console.log(msg);\n });\n return;\n }\n\n startActionResult.warnMessages.forEach(function(msg) {\n console.warn(msg);\n });\n startActionResult.errorMessages.forEach(function(msg) {\n console.error(msg);\n });\n }, function (errMsg) {\n console.log(errMsg);\n });\n}\n```\n\n"}}