The Action APIs allow the Visual IVR to send requests to a Voice IVR. When the Visual IVR sends the request, the module saves it in a FIFO stack. The Voice IVR will then poll the module to get the next available action.

Each action has a name and may contain several variables, as required. Action names should be agreed upon ahead of time between the Visual IVR designer and the Voice IVR designer. Typical names include:

  • Step: Declares that the user has reached a step in the Interaction.
  • Prompt: Instructs the Voice IVR to play a specific prompt.
  • Transfer:  Instructs the Voice IVR to perform a transfer.

Note: To avoid compromised server performance, it is recommended for an action to contain no more than 20 variables.

IMPORTANT: Before calling the Action APIs, the Init method needs to be invoked in order to establish a session.

Add Action

This service adds an action to the FIFO stack. It is typically called by the Visual IVR.

Invoking the Method Using REST

URL Syntax and Example

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

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

Specific URI Fields

URI FieldData TypeDescription
action string Name of the action

HTTP Method
POST

HTTP Headers

Tenant-Id: <account>
Application-Key: <Public API Service application key>

HTTP Body

{
"variable1":"${variable1}",
"variable2": "${variable2}",
"variable3": "${variable3}",
"variable4": "${variable4}",
"variable5": "${variable5}"
}

Expected Responses

Response ScenarioStatus Code/HeaderExample Message
Success 200  Success
Invalid security headers 401
"Unauthenticated-Reason" Header
{
"code":"0x7000000",
"message": "Request is unauthorized, missing or wrong credentials",
"moreInfoUrl":"http://www.jacada.com/support",
}
Session is not initialized or timed out 404 session <session id> was not found
General error 500 exception

Invoking the 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>

Input Parameters

ParameterDescription
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 Admin Console
(e.g., https://gointeract.io/admin/login/monitor).
extId A string identifying the session uniquely within this tenant (e.g., UCID, ANI, etc.).
action Name of the relevant action.
key A variable pair to be associated in this session.
value

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:AddActionRequest>
<map:tenantId>jasqa32</map:tenantId>
<map:extId>972548120901</map:extId>
<map:action>Step</map:action>
<!--1 or more repetitions:-->
<map:values>
<map:key>var1</map:key>
<map:value>123</map:value>
</map:values>
</map:AddActionRequest>
</soapenv:Body>
</soapenv:Envelope>

Expected Responses

Response ScenarioExample Message
Success <ns2:result>Success</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 Action

This service returns the next available action in the Actions stack. If there are no more actions in the stack, it returns NoActions.

Invoking the Method Using REST

URL Syntax and Example

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

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

HTTP Method
GET

HTTP Headers

Tenant-Id: <account>
Application-Key: <Public API Service application key>

Expected Responses

Response ScenarioStatus Code/HeaderExample Message
Success (actions found) 200 Last Action
{
    "actionName": "Step",
    "actionTimeMili": 2473,
    "variables": {
        "variable1": "Question1",
        "variable2": "aaa"
    },
    "returnCode": "Success"
}
Success (no actions) 200 {
    "actionName": "NoActions",
    "actionTimeMili": 0
}
Invalid security headers 401
"Unauthenticated-Reason" Header
{
"code":"0x7000000",
"message": "Request is unauthorized, missing or wrong credentials",
"moreInfoUrl":"http://www.jacada.com/support",
}
Session is not initialized or timed out 404 session <session id> was not found
General error 500 exception

Invoking the 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>

Input Parameters

ParameterDescription
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 Admin 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:GetActionRequest>
<map:tenantId>jasqa32</map:tenantId>
<map:extId>972548120901</map:extId>
</map:GetActionRequest>
</soapenv:Body>
</soapenv:Envelope>

Expected Responses

Response ScenarioExample Message
Success (actions found) <ns2:result>Success</ns2:result>
Success (no actions) <ns2:action>NoActions</ns2:action>
<ns2:actionTimeMili>0</ns2:actionTimeMili>
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)

Revision:

Comments