Mapping APIs

The Mapping APIs enable synchronizing of data between the Visual IVR and the Voice IVR. The data is a collection of key-value pairs, where each IVR can set or get the pairs. The pairs are also available per session.

Important

Before calling the Mapping APIs, the Init method must be invoked to establish the session.

Put Mapping

This service adds a key-value pair to the session. If the specified key already exists, the existing value will be overridden, and that value (i.e., the previous value) will be returned. If no previous key exists, the service will return null.

Invoking the Put Mapping Method Using REST

URL Syntax and Example

http(s)://[host:port/internalPath]/VoiceProxy/version/[version]/account/[accountID]/Interaction/[externalId]/PutMapping/[key]/Value/[value]

https://gointeract.io/VoiceProxy/version/2/account/demoAccount/Interaction/123/PutMapping/var1/Value/abc

Specific URI Fields

URI Field	Data Type	Description
key	string	A pair to be associated in this session.
value	string	A pair to be associated in this session.

HTTP Method

POST

HTTP Headers

Tenant-Id: <account>
Application-Key: <Public API Service application key>
Environment-Name: <environment-name>

Expected Responses

Response Scenario	Status Code/Header	Example Message
Success (first time)	201	EMPTY
Success (previous value exists)	200	(latest value of the parameter)
Invalid security headers	401 "Unauthenticated-Reason" Header	{ "code":"0x7000000", "message": "Request is unauthorized, missing or wrong credentials", "moreInfoUrl":"http://support.uniphore.com", }
Session is not initialized or timed out	404	session <session id> was not found
General error	500	exception

Invoking the Put Mapping Method Using SOAP

WSDL URL

https://gointeract.io/VoiceProxy/version/2/soap/mapping.wsdl

Headers

Tenant-Id: <account>
Application-Key: <Public API Service application key>
Environment-Name: <environment-name>

Input Parameters

