Adapter - 3C
This page describes version 2.0.10 of the adapter.
Overview
This adapter interacts with 3C system to send IM and to start or end a host desk session on a phone.
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
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 |
Get Hot Desk phone (getHotDeskPhone)
Requests a hot desk session on a phone.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| address | Preferred Address | User's preferred address | True | string |
| password | Phone Access Password | The password for accessing the phone | False | string |
| mac_or_primaddr | MAC or Primary Address | Phone identification, either a MAC address or phone's primary address | True | string |
Release Hot Desk phone (releaseHotDeskPhone)
Releases a hot desk session on a phone.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| address | Preferred Address | User's preferred address | True | string |
| mac_or_primaddr | MAC or Primary Address | Phone identification, either a MAC address or phone's primary address | True | string |
Transfer Call (transferCall)
Transfer a call from a given terminal to another number.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| terminalAddressValue | Terminal Address Value | Address value for the terminal that transfers call | True | string |
| terminalAddressType | Terminal Address Type | Address type (e.g. ext) for the terminal that transfers call | True | string |
| transferNumber | Transfer Number | The number to transfer the call to (E.164 international standard telephone number format required. Characters limited to '+' prefix and up to 15 digits [0-9]) | True | string |
| call | Call Identifier | Unique identifier for the call to be transferred | True | string |
| outboundCallerValue | Outbound Caller ID Value | Address value for the outbound caller id (E.164 international standard telephone number format required. Characters limited to '+' prefix and up to 15 digits [0-9]) | False | string |
| outboundCallerType | Outbound Caller ID Type | Address type for the outbound caller id | False | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Call Transfer Status (success if true) | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | The first release in the Adapter Type store. | ||
| 2.0.7 | Feature Maintenance |
The command Transfer Call was added, changes were made to improve multiple adapter connection support, and error handling was improved. Updated third-party components and improved maintainability. |
NAP-6463 NAP-11518 |
|
| 2.0.8 | Bug fix | Corrected misleading help hint for 3C Server URI | NAP-22498 | |
| 2.0.9 | Maintenance | Updated third-party components and improved maintainability. | NAP-23945 | 2022-11-29 |
| 2.0.10 | Feature &Maintenance | The command Transfer Call was updated to support the assignment of outbound caller ID. Miscellaneous third-party components were also updated. |
NAP-25350 | 2023-05-16 |