Click 2 Call

Used to trigger a call to given number.

Agent must login to Alotech and open agent console before triggering this method.

This is an async method, always returns "success".

Required parameters:

ParameterDescription
phonenumberMandatory. Number you want to call.
transactionidOptional. You can use a unique id to get information about your request. If not provided Alotech is generating a GUID for each call.
sessionMandatory. Session key for the agent.
hangup_url

Optional. If you provide a url in this field, Alotech sends a HTTP POST request to this url as soon as the call hangs up.

You can find the POST body in the following table.

selected_queueOptional. You can enable queue selection (from the agent screen) by setting this parameter to 'on', otherwise calls starts from default queue.
masked

Optional.

If the called number is to be masked.

Valid options:

  • 1
  • on
  • true
ParameterTypeDescription
call_idstringUnique call id
caller_idstringCalling number
called_numstringCalled number
call_datestringCall date in "yyyy-mm-dd hh:mm:ss" format
transaction_idstringTransaction id of the call
agent_usernamestringUsername of the agent
durationintDuration of the call in seconds
dispositionstringDisposition of the dial attempt. You can find the values in the below table
tenantstringTenant name of the call
DispositionDescription
ANSWER

Call is answered. A successful dial. The caller reached the callee.

BUSY

Busy signal.

NOANSWERThe dial command reached its number, the number rang for too long, then the dial timed out.
CANCELCall is cancelled. The dial command reached its number but the caller hung up before the callee picked up.
CONGESTIONThis status is usually a sign that the dialled number is not recognised.
CHANUNAVAILChannel unavailable. On SIP, peer may not be registered.
DONTCALL

Privacy mode, callee rejected the call.

TORTURE

Privacy mode, callee chose to send caller to torture menu

INVALIDARGSError parsing Dial command arguments


Example: http://alotech.alo-tech.com/api/?function=click2call&phonenumber=01234567890&transactionid=0123456789012345&session=12345678&hangup_url=http://crm.com/hanguphandler/


Hangup URL POST Body Content Type: form-urlencoded string