This method is used to aggregate the total number of times that a caller made a new call to an Agent following the use of VIVR. The method updates a Boolean value that is associated with the caller ID.

Invoking the Method Using REST

URL Syntax and Example

http(s)://[host:port/internalPath]/Application Name/version/[version]/account/ [accountID]/resources/jp/updateTransferToAgentCount

https://gointeract.io/interact/version/2/account/12345678/resources/jp/updateTransferToAgentCount

Specific URI Fields
None

HTTP Method
POST

HTTP Headers

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

When working in a Multi Environment configuration, the Header must include the name of the current environment:

Environment-Name: <environment-name>

HTTP Body

{ "callerId" : "+972 54 4696388" }
URI Field Data Type Description
callerId string Customer phone number

Sample Request

POST /interact/version/2/account/12345678/resources/campaign/jp/updateTransferToAgentCount HTTP/1.1
Host: localhost:8080
Tenant-Id: {tenantId}
Application-Key: 53736e07e4b05772e6475c2d
Content-Type: application/json
Cache-Control: no-cache
{ "callerId" : "+972 54 4696388" }

Expected Responses

Response Scenario Status Code/Header Example Message
Success 200  
Invalid body parameter(s) 400 missing or invalid parameter <parameter>
Invalid security headers 401
"Unauthenticated-Reason" Header
{
"code":"0x7000000",
"message": "Request is unauthorized, missing or wrong credentials",
"moreInfoUrl":"http://www.jacada.com/support",
}
Outdated campaign/interaction session 403 Token expired
General error (internal error from the Interact server) 500 exception

Invoking the Method Using SOAP

WSDL URL
https:/gointeract.io/interact/version/2/agent/soap/agent.wsdl

Headers

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

When working in a Multi Environment configuration, the Header must include the name of the current environment:

Environment-Name: <environment-name>

Input Parameters

Parameter Type Description
callerId string Customer phone number

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://com/jacada/interact/agent/soap">
<soapenv:Header/>
<soapenv:Body>
<soap:UpdateTransferToAgentCountRequest>
<soap:callerId>+972548120901</soap:callerId>
</soap:UpdateTransferToAgentCountRequest>
</soapenv:Body>
</soapenv:Envelope>

Expected Responses

Response Scenario Example Message
Success <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <SOAP-ENV:Body>
        <ns2:UpdateTransferToAgentCountResponse xmlns:ns2="http://com/jacada/interact/agent/soap">
            <ns2:message>Success</ns2:message>
         </ns2:UpdateTransferToAgentCountResponse>
     </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Invalid body parameter(s) <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <SOAP-ENV:Body>
        <ns2:UpdateTransferToAgentCountResponse xmlns:ns2="http://com/jacada/interact/agent/soap">
            <ns2:uniqueId>Missing or invalid parameter <parameter></ns2:uniqueId>
        </ns2:UpdateTransferToAgentCountResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
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>
General error (internal error from the Interact server) exception (in XML format)

Revision:

Comments