כל ה-API של המרכזיה במקום אחד. לכל שירות נדרש רישיון פעיל; פרטי ההתחברות והפרמטרים הסופיים נמסרים בעת הפעלת הרישיון. לבקשת רישיון.
התיעוד הטכני כתוב באנגלית, כמו שמפתחים עובדים איתו. רשימת כל שדות ה-Webhook, לפי סוג אירוע ועם חיפוש: Webhook API.
Call event webhooks
Incoming call alert
Fired on an incoming call to an inbound route, a ringing extension, an announcement, or an extension available on a queue or ring group. Sent as JSON (POST/GET) or XML.
| Parameter | Description |
|---|---|
caller | Caller number |
target | Dialed number |
ext | Ringing extension |
callid | Unique call ID |
https://webhook.url/incomingCall?callid={callid}&ext={extension_num}&caller={caller_num}&target={target}
End call event
Sent for every incoming and outgoing call when it ends.
https://webhook.url/end_call?caller=XXXX&target=XXXX&time=XXXX&duration=XX&ivruniqueid=XXXX&type=XXXX&status=XXXX&targetextension=XXXX&callerextension=XXXX&did=X&queueid=XXXX&queuename=XXX&record=XXXX&dialtime=XXXX&domain=XXXX&domain_name=XXXX
| Parameter | Description |
|---|---|
caller | Caller number |
target | Dialed number |
time | Time of the call |
duration | Overall call time |
ivruniqueid | IVR unique ID |
type | Incoming / Outgoing |
status | ANSWER, NO ANSWER, BUSY, CONGESTION |
targetextension | Answering extension |
callerextension | Caller extension |
did | Direct Inward Dialing number |
queueid | Queue or ring group unique ID |
queuename | Queue or ring group name |
record | Call recording file name |
dialtime | Billable call time |
domain | PBX server address |
domain_name | Organization name |
Recording link
The recording file name from the end call event must be encoded with your license code to produce a direct play/download link. Without it the recording cannot be played without manual verification against the PBX. The code is provided on license activation.
Click2Call
Dial at the push of a button by sending a GET/POST request. The system first dials the extension or internal service (dial1), and once it answers dials the destination (dial2), unless Reverse is set. To record a Click2Call call, SetCID must be set in the request.
https://voip.globalex.co.il/API/dialup.php?user=XXXX&pass=XXXX&org=XXXX&dial1=XXXX&dial2=XXXX&Response=yes&SetCID=XXXX
| Parameter | Required | Description |
|---|---|---|
user | Yes | Username |
pass | Yes | Password |
org | Yes | Organization |
dial1 | Yes | Extension / first number to dial |
dial2 | Yes | Destination, E.164 format |
Response | No | Request a response (yes) |
RFormat | No | Response format: text (default), html, xml, json |
SetCID | No | Caller ID to present, digits only. Required for recording. |
Reverse | No | Reverse the dial order (dial2 first) |
Timeout | No | Seconds to wait for an answer, 1–300. Default 20. |
Extension status and hangup
Returns the current extension status (free, busy, ringing, unavailable) and, during an active call, the channel, the bridged channel's unique ID, the call's unique ID and the recording file if available. With operation=hangup it hangs up the running call. The unique ID can be used to pull the recording or a call report.
https://voip.globalex.co.il/API/dialup.php?user=XXXX&pass=XXXX&org=XXXX&exten=XXXX
| Parameter | Required | Description |
|---|---|---|
user | Yes | Username |
pass | Yes | Password |
org | Yes | Organization |
exten | Yes | Internal extension number |
Response | No | Request a response (yes) |
RFormat | No | Response format: text (default), html, xml, json |
operation | No | hangup to end the running call |
CDR and billing reports
POST https://panel.bluebe.net/api/cdr.php · Response: JSON. Get CDR and billing reports for your organization (or all organizations, for an admin), or the calls of a specific number between two dates.
| Parameter | Required | Description |
|---|---|---|
org_token | Yes | Your organization token |
call_status | No | Filter by call status |
did_number | No | Incoming calls to this DID |
call_duration | No | Total duration, with > < = (e.g. >10) |
call_source | No | Source number (integers only) |
call_destination | No | Destination number (integers only) |
call_uniqueId | No | Return only this call |
call_price | No | Call price, with > < = |
call_country | No | Destination country |
call_type | No | Landline, mobile, international, etc. |
org | No | Organization name; empty returns all organizations (admin only) |
start_date / end_date | No | Report period |
Add numbers to the callback queue
https://panel.bluebe.net/api/PBXpostOut.php · Adds or updates numbers for automatic callback when an agent logs in to the queue. Requires a valid license.
| Parameter | Required | Description |
|---|---|---|
org_token | Yes | Your organization token |
action | Yes | AddCB |
CBsource | No | Source number of the requested service |
CBnum | Yes | Phone number to call |
CBQdest | Yes | Queue to connect CBnum to when agents are available |
maxCBdial | No | Maximum dial attempts to CBnum |