Adapter - 3C Event
This page describes version 2.0.10 of the adapter.
Overview
This adapter is used to monitor a 3C system for events such as when a chat message or phone call is received. It can also send chat messages.
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| serveruri | 3C Server URI | True | Server URI like https://serverdnsname/SphericallService | string | 1024 | ||||
| username | Username | True | 3C Username in upn format eg : test@domain | string | 1024 | ||||
| password | Password | True | Password of the user | password | 1024 |
Info
The 3C user account that is used in the username adapter property must have at least one address assigned to it on the 3C server in order for this adapter to connect successfully.
Commands
Start Monitoring Users (startMonitoringUsers)
Start Monitoring Users for events.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| users | Users to monitor | Users to monitor | True | array |
| users[0].username | Username | Username | True | string |
Stop Monitoring Users (stopMonitoringUsers)
Stop monitoring users for events.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| users | Users to stop monitor | Users to stop monitor | True | array |
| users[0].username | Username | Username | True | string |
Start Monitoring Terminals (startMonitoringTerminals)
Start monitoring terminals for events.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| terminals | Terminals to monitor | Specify up to 500 terminals to monitor. Submit multiple requests to monitor more than 500 terminals. | True | array |
| terminals[0].addressvalue | Address Value | The unique identifiable address that provides callable identity for the terminal. | True | string |
| terminals[0].addresstype | Address Type | The address type (e.g. ext) for the terminal. | True | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status (success or failure) | string |
| errorMessage | Error detail in case monitoring any one of the terminals fails. | string |
Stop Monitoring Terminals (stopMonitoringTerminals)
Stop monitoring terminals for events.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| terminals | Terminals to stop monitoring | Terminals to stop monitoring | True | array |
| terminals[0].addressvalue | Address Value | The unique identifiable address that provides callable identity for the terminal. | True | string |
| terminals[0].addresstype | Address Type | The address type (e.g. ext) for the terminal. | True | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status (success or failure) | string |
| errorMessage | Error detail in case stopMonitoring any one of the terminals fails. | string |
Send IM/Text (sendText)
Starts the chat session and sends a message.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| destuser | Destination User | User to send text to. | True | string |
| message | Message | Message to send | True | string |
Events
3C Connected (connected3C)
The connection to 3C has been established.
No properties defined
Presence Changed (presenceChanged)
User Presence change notification.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| user | User ID | The unique ID of the user. | string |
| presence | Presence | The new presence status of the user. | string |
| presenceNote | PresenceNote | Additional note associated to the presence status of user. | string |
IM Received (imReceived)
User received a new chat message.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| receivingUser | Receiving User | The username of the user. | string |
| sendingUser | Sending User | The username of the user. | string |
| message | Message | The chat message received. | string |
Monitored Terminal Event (monitoredTerminalEventReceived)
Call Info event for a monitored terminal.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| calledAddressValue | Called Party's address value | The address value for the monitored terminal. | string |
| calledAddressType | Called Party's address type | The address type (e.g. ext) for the monitored terminal. | string |
| caller | Caller | The caller number | string |
| callType | Call Type | Call Type. | string |
| isIncoming | Is Incoming | True if it is an incoming call, else false. | boolean |
| callState | Call State | Call State (e.g. Ringing, Disconnected). | string |
| call | Call | The integer identifier for the call to be transferred. | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | ||
| 2.0.7 | Feature Maintenance |
Commands were added to Start Monitoring Terminals and Stop Monitoring Terminals. A new event was also added called Monitored Terminal Event Received. Updated third-party components and improved maintainability. |
NAP-6463 NAP-11518 |
|
| 2.0.8 | Bug fix Feature |
Corrected misleading help hint for 3C Server URI Added send IM command for sending chat responses |
NAP-22498 NAP-22644 |
|
| 2.0.9 | Maintenance | Updated third-party components and improved maintainability. | NAP-23945 | 2022-11-29 |
| 2.0.10 | Maintenance | Miscellaneous third-party components were updated. | NAP-25350 | 2023-05-16 |