Purpose
This method frees a phone number to which an Interaction's unique identifier is currently allocated. The number is freed after the IVR retrieves the unique Interaction identifier. If the customer does not dial the call center, the number should be automatically released from allocation following a predefined timeout period.

Invoking the Method Using REST

URL Syntax and Example

http(s)://[host:port/internalPath]/Application Name/version/[version]/dnis/allocate/free/{phone}

https://gointeract.io/interact/version/2/dnis/allocate/free/380974520200

Specific URI Fields

URI Field Data Type Description/Notes
phone string The number to which the Interaction unique ID is allocated.

HTTP Method
POST

HTTP Headers

User-Id: <Base 64 encode of username>
User-Password: <Base 64 encode of user password>
Tenant-Id: <account>
Application-Key: <dnis application key>

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

Environment-Name: <environment-name>

In the following example, the username is admin and the password is password:

User-Id: YWRtaW4=
User-Password: cGFzc3dvcmQ=
Tenant-Id: 12345678
Application-Key: 53475e5f1463f9ab2052ead

Expected Responses

Response Scenario Status Code/Header Example Message
Success (phone found with allocation and freed successfully) 200 EMPTY
Success (phone found but is not allocated) 200 EMPTY
Invalid security headers 401
"Unauthenticated-Reason" Header
{
"code":"0x7000000",
"message": "Request is unauthorized, missing or wrong credentials",
"moreInfoUrl":"http://www.jacada.com/support",
}
Phone number does not exist 404 Phone number  <phone number> was not found
General error (internal error) 500 exception

Invoking the Method Using SOAP

WSDL URL

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

Headers

User-Id: <Base 64 encode of username>
User-Password: <Base 64 encode of user password>
Tenant-Id: <tenantId>
Application-Key: <dnis 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 Description
phone The number to which the Interaction unique ID is allocated.

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://com/jacada/interact/dnis/soap">
<soapenv:Header/>
<soapenv:Body>
<soap:FreeDnisAllocationRequest>
<soap:phone>222</soap:phone>
</soap:FreeDnisAllocationRequest>
</soapenv:Body>
</soapenv:Envelope>

Expected Responses

Response Scenario Example Message
Success (phone found with allocation and freed successfully) <ns2:result>Success</ns2:result>
Success (phone found but is not allocated) <ns2:result>Phone number <phone number> was not found</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>
Phone number does not exist <ns2:result>Phone number <phone number> was not found</ns2:result>
General error (internal error) exception (in XML format)

 

Revision:

Comments