Hangup Call API

HANGUPCALL API

Qubicles Contact Center exposes certain functions via its API for use by external services, such as a web form hosted by an outside organization. The information below describes the process for using the core HangupCall function via HTTP POST or GET methods.

POSTBACK URL

Form submission should be sent to the following URL:

https://cloud.qubicles.io/agent/api.php

POSTBACK URL PARAMETERS
The following parameters could be used to submit information along with your HTTP GET or POST request:

function: the name of the action you would like to execute. This must be set to HangupCall (e.g. function=HangupCall)
company_id: company Id provided by Qubicles after registration
user: user name of user with permission to call this API
agent_user: user name of agent to hang up call for
value: set to a value of "1" to indicate call should be hung up

Return Codes
Upon submission one of the following responses will be returned from the web service indicating success or failure:

For successful submissions:
SUCCESS: Hangup Call Request Sent - [1|agent user name]

For submissions with errors:
ERROR: User is not Logged In - [agent user name]
ERROR: Invalid authentication specified - [agent user name]

Sample HTTP POST Request

POST /agent/api.php HTTP/1.1
Host:https://cloud.qubicles.io
Content-Type: application/x-www-form-urlencoded
Content-Length: 32

function=HangupCall
company_id=ABC
user=api-user
agent_user=agent
value=1

Sample HTTP GET Request

https://cloud.qubicles.io/agent/api.php?function=HangupCall&company_id=ABC&user=api-user&agent_user=agent&value=1