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/):


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   
    ParameterTypeRequiredDescription
    providerProviderCredentialRequiredCredentials required to authenticate and authorize the request.
    visitIdLongRequiredUnique internal identifier assigned by ContactAtOnce! representing a specific chat session between a site visitor and an advertiser. See VisitId
    messageStringRequiredThe message that is displayed to the site visitor in the conversation as the agent and to the answering agent as a (whisper).

    Response  
    ResponsePartDataDescription
    HeaderHeaderStandard ContactAtOnce! Web Service Response Header. Empty if there is a failure.
    Body--Return values include :
    • 0 - Success
    • Fault - Failure

    Inband Alert

    Sends a message into an in-process chat session.  The message is displayed to the answering agent in a context tab.

    Request   
    ParameterTypeRequiredDescription
    providerProviderCredentialRequiredCredentials required to authenticate and authorize the request.
    visitIdLongRequiredUnique internal identifier assigned by ContactAtOnce! representing a specific chat session between a site visitor and an advertiser. See VisitId
    alertRequestInBandAlertRequestRequiredMessage to be sent to context window of CAO Agent Client software for the corresponding VisitID

    Response  
    ResponsePartDataDescription
    HeaderHeaderStandard ContactAtOnce! Web Service Response Header. Empty if there is a failure.
    Body--Return values include :
    • Empty Body - Success
    • Fault - Failure