API ALERTS FOR GlobalEx Switchboard

 

Note: All API required license activation!

Incoming call alert

The alert can be execute on incoming call to: inbound route, extension ringing, announcement, Extension available on Queue or Ring group

The API can be sent with  json post\get, XML.

Caller

Caller number

Target

Dialed number

ext

Ringing extension

Callid

Unique call id

Example:

https://webhook.url/incomingCall?callid={callid}&ext={extention_num}&caller={caller_num}&target={taqrget}

 

END CALL EVENT

End call event will be sent for all incoming and outgoing calls

Webhook example:

https://webhook.url/end_call?caller=XXXXXX&target=XXXX&time=XXXXX&duration=XX&ivruniqueid=XXXX&type=XXXXXXX&
status=XXXXX&targetextension=XXXXX&callerextension=XXXX&did=X&queueid=XXXX
&queuename=XXX&record=XXXXXX&dialtime=XXXX&domain=XXXXX&domain_name=XXXXXX

parameters:

caller

Caller number

target  

Dailed number

time  

Time of the call

duration  

Overall call time

ivruniqeid  

IVR unique id

type –

Incoming\Outgoing

status

"ANSWER",NO ANSWER, BUSY, CONGESTION

callerextention  

Caller extention

did  

Direct Inward Dialing

queuid  

Queue or Ring group unique id

queuename  

Queue or Ring group unique name

record  

Call recored name

dialtime  

Billable call time

domain  

PBX server address

domain_name

Organization name

 

 

Encode link for recording:

Code will be provide when license activation 

Without converting the file name, the recording cannot be played without manual verification to the switchboard

Parameters will be taken from end call event

 

The link produced at the end of the conversion allows direct access to playing and downloading the file

 

click2call:

Enables dialing numbers at the push of a button by sending a request to a URL address in the Post/Get configuration. The service allows third-party systems to use the telephony system as part of the system's services.

The system will first dial an extension/internal service number (dial1) and after answering the destination number (dial2) will be dialed unless otherwise defined (Reverse)

Note:  if desire recording When using click to call url dial, must set “SetCID” in the request for call recording!

send request example:

final parameters will be provided with license activation.

https://voip.globalex.co.il/API/dialup.php?user=XXXXXX&pass=XXXX&org=XXXXX&dial1=XXXXX&dial2=XXXXXX&Response=yes&SetCID=XXXXX

Parameters:

  1. Text/HTML (default)
  2. XML
  3. JSON

Demand

description

Parameter

Mandatory

Username

user

Mandatory

Password

pass

Mandatory

Organization

org

Mandatory

Extension\first dial number

Dial1

Mandatory

Destination in E164 format

Dial2

optional

Request for response

Response

optional

Response format: text, html, xml, json

RFormat

optional

Define the caller ID

Parameters only in numbers

SetCID

optional

Revers dial (dial1\dial2)

Reverse

optional

Setting a time to answer before hanging up.

Possible parameters: numeric value between 1-300 (time in seconds).

If not defined, the default time is 20 seconds for a response.

Timeout

 

Extension status check:

Enables checking current extension status with additional details of the call channel, call destination, call time, call ID and recording file (if available)

Also, can be used for “hangup” running call.

send request example:

https://voip.globalex.co.il/API/dialup.php?user=XXXX&pass=XXXX&org=XXXX&exten=XXXX

the request will retrieve the Extension status before executing next command or scenario

response parameters:

  1. Text/HTML (default)
  2. XML
  3. JSON

Demand

description

Parameter

Mandatory

Username

User

Mandatory

Password

Pass

Mandatory

Organization

Org

Mandatory

Internal Extension number

exten

optional

request for response
set: yes

Response

optional

Response format: text, html, xml, json

RFormat

optional

Operation:

hangup

operation

Possible statuses of the extension modes : free, busy, ringing, unavailable.

 

additional  details during active call  if Response set “yes”

  • Channel – name and channel number
  • BridgedUniqueid – ID number of the opposite channel (with whom this extension is talking)
  • Uniqueid – unique call ID

When Uniqeid is known it is possible to pull the recording and/or generate a call report using this parameter

 

CDR details

API URL:

https://panel.bluebe.net/api/cdr.php

This API allows you to perform the following operations:

  1. Get CDR & billing reports to current organization and a specific and/or all organization for the admin.
  2. Get calls report to specific number within defined start and end date.

Option to send request:

POST

Response format:

JSON

Optional parameters:

Demand

Description

Parameter

Mandatory

Paste your individual token

org_token

Optional

User password

call_status

Optional

Incoming calls to this DID number

did_number

Optional

You can use the following signs ><= (example >10 will indicate getting all records that the call total duration is higher than 10)

call_duration

Optional

Source number of the call (only integer allowed)

call_source

Optional

Destination number of the call (only integer allowed)

call_destination

Optional

Call unique ID

With this field you will get just the specific call needed

call_uniqueId

Optional

You can use the following signs ><= (example >10 will indicate getting all records that the call price is higher than 10)

call_price

Optional

Calls destination by country

call_country

Optional

Organization name
Available parameters:

Empty – display all organizations (just for the manager)

Organization name – display just this organization report

org

Optional

Report start date

start_date

Optional

Report end date

end_date

Optional

Get list of records by call type (landline, mobile, international etc)

call_type

 

 

Add numbers to Callback Queue

API URL:

https://panel.bluebe.net/api/PBXpostOut.php

This API allows you to perform the following operations:

  1. Set and update phone numbers record to automatic call back when agent login to the queue.
    This needs a valid license for this this operation.

 

Option to send request:

Available parameters

Demand

Description

Parameter

Mandatory

Paste your individual organization token

org_token

Mandatory

AddCB

action

Optional

Source number of the requested service

CBsource

Mandatory

Phone number to call

CBnum

Mandatory

Queue number to connect the CBnum when there are available agents in this queue

CBQdest

Optional

Maximum attempts to dial CBnum

maxCBdial