Parameter	Description
tenantId	An identifier for the account in the system. Your tenant Id is the value at the end of the URL used to log into the Visual IVR X-Console (e.g., https://gointeract.io/admin/login/monitor).
extId	A string identifying the session uniquely within this tenant (e.g., UCID, ANI, etc.).
key	A variable pair to be associated in this session.
value	A variable pair to be associated in this session.

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:map="http://com/jacada/interact/soap/mappingservice">
 <soapenv:Header/>
 <soapenv:Body>
   <map:PutMappingRequest>
     <map:tenantId>jasqa32</map:tenantId>
     <map:extId>972548120901</map:extId>
     <map:key>var2</map:key>
     <map:value>12345</map:value>
   </map:PutMappingRequest>
 </soapenv:Body>
</soapenv:Envelope>

Expected Responses

Response Scenario	Example Message
Success (first time)	<ns2:result>Success</ns2:result>
Success (previous value exists)	<ns2:result>Success</ns2:result> <ns2:result>LAST VALUE</ns2:result>
Invalid security headers	<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>0x7000000</faultcode> <faultstring>Request is unauthorized, missing or wrong credentials</faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Session is not initialized or timed out	<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:GetInteractionUniqueIdResponse xmlns:ns2="http://com/jacada/interact/agent/soap"> <ns2:uniqueId>session <session id> was not found</ns2:uniqueId> </ns2:GetInteractionUniqueIdResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
General error	exception (in XML format)

Get Mapping

This service retrieves a key-value pair according to the key name. If the specified key already exists, it will return the value. If the key does not exist, the service will return null.

Invoking the Get Mapping Method Using REST

URL Syntax and Example

http(s)://[host:port/internalPath]/VoiceProxy/version/[version]/account/[accountID]/Interaction/[externalId]/GetMapping/[key]

https://gointeract.io/VoiceProxy/version/2/account/demoAccount/Interaction/123/GetMapping/var1

Specific URI Fields

URI Field	Data Type	Description
key	string	The key in the key-value pair stored by the PutMapping API.

HTTP Method

GET

HTTP Headers

Tenant-Id: <account>
Application-Key: <Public API Service application key>
Environment-Name: <environment-name>

Expected Responses

Response Scenario	Status Code/Header	Example Message
Success	200	(latest value of the parameter)
Invalid security headers	401 "Unauthenticated-Reason" Header	{ "code":"0x7000000", "message": "Request is unauthorized, missing or wrong credentials", "moreInfoUrl":"http://support.uniphore.com", }
Success (but variable not found)	404	variable <variable name> was not found
Session is not initialized or timed out	404	session <session id> was not found
General error	500	exception

Invoking the Get Mapping Method Using SOAP

WSDL URL

https://gointeract.io/VoiceProxy/version/2/soap/mapping.wsdl

Headers

Tenant-Id: <account>
Application-Key: <Public API Service application key>
Environment-Name: <environment-name>

Input Parameters

Parameter

Description

tenantId

An identifier for the account in the system. Your tenant Id is the value at the end of the URL used to log into the Visual IVR X-Console

(e.g., https://gointeract.io/admin/login/monitor).

extId

A string identifying the session uniquely within this tenant (e.g., UCID, ANI, etc.).

key

The key in the key-value pair stored by the PutMapping API.

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:map="http://com/jacada/interact/soap/mappingservice">
 <soapenv:Header/>
 <soapenv:Body>
   <map:GetMappingRequest>
     <map:tenantId>jasqa32</map:tenantId>
     <map:extId>972548120901</map:extId>
     <map:key>var1</map:key>
   </map:GetMappingRequest>
 </soapenv:Body>
</soapenv:Envelope>

Expected Responses

Response Scenario	Example Message
Success	<ns2:result>Success</ns2:result> <ns2:result>LAST VALUE</ns2:result>
Invalid security headers	<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>0x7000000</faultcode> <faultstring>Request is unauthorized, missing or wrong credentials</faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Success (but variable not found)	<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:GetInteractionUniqueIdResponse xmlns:ns2="http://com/jacada/interact/agent/soap"> <ns2:uniqueId>Variable <Variable Name> was not found</ns2:uniqueId> </ns2:GetInteractionUniqueIdResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Session is not initialized or timed out	<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:GetInteractionUniqueIdResponse xmlns:ns2="http://com/jacada/interact/agent/soap"> <ns2:uniqueId>session <session id> was not found</ns2:uniqueId> </ns2:GetInteractionUniqueIdResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
General error	exception (in XML format)

Get Mapping By Array

This service parses an array of session identifiers to retrieve the value of a specified key (generally the user identifier). The method goes through a specified array of sessions and searches for the key in each session. If the key is found, the value from the most recent session is returned. If no session contains the key, the service will return an empty value.

Invoking the Get Mapping By Array Method Using REST

URL Syntax and Example

http(s)://[host:port/internalPath]/VoiceProxy/version/[version]/account/[accountID]/Interaction/[externalId]/GetMappingByArray/[key]

https://gointeract.io/VoiceProxy/version/2/account/demoAccount/Interaction/123/GetMappingByArray/var1

Specific URI Fields

URI Field	Data Type	Description
key	string	The key in the key-value pair stored by the PutMapping API.

HTTP Method

POST

HTTP Headers

Tenant-Id: <account>
Application-Key: <Public API Service application key>
Environment-Name: <environment-name>

HTTP Body

{ "session1",  "session2"}

Expected Responses

Response Scenario	Status Code/Header	Example Message
Success (variable exists)	200	(latest value of the parameter variable)
Invalid security headers	401 "Unauthenticated-Reason" Header	{ "code":"0x7000000", "message": "Request is unauthorized, missing or wrong credentials", "moreInfoUrl":"http://support.uniphore.com", }
Session is not initialized or timed out	404	session <session id> was not found
General error	500	exception

Invoking the Get Mapping By Array Method Using SOAP

WSDL URL

https://gointeract.io/VoiceProxy/version/2/soap/mapping.wsdl

Headers

Tenant-Id: <account>
Application-Key: <Public API Service application key>
Environment-Name: <environment-name>

Input Parameters

Parameter

Description

tenantId

An identifier for the account in the system. Your tenant Id is the value at the end of the URL used to log into the Visual IVR X-Console

(e.g., https://gointeract.io/admin/login/monitor).

extIds

Arrays identifying the session uniquely within this tenant (e.g., UCID, ANI, etc.).

key

The key in the key-value pair stored by the PutMapping API.

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:map="http://com/jacada/interact/soap/mappingservice">
 <soapenv:Header/>
 <soapenv:Body>
   <map:GetMappingByArrayRequest>
     <map:tenantId>demoAccount</map:tenantId>
     <!--1 or more repetitions:-->
     <map:extIds>session1</map:extIds>
     <map:extIds>session2</map:extIds>
     <map:key>var1</map:key>
   </map:GetMappingByArrayRequest>
 </soapenv:Body>
</soapenv:Envelope>

Expected Responses

Response Scenario	Example Message
Success (variable exists)	<ns2:result>Success</ns2:result> <ns2:result>LAST VALUE OF THE VARIABLE</ns2:result>
Invalid security headers	<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>0x7000000</faultcode> <faultstring>Request is unauthorized, missing or wrong credentials</faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Session is not initialized or timed out	<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:GetInteractionUniqueIdResponse xmlns:ns2="http://com/jacada/interact/agent/soap"> <ns2:uniqueId>session <session id> was not found</ns2:uniqueId> </ns2:GetInteractionUniqueIdResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
General error	exception (in XML format)

Get All Mappings

This service retrieves the mapping of all key-value pair variables.

Invoking the Get All Mappings Method Using REST

URL Syntax and Example

http(s)://[host:port/internalPath]/VoiceProxy/version/[version]/account/[accountID]/Interaction/[externalId]/GetAllMappings

https://gointeract.io/VoiceProxy/version/2/account/demoAccount/Interaction/123/GetAllMappings

HTTP Method

GET

HTTP Headers

Tenant-Id: <account>
Application-Key: <Public API Service application key>
Environment-Name: <environment-name>

Expected Responses

Response Scenario	Status Code/Header	Example Message
Success	200	message: latest values of all the parameter variables [ { "key": "Variable1", "value": "value1" }, { "key": "Variable2", "value": "value2" } ]
Invalid security headers	401 "Unauthenticated-Reason" Header	{ "code":"0x7000000", "message": "Request is unauthorized, missing or wrong credentials", "moreInfoUrl":"http://support.uniphore.com", }
Success (no variables)	404	no variables were found
Session is not initialized or timed out	404	session <session id> was not found
General error	500	exception

Invoking the Get All Mappings Method Using SOAP

WSDL URL

https://gointeract.io/VoiceProxy/version/2/soap/mapping.wsdl

Headers

Tenant-Id: <account>
Application-Key: <Public API Service application key>
Environment-Name: <environment-name>

Input Parameters

Parameter

Description

tenantId

An identifier for the account in the system. Your tenant Id is the value at the end of the URL used to log into the Visual IVR X-Console

(e.g., https://gointeract.io/admin/login/monitor).

extId

A string identifying the session uniquely within this tenant (e.g., UCID, ANI, etc.).

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:map="http://com/jacada/interact/soap/mappingservice">
 <soapenv:Header/>
 <soapenv:Body>
   <map:GetAllMappingsRequest>
     <map:tenantId>jasqa32</map:tenantId>
     <map:extId>972548120901</map:extId>
   </map:GetAllMappingsRequest>
 </soapenv:Body>
</soapenv:Envelope>

Expected Responses

Response Scenario	Example Message
Success	<ns2:result>Success</ns2:result> <ns2:result>LAST VALUES</ns2:result>
Invalid security headers	<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>0x7000000</faultcode> <faultstring>Request is unauthorized, missing or wrong credentials</faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Success (no variables)	<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:GetInteractionUniqueIdResponse xmlns:ns2="http://com/jacada/interact/agent/soap"> <ns2:uniqueId>No variables were found</ns2:uniqueId> </ns2:GetInteractionUniqueIdResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Session is not initialized or timed out	<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:GetInteractionUniqueIdResponse xmlns:ns2="http://com/jacada/interact/agent/soap"> <ns2:uniqueId>session <session id> was not found</ns2:uniqueId> </ns2:GetInteractionUniqueIdResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
General error	exception (in XML format)

Remove Mapping

This service removes a key-value pair according to the key name.

Invoking the Remove Mapping Method Using REST

URL Syntax and Example

http(s)://[host:port/internalPath]/VoiceProxy/version/[version]/account/[accountID]/Interaction/[externalId]/RemoveMapping/[key]

https://gointeract.io/VoiceProxy/version/2/account/demoAccount/Interaction/123/RemoveMapping/var1

Specific URI Fields

URI Field	Data Type	Description
key	string	The key in the key-value pair stored by the PutMapping API.

HTTP Method

GET

HTTP Headers

Tenant-Id: <account>
Application-Key: <Public API Service application key>
Environment-Name: <environment-name>

Expected Responses

Response Scenario	Status Code/Header	Example Message
Success (variable exists)	200	latest value of the parameter variable
Invalid security headers	401 "Unauthenticated-Reason" Header	{ "code":"0x7000000", "message": "Request is unauthorized, missing or wrong credentials", "moreInfoUrl":"http://support.uniphore.com", }
Success (variable does not exist)	404	no variables were found
Session is not initialized or timed out	404	session <session id> was not found
General error	500	exception

Invoking the Remove Mapping Method Using SOAP

WSDL URL

https://gointeract.io/VoiceProxy/version/2/soap/mapping.wsdl

Headers

Tenant-Id: <account>
Application-Key: <Public API Service application key>
Environment-Name: <environment-name>

Input Parameters

Parameter

Description

tenantId

An identifier for the account in the system. Your tenant Id is the value at the end of the URL used to log into the Visual IVR X-Console

(e.g., https://gointeract.io/admin/login/monitor).

extId

A string identifying the session uniquely within this tenant (e.g., UCID, ANI, etc.).

key

The key in the key-value pair stored by the PutMapping API.

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:map="http://com/jacada/interact/soap/mappingservice">
 <soapenv:Header/>
 <soapenv:Body>
   <map:RemoveMappingRequest>
     <map:tenantId>jasqa32</map:tenantId>
     <map:extId>972548120901</map:extId>
     <map:key>var1</map:key>
   </map:RemoveMappingRequest>
 </soapenv:Body>
</soapenv:Envelope>

Expected Responses

Response Scenario	Example Message
Success (variable exists)	<ns2:result>Success</ns2:result> <ns2:result>LAST VALUE</ns2:result>
Invalid security headers	<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>0x7000000</faultcode> <faultstring>Request is unauthorized, missing or wrong credentials</faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Success (variable does not exist)	<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:GetInteractionUniqueIdResponse xmlns:ns2="http://com/jacada/interact/agent/soap"> <ns2:uniqueId>variable <variable name> was not found</ns2:uniqueId> </ns2:GetInteractionUniqueIdResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Session is not initialized or timed out	<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:GetInteractionUniqueIdResponse xmlns:ns2="http://com/jacada/interact/agent/soap"> <ns2:uniqueId>session <session id> was not found</ns2:uniqueId> </ns2:GetInteractionUniqueIdResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
General error	exception (in XML format)

In this section:

Uniphore Customer Portal

Mapping APIs

Important

Put Mapping

Get Mapping

Get Mapping By Array

Get All Mappings

Remove Mapping

Search results