כל ה-API של המרכזיה במקום אחד. ההפעלה נעשית מול נציג, בהתאם לצורכי העסק; פרטי ההתחברות והפרמטרים הסופיים נמסרים בהפעלה. לפנייה לנציג.
התיעוד הטכני כתוב באנגלית, כמו שמפתחים עובדים איתו. רשימת כל שדות ה-Webhook, לפי סוג אירוע ועם חיפוש: Webhook API. התיעוד המלא והעדכני: webhook-docs.
Call event webhooks
The PBX sends a webhook when a call comes in, before it is answered, and again when a call ends, incoming or outgoing. A webhook can be sent as JSON or XML, by POST or GET. You choose which fields each request carries. Every field, by call event, is in the webhook field reference.
Incoming call
| Field | Description |
|---|---|
caller_number | Caller phone number |
did_number | Dialed number (DID) |
extension | Extension |
queueName | Queue name, when the call is in a queue |
call_id | Same ID on every leg of the call, to match ring, answer and end |
org_name | Organization |
https://your.server/incoming?caller={{caller_number}}&did={{did_number}}&ext={{extension}}&call={{call_id}}
End of call
Sent for every incoming and outgoing call when it ends.
| Field | Description |
|---|---|
caller_number | Caller phone number |
did_number | Dialed number (DID) |
direction | Call direction |
starttime | Call start time |
duration | Total call duration (seconds) |
talk_time | Billable seconds (after answer) |
disposition | Call result: ANSWERED, NO ANSWER, BUSY, FAIL |
answeringExtension | Extension that answered the call |
queueName | Queue name |
recording_play_url | Recording link for playback |
recording_download_url | Recording link for download |
call_id | Same ID on every leg of the call |
org_name | Organization |
Recording links
When a call is recorded, the end-of-call webhook carries ready-made links to the recording: recording_play_url to play it and recording_download_url to download it.
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. Activation is arranged with a representative, according to the business’s needs.
| 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 |