Conversation Manager Service
Description
The Conversation Manager Service provides operations for controlling, or enhancing, in-process chat sessions.
Version 1 WSDL
Format: XML
Method: POST
URL (regionally defined. Note: The SOAP action between regions does not change and will always be at base url https://services.contactatonce.com/):
- North America : https://services.contactatonce.com/ConversationManager.asmx?WSDL
- Australia : https://services.contactatonce.com.au/ConversationManager.asmx?WSDL
- Europe : https://services.contactatonce.co.uk/ConversationManager.asmx?WSDL
Requests
SendMessage
Sends a message into an in-process chat session. The message is displayed to the site visitor in the conversation as the agent and to the answering agent as a (whisper).
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
visitId | Long | Required | Unique internal identifier assigned by ContactAtOnce! representing a specific chat session between a site visitor and an advertiser. See VisitId |
message | String | Required | The message that is displayed to the site visitor in the conversation as the agent and to the answering agent as a (whisper). |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. Empty if there is a failure. |
Body | -- | Return values include :
|
Inband Alert
Sends a message into an in-process chat session. The message is displayed to the answering agent in a context tab.
Request | |||
---|---|---|---|
Parameter | Type | Required | Description |
provider | ProviderCredential | Required | Credentials required to authenticate and authorize the request. |
visitId | Long | Required | Unique internal identifier assigned by ContactAtOnce! representing a specific chat session between a site visitor and an advertiser. See VisitId |
alertRequest | InBandAlertRequest | Required | Message to be sent to context window of CAO Agent Client software for the corresponding VisitID |
Response | ||
---|---|---|
ResponsePart | Data | Description |
Header | Header | Standard ContactAtOnce! Web Service Response Header. Empty if there is a failure. |
Body | -- | Return values include :
|