Purpose
This method allocates an Interaction's unique identifier to an available phone number. This enables the agent taking the call to view the Interaction history in the Agent Application.

Invoking the Method Using REST

URL Syntax and Example

http(s)://[host:port/internalPath]/Application Name/version/[version]/dnis/allocate/new

https://gointeract.io/interact/version/2/dnis/allocate/new

HTTP Method
POST

HTTP Headers

Tenant-Id: <account>
Application-Key: <application key of relevant app>

Use the application key of the application you are using to run the Interaction (either Mobile Web or Web Self Service). 

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

Environment-Name: <environment-name>

HTTP Body

{ 
"group" : "test",
"id" : "Unique Id 3"
}
URI Field Data Type Description/Notes
group string A user defined logical association for the number. This field is not mandatory.
id string The Interaction's unique identifier.

Expected Responses

Response Scenario Status Code/Header Example Message
Success (phone found and allocated) 200 <allocated phone number>
Invalid request parameter 400 <reason>
Invalid security headers 401
"Unauthenticated-Reason" Header
{
"code":"0x7000000",
"message": "Request is unauthorized, missing or wrong credentials",
"moreInfoUrl":"http://www.jacada.com/support",
}
No phone numbers were found 403 Currently there are no available phone numbers
Message ID does not exist 404 Audit message <message id> 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

Tenant-Id: <tenantId>
Application-Key: <application key of relevant app>

Use the application key of the application you are using to run the Interaction (either Mobile Web or Web Self Service). 

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
uniqueId The Interaction's unique identifier.
group A user defined logical association for the number. This field is not mandatory. 

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:AllocateDnisPhoneRequest>
<soap:uniqueId>c4116d57-2ed1-4e3a-9b65-24c41acde08d</soap:uniqueId>
<soap:group>Group1</soap:group>
</soap:AllocateDnisPhoneRequest>
</soapenv:Body>
</soapenv:Envelope>

Expected Responses

Response Scenario Example Message
Success (phone found and allocated) <ns2:result>Success</ns2:result>
<ns2:result><id of the number></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>
No phone numbers were found <ns2:result>Currently there are no available phone numbers</ns2:result>
Message ID does not exist <ns2:result>Audit message <message id> was not found</ns2:result>
General error (internal error) exception (in XML format)

Revision:

Comments