1947_10.DOC

DOC document 89 KB Posted

Attached to
IT- Interactive Voice Response (IVR) Solution
Contract number
505ENT-W07-IVOICER-01
Issued by
Wisconsin

About this file

This document is a technical design specification for a 3rd Party Vendor IVR (Interactive Voice Response) integration system, version 1.2, developed by Telephony@Work for their CallCenter@nyWhere platform. The document was created and modified between 2005-2006 by Kerem T. Sozugecer and outlines the web services interface that enables external IVR systems to integrate with the CallCenter@nyWhere call center platform. No specific state agencies, consortiums, or jurisdictions are identified in this technical documentation.

The document defines web services that facilitate call routing, data attachment, and reporting capabilities between external IVR systems and the CallCenter@nyWhere platform. Key services include session management (opening, maintaining, and closing sessions), interaction management (creating new interactions, obtaining unique interaction IDs, and ending interactions), custom history tracking, external variable transmission, and call transfer protocols using DTMF signaling. The integration allows external IVR systems to send calls with attached data to CallCenter@nyWhere, store IVR data within the platform, and maintain unified call histories that match data collected by both systems. The document does not contain pricing terms, contract amounts, renewal periods, or procurement-specific information, as it appears to be purely technical documentation for software integration rather than a contractual agreement.

View the file

Other files

File Type Posted
1947_11.PDF PDF
1947_14.DOC DOC document
1947_16.PDF PDF
1947_21.PDF PDF
1947_3.PDF PDF
1947_8.PDF PDF
1947_13.DOC DOC document
1947_20.PDF PDF
1947_6.PDF PDF
1947_0.DOC DOC document
1947_1.DOC DOC document
1947_17.XLS XLS spreadsheet
1947_22.XLSX XLSX spreadsheet
1947_5.PDF PDF
1947_7.PDF PDF
1947_12.DOC DOC document
1947_15.DOC DOC document
1947_19.PDF PDF
1947_2.XLS XLS spreadsheet
1947_4.PDF PDF
1947_9.PDF PDF
Show all 21

On GovTribe

Work with this file

  • Download the original file
  • Contacts named in this file
  • Similar government files
  • Ask GovTribe AI about this file

Text version

3rd Party Vendor

IVR

Document Version:
1.2
Last Modified:
12/11/2006
Total Pages:
8

Change History

List each alteration that occurs within this design document.

Date
Author
Description
02/17/2005
Kerem T. Sozugecer
Document creation
04/08/2005
Kerem T. Sozugecer
Addition of existing web services
8/30/2005
Kerem T. Sozugecer
2 new functions: createNewCustomInteractionFromToEx

addCustomHistoryActionEx

02/15/2005
Kerem T. Sozugecer
New Function: setVariable

CONTENTS

4Overview

5Existing Web Services

5Opening a new session

5Preventing the session from expiring

5Closing a session

5New Web Services

5Getting New Interaction Id

5Creating New Custom Interaction

6Ending Custom Interaction

6Adding Custom History Action

7Sending an External Variable

8Transferring Calls

Overview

The purpose of this document is to provide and define the interface that allows an external IVR integrate with T@W CallCenter@nyWhere platform.

The integration of an External IVR with CallCenter@nyWhere has to allow:

· Sending calls from IVR to CallCenter@nyWhere and be able to attach data to the calls.

· Reporting and storing IVR data to CallCenter@nyWhere platform.

· Matching of the data collected by an external IVR to the data collected by CallCenter@nyWhere for every call.

Telephony@Work provides a web services interface that allows an external IVR to interact with CallCenter@nyWhere platform.

Existing Web Services

Session.wsdl

Opening a new session

Open(String companyAlias, String username, String password)

This web method returns a session Id.

Preventing the session from expiring Handoff(String sessionId) This web method prevents the session from expiring. It should be called if the integrating system does not poll CCA for messages to keep the session open.

Closing a session

Close(String sessionId) This web method closes the session.

New Web Services Interactions.wsdl

Getting New Interaction Id GetNewInteractionId(String sessionId)

This web method returns a unique interaction id to be used by the external IVR. External IVR can pass this id to CallCenter@nyWhere each time a request is sent through web services. Therefore, CallCenter@nyWhere can match the request with an interaction.

Creating New Custom Interaction

CreateNewCustomInteraction(String sessionId, CustomInteraction customInteraction)

This web method creates a new interaction in CallCenter@nyWhere. It requires a CustomInteraction object as a parameter.

CustomInteraction Object has the following properties:

· interactionid: Interaction Id received from “GetNewCustomInteractionId()” above

· origin: Originator of the interaction

· destination: Destination of the interaction CreateNewCustomInteractionFromToEx(String sessionId, String interactionId, String from, String to)

This web method creates a new interaction in CallCenter@nyWhere without having to pass a customInteraction object.

Parameters

· interactionid: Interaction Id received from “GetNewCustomInteractionId()” above

· from: ANI

· to: DNIS

Ending Custom Interaction EndCustomInteraction(String sessionId, String interactionId)

This web service will allow a external IVR to notify CallCenter@nyWhere that an interaction are ended. This service will be used only when the interaction is ended without a transfer to CallCenter@nyWhere. If the calls are transferred to CallCenter@nyWhere this service cannot be used because the interaction will continue in CallCenter@nyWhere platform.

Adding Custom History Action

AddCustomHistoryAction(String sessionId, CustomHistoryAction action)

This web method adds news custom history action to the interaction history. It requires a CustomHistoryAction object as a parameter.

CustomHistoryAction Object has the following properties:

· interactionid: Interaction Id received from “GetNewCustomInteractionId()” above

· type: type of the history action

· 1 : Any text can be sent with this action id

· 2 : A URL can be sent with this action id

· value: value of the URL or the Text Message

AddCustomHistoryActionEx(String sessionId, String interactionId, String actionType, String actionValue)

This web method creates a new custom history action without the need of passing a CustomHistoryAction object.

Sending an External Variable SetVariable(String sessionId, String interactionId, String key, String value) This method can be used to send information from the IVR in addition to what CCA already stores for an interaction. It requires sending the sessionId and InteractionId as well as a key and value for a variable, key being the variable name and value being the variable value.

Transferring Calls If the interaction is transferred to CallCenter@nyWhere platform, it will be routed to a specific project within CallCenter@nyWhere. Once the call is answered by the project the external IVR will be prompted to send the unique interaction identifier. CallCenter@nyWhere will send a DTMF pound (#) to the IVR. The IVR will send the identifier as DTMF and terminate with DTMF pound (#). CallCenter@nyWhere will send DTMF star (*) to confirm that the identifier was received successfully.

CallCenter@nyWhere will not generate a new interaction identifier for that call but will use the one provided by the external IVR so that CallCenter@nyWhere can continue processing the call that the external IVR started. This will allow the integrated system the handle the call as a single call. Therefore the call history will contain unified information collected by both systems.

PAGE

File details come from the government source that posted it. Updated .