Management APIs
The Management API calls relate to availability and general instructions to the service.
Init
This method clears any previous data that exists for the current TenantId and External Id combination. If the method is not called, the Action and Mapping APIs will not perform as expected.
It is recommended to call the Init method at the beginning of each session.
Invoking the Init Method Using REST
URL Syntax and Example
http(s)://[host:port/internalPath]/VoiceProxy/version/[version]/account/[accountID]/Interaction/[externalId]/Init
https://gointeract.io/VoiceProxy/version/2/account/demoAccount/Interaction/123/Init
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 | Recommended Actions |
|---|---|---|---|
Success | 200 | Success | |
Invalid security headers | 401 "Unauthenticated-Reason" Header | { "code":"0x7000000", "message": "Request is unauthorized, missing or wrong credentials", "moreInfoUrl":"http://support.uniphore.com", } | Verify that you are using the correct tenantId and application key. |
General error | 500 | exception | Verify that a session exists and you are using the correct extId. |
Invoking the Init 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:InitRequest>
<map:tenantId>jasqa32</map:tenantId>
<map:extId>972548120901</map:extId>
</map:InitRequest>
</soapenv:Body>
</soapenv:Envelope>
Expected Responses
Response Scenario | Example Message | Recommended Actions |
|---|---|---|
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> | Verify that you are using the correct tenantId and application key. |
General error | exception (in XML format) | Verify that a session exists and you are using the correct extId. |
Service Availability
This method checks whether the service is available. If the service is available, it returns true. If the service is not available, this call will time out.
Invoking the Service Availability Method Using REST
URL Syntax and Example
http(s)://[host:port/internalPath]/VoiceProxy/version/[version]/account/[accountID]/IsServiceAvailable
https://gointeract.io/VoiceProxy/version/2/account/demoAccount/IsServiceAvailable
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 | Example Message |
|---|---|---|
Success | 200 | true |
Failure (service not available) | - | no response (timeout) |
Invoking the Service Availability 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>
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:IsServiceAvailableRequest/> </soapenv:Body> </soapenv:Envelope>
Expected Responses
Response Scenario | Example Message |
|---|---|
Success | <ns2:result>true</ns2:result> |
Failure (service not available) | no response (timeout) |