Dial 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 Dial 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 Dial (e.g. function=Dial)
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 on which to place a dial request on their behalf
search: set to YES to find the associated contact first or NO to not perform a lookup
preview: set to YES to place agent in preview mode prior to dialing or NO to immediately dial the contact
phone_code: country code prefix to use for phone number (e.g. "1" for USA, "92" for Pakistan, etc)
phone_number: phone number of the person to call

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

For successful submissions:
SUCCESS: Dial Request Sent - [phone_number|user name|settings]

For submissions with errors:
ERROR: User is not allowed to place manual dial calls - [user name]
ERROR: The phone number is not valid - [ID of list]
ERROR: User is not in Paused status - [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=Dial
company_id=ABC
user=api-user
agent_user=agent
search=YES
preview=NO
phone_code=1
phone_number=8586336376

Sample HTTP GET Request

https://cloud.qubicles.io/agent/api.php?function=Dial&company_id=ABC&user=api-user&agent_user=agent
&search=YES&preview=NO&phone_code=1&phone_number=8586336376