Legal name of the customer the numbers are ordered for. Required;\nforwarded to the carrier, which records and may validate it.
\n","value":"ACME GmbH"},{"key":"street","type":"text","value":"Adenauerallee"},{"key":"street_number","type":"text","value":"1"},{"key":"postal_code","type":"text","value":"53113"},{"key":"city","type":"text","value":"Bonn"},{"key":"area_code","type":"text","description":"Country-conditional. Required for some countries (e.g. Switzerland,\nCH, where it would be something like 43) and rejected (422) for\nothers - it is null for the DE example here. Use the same value\nyou sent to POST /numbers/orders/check.
Optional URL we POST to once the order is fulfilled. The order is\naccepted asynchronously (this endpoint returns 201 with status\nrequested), so the assigned numbers - or a rejection - are\ndelivered here later, not in this response. See \"Webhook payloads\"\nabove for the exact body. The same outcome can also be fetched from\nGET /numbers/orders/{id}.
Optional customer reference (any short string, max 64 chars).\nEchoed back in the response, in GET /numbers/orders/{id}, and\nat the top level of the asynchronous webhook payload as\norder_id (the webhook body is the same order object). If\nomitted, the upstream provider generates one and we backfill it\non your row.
KYC documents, one entry per documentType returned by\nPOST /numbers/orders/check for the country. Send file documents\nas a file part kyc[<documentType>] and identifier-only documents\nas a form field kyc[<documentType>]=<value>. Accepted file MIME\ntypes: application/pdf, image/jpeg, image/png. Example shape:
- \n
kyc[utility_bill]- file part carryingbill.pdf\nkyc[id_document]- file part carryingpassport.jpg\nkyc[business_registration_number]=BE-12345- form field \n
For an OR group returned by the check endpoint (an array of types),\nprovide any one of the listed documentTypes.
Submit a phone number order. Must be called as multipart/form-data because\nKYC document files are part of the request. Call POST /numbers/orders/check\nfirst to obtain the address-specific kycRequirements.
You may attach your own order_id (any short string, max 64 chars) - it\nwill be echoed back to you in the response, in GET /numbers/orders/{id},\nand in the asynchronous webhook payload below. If you omit it, the upstream\nprovider will generate one and we'll backfill it on your row.
Order fulfilment is asynchronous. This endpoint returns 201 as soon as the\norder is accepted upstream. The final outcome (success or rejection) will be\ndelivered to your webhook URL (if provided) and is queryable via\nGET /numbers/orders/{id}.
Webhook payload
\nWhen the order reaches its final state we POST to your webhook URL the\nexact same body as GET /numbers/orders/{id} (the schema below). Read\nthe status field to tell success from rejection:
- \n
status: \"success\"-numbersandphone_numbersare populated. \nstatus: \"error\"-error_messagecarries the rejection reason. \n
\n
Request
\nRequest body — multipart/form-data (required)
\n
Responses
\n201 — Order accepted upstream and persisted on our side.
\nBody — application/json
401 — Authorization Token Missing
This error is returned when the authorization token is missing.
\nHeaders
\nBody — application/json
422 — Validation failed. errors maps each rejected field to its messages.
\nValidation failed. errors maps each rejected field to its messages.
If the order reached the carrier and was rejected there, it is persisted\nas a retryable submission_failed order and returned in data (the full\norder, same shape as GET /numbers/orders/{id}); use data.id to edit +\nretry it via POST /numbers/orders/{id}. When data is absent, no order\nwas created.
Body — application/json
Retrieve the current state of a phone number order. The order outcome\n(assigned numbers on success, or the rejection reason) can be fetched here\nif you cannot accept the webhook callback, and it also lets you inspect a\npast order's audit trail.
\n\n
Request
\nPath parameters
\n\n
Responses
\n200 — OK
\nBody — application/json
401 — Authorization Token Missing
This error is returned when the authorization token is missing.
\nHeaders
\nBody — application/json
404 — Order not found in the caller's PBX.
\n","urlObject":{"path":["{{version}}","numbers","orders",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"eb16512e-ec6f-42fc-9c3c-cbcd03aafcf7","description":{"content":"Order UUID returned by POST /numbers/orders.
Legal name of the customer. Required and editable on retry;\nforwarded to the carrier, which may validate it.
\n","value":"ACME GmbH"},{"key":"street","type":"text","value":""},{"key":"street_number","type":"text","value":""},{"key":"postal_code","type":"text","value":""},{"key":"city","type":"text","value":""},{"key":"area_code","type":"text","description":"Country-conditional. Required when the order's (locked) country\nneeds it - e.g. Switzerland (CH), where it would be something like\n43 - and rejected (422) otherwise.
Optional customer reference (max 64 chars). Editable on retry -\nsend a new value to change it, or an empty string to clear it.\nEchoed back in the response, in GET /numbers/orders/{id}, and\nat the top level of the asynchronous webhook payload as order_id\n(the webhook body is the same order object).
KYC documents, one entry per documentType returned by\nPOST /numbers/orders/check for the country. Send file documents\nas a file part kyc[<documentType>] and identifier-only documents\nas a form field kyc[<documentType>]=<value>. Accepted file MIME\ntypes: application/pdf, image/jpeg, image/png. Example shape:
- \n
kyc[utility_bill]- file part carryingbill.pdf\nkyc[id_document]- file part carryingpassport.jpg\nkyc[business_registration_number]=BE-12345- form field \n
For an OR group returned by the check endpoint (an array of types),\nprovide any one of the listed documentTypes. Re-send the KYC\ndocuments you want on the retried order; on submission_failed\nretries the carrier re-validates them.
Edit selected fields of a submission_failed order and re-submit it\nupstream. Same multipart contract as POST /numbers/orders.
Uses POST (not PUT) on purpose: the body is multipart/form-data, and\nmany server runtimes only parse a multipart body when the method is POST -\non PUT the fields and files arrive empty. Send this edit as a plain POST.
Constraints:
\n- \n
- Only orders with status
submission_failedcan be edited. \n countryis frozen. You may re-send it with the same value (handy when\nyou echo back the whole order), but changing it returns422- order in\na different country by creating a new order. Omitting it is also fine. \n
customer_name and order_id are editable here: send new values to change\nthem, or send an empty order_id to clear your reference.
If the edited address yields different KYC requirements upstream, the\nresponse will be 422 carrying the new requirements; resubmit again with\nthe matching KYC fields.
\n
Request
\nPath parameters
\nRequest body — multipart/form-data (required)
\n
Responses
\n200 — Order re-submitted upstream successfully.
\nBody — application/json
401 — Authorization Token Missing
This error is returned when the authorization token is missing.
\nHeaders
\nBody — application/json
403 — The order was created from a different source (e.g. the Cockpit UI) and
\nThe order was created from a different source (e.g. the Cockpit UI) and\ncannot be retried via the API. Not field-specific, so the body is just a\nmessage.
Body — application/json
404 — Order not found in the caller's PBX.
\n409 — The order is not in submission_failed state, so it cannot be edited or
\nThe order is not in submission_failed state, so it cannot be edited or\nretried. Not field-specific, so the body is just a message (the current\nstatus is included in it).
Body — application/json
422 — Validation failed. errors maps each rejected field to its messages
\nValidation failed. errors maps each rejected field to its messages\n(including an attempt to change the locked country).
If the carrier rejected the retried order, it stays as a retryable\nsubmission_failed order and is returned in data (the full order, same\nshape as GET /numbers/orders/{id}); use data.id to edit + retry it via\nPOST /numbers/orders/{id}. When data is absent, the failure was local\nvalidation only.
Body — application/json
Customer-facing endpoints for the Nexus number-order proxy. Use these to\ncheck whether a phone number can be provisioned at a given address, place\nan order (with KYC documents attached), retrieve an order's status, edit\nand retry an order that failed submission, list the phone numbers already\nowned by the PBX, and attach a call flow to a specific number.
\nAuthentication is the PBX API key (one token per PBX); every response is\nscoped to that PBX.
\n","_postman_id":"229092f1-677c-41de-9841-50339a77d81a"},{"name":"Calls","item":[{"name":"Start new call","id":"e270171b-8a5a-4faa-b47b-88945179bad0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{cockpit_auth}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"targets\": { // One of the target needed to be passed\n \"sip_devices\": [],\n \"webrtc\": false, // default false if not passed\n \"twinning\": true, // default false if not passed\n \"teams\": false // default false if not passed\n },\n \"destination\": \"+352661579000\", // required\n \"caller_identity\": \"13e0ed05-c7aa-4ea3-ab41-c005fcbc822e\" // Required\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/{{version}}/calls/new","description":"Start a New Call
\nStart a new call to a destination from a User or Device.
\n- \n
DialBack mode:
\n
We first dial the targets (user devices, WebRTC, Teams, etc.). As soon as one of them answers, we dial the destination. This allows the user to choose which device will be used to start the call. \nWhen no targets are specified, we dial all linked devices for the user in DialBack mode.
\n \nWhen the source parameter is defined, we dial the source number in DialBack mode and ignore all other targets.
\n \nWhen only one
\ntargets.sip_devices(and no other targets) is specified, we try to start the call via the Phone API; if that fails, we fall back to dialing the device directly. \n
\n
HTTP Request
\nPOST {{baseUrl}}/{{version}}/calls/new\nContent-Type: application/json\nAuthorization: Bearer {{cockpit_auth}}\n\n\n\nNote: Even though this is currently configured as a GET request in Postman, this operation semantically behaves as a create/start action and is typically implemented as POST with a JSON body. Ensure your method matches the backend implementation.
\n
\n
Authentication
\nThis endpoint requires authentication.
\n- \n
Type: Bearer token
\n \nHeader:
\n
\nAuthorization: Bearer {{cockpit_auth}}\n\n\n
\n{{cockpit_auth}}should contain a valid access token (for the authenticated Cockpit user) in the active environment (for example:[PROD] cockpit.voxbi.com). \n
If the token is invalid or missing, the API will return an authorization error (e.g., 401/403).
\n\n
Request Body
\nContent-Type: application/json
Example (with inline comments)
\n{\n \"targets\": { // If no pass all will ring\n \"sip_devices\": [ // default null\n \"a469de67-b79a-4dea-87d2-9a15858f10cd\" // Your choosen sip device ID which you want to use to make call\n ],\n \"webrtc\": true, // default false if not passed\n \"twinning\": true, // default false if not passed\n \"teams\": true // default false if not passed\n },\n \"destination\": \"0035220333300\", // required\n \"caller_identity\": \"905a334f-5bf6-4ebc-85d3-2d5411187f68\" // Required\n}\n\nProperties
\n- \n
\ntargets(object, optional)
Which targets to start the call from.- \n
If multiple targets are specified, the PBX will call each target in DialBack mode.
\n \nIf no targets are specified, all devices linked to the user will be dialed in DialBack mode.
\n \n
\ntargets.sip_devices(array of strings, optional): List of SIP device IDs to be used as call sources. Default:null. \n
\ntargets.webrtc(boolean, optional): Whether to include the WebRTC client as a possible source. Default:false. \n
\ntargets.twinning(boolean, optional): Whether to include twinned devices. Default:false. \n
\ntargets.teams(boolean, optional): Whether to include Microsoft Teams as a possible source. Default:false. \n
\n
\ndestination(string, required)
The phone number (or extension) to call. Must be a valid, dialable number in E.164 or PBX-compatible format. \n
\ncaller_identity(string, required)
Identifier of the calling user or device (e.g., user UUID or device UUID) that will be used to determine available targets and call permissions. \n
\n
Query Parameters
\nThis endpoint does not define specific query parameters by default. Any additional query parameters should be considered advanced options and may not be supported across all deployments.
\n\n
Responses
\n200 OK — Call Started / DialBack Initiated
\n{\n \"success\": true,\n \"data\": {\n \"call_id\": \"f4e1b7f2-5b3e-4f9c-9a3d-2a1c0b9d1234\",\n \"destination\": \"0035220333300\",\n \"caller_identity\": \"905a334f-5bf6-4ebc-85d3-2d5411187f68\",\n \"mode\": \"dialback\",\n \"targets\": {\n \"sip_devices\": [\"a469de67-b79a-4dea-87d2-9a15858f10cd\"],\n \"webrtc\": true,\n \"twinning\": true,\n \"teams\": true\n },\n \"status\": \"initiated\",\n \"created_at\": \"2024-01-01T12:00:00Z\"\n }\n}\n\n400 Bad Request — Generic Validation / Payload Error
\nReturned when the request payload is syntactically correct JSON but fails basic validation (missing required fields, wrong types, invalid format, etc.). Uses a standard Laravel-style error structure.
\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"destination\": [\n \"The destination field is required.\",\n \"The destination must be a valid phone number.\"\n ],\n \"caller_identity\": [\n \"The caller identity field is required.\"\n ]\n }\n}\n\n422 Unprocessable Entity — Business Rule / Domain Validation Error
\nReturned when the payload is structurally valid but violates domain/business rules (for example, user not allowed to call this destination, no active devices found, or features not enabled for the account). Also uses a standard Laravel-style error response.
\n{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"destination\": [\n \"Calls to this destination are not allowed for the current user.\"\n ],\n \"targets.sip_devices\": [\n \"At least one active SIP device is required to start a call.\"\n ],\n \"targets.webrtc\": [\n \"WebRTC is not enabled for this account.\"\n ]\n }\n}\n\nDescription
\nThis API endpoint retrieves the call history of the user based on the provided filters.
\nRequest
\nQuery Parameters
\nResponse
\nResponse Fields
\nResponse Example
\n{\n \"data\": [\n {\n \"cdr_id\": 24904193,\n \"pbx_user_id\": \"eb2109dd-adc7-455b-bc33-e92fcac4bf38\",\n \"pbx_profile_id\": null,\n \"customer_pid\": null,\n \"type\": \"INCOMING\",\n \"is_missed_call\": true,\n \"is_answered\": false,\n \"remote_person_id\": \"83ea7fdc-8942-49e4-9a87-1bb7bf73f77b\",\n \"remote_person_name\": \"MATHIEU DEROUCK\",\n \"remote_person_number\": \"2041\",\n \"via_id\": \"83ea7fdc-8942-49e4-9a87-1bb7bf73f77b\",\n \"via_name\": \"MATHIEU DEROUCK\",\n \"via_number\": \"2041\",\n \"date\": \"2026-01-12\",\n \"start_time\": \"2026-01-12 15:50:19\",\n \"answer_time\": null,\n \"end_time\": \"2026-01-12 15:50:25\",\n \"duration\": 6,\n \"billsec\": 0,\n \"is_transfer_call\": false,\n \"is_conference_call\": false,\n \"is_recorded\": false,\n \"notes_count\": 0,\n \"transcriptions_available\": false,\n \"extras\": []\n }\n // ... more CDRs\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 5,\n \"total\": 515\n // ... other pagination fields\n },\n \"cache_hit\": false,\n \"status\": true,\n \"message\": \"CDRs retrieved successfully.\"\n}\ntrue will send detailed response containing AI transcription and call timelines
\n","type":"text/plain"},"key":"extras","value":"true"},{"disabled":true,"description":{"content":"answered, missed, all, incoming, outgoing
\n","type":"text/plain"},"key":"call_type[]","value":"incoming"},{"disabled":true,"key":"call_type[]","value":"all"},{"description":{"content":"start date from where u want calls
\n","type":"text/plain"},"key":"start_time","value":"2026-06-01 00:00:00"},{"description":{"content":"end date until how long u want calls
\n","type":"text/plain"},"key":"end_time","value":"2026-06-12 23:50:59"},{"disabled":true,"description":{"content":"you can search anything and we get martched records (full text search)
\n","type":"text/plain"},"key":"search","value":"umair"},{"disabled":true,"description":{"content":"if ID passed we will return calls > that ID (we use this id to get calls only newer to that id for less load and fast response)
\n","type":"text/plain"},"key":"id","value":"18457973"},{"description":{"content":"page number
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"page size
\n","type":"text/plain"},"key":"page_size","value":"5"},{"disabled":true,"description":{"content":"// remote person numbver or extensioon can be passed for filter
\n","type":"text/plain"},"key":"remote_extension_number","value":"2041"}],"variable":[]}},"response":[{"id":"3ac12f48-49e7-44b2-9dc4-1f4e0258b3f6","name":"Calls History 200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/{{version}}/cdrs-utility/cdrs?extras=false&start_time=2025-01-01 00:00:00&end_time=2026-01-12 23:50:59&page=1&page_size=5","host":["{{baseUrl}}"],"path":["{{version}}","cdrs-utility","cdrs"],"query":[{"key":"extras","value":"false","description":"true will send detailed response containing AI transcription and call timelines"},{"key":"call_type[]","value":"incoming","description":"answered, missed, all, incoming, outgoing","disabled":true},{"key":"call_type[]","value":"all","type":"text","disabled":true},{"key":"start_time","value":"2025-01-01 00:00:00","description":"start date from where u want calls"},{"key":"end_time","value":"2026-01-12 23:50:59","description":"end date until how long u want calls"},{"key":"search","value":"umair","description":"you can search anything and we get martched records (full text search)","type":"text","disabled":true},{"key":"id","value":"18457973","description":"if ID passed we will return calls > that ID (we use this id to get calls only newer to that id for less load and fast response)","disabled":true},{"key":"page","value":"1","description":"page number"},{"key":"page_size","value":"5","description":"page size"},{"key":"remote_extension_number","value":"2041","description":"// remote person numbver or extensioon can be passed for filter","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8083"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.24"},{"key":"Content-Type","value":"application/json"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 19 Jan 2026 10:53:07 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Last-Modified","value":"Mon, 19 Jan 2026 10:53:07 GMT"},{"key":"ETag","value":"bb295e4c3746aa9c290aaa5481da8378"},{"key":"phpdebugbar-id","value":"01KFAY65GTGXW46Z5HBRQQ7BQ6"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"cdr_id\": \"***\",\n \"pbx_user_id\": \"***\",\n \"pbx_profile_id\": null,\n \"customer_pid\": null,\n \"type\": \"INCOMING\",\n \"is_missed_call\": true,\n \"is_answered\": false,\n \"remote_person_id\": \"***\",\n \"remote_person_name\": \"***\",\n \"remote_person_number\": \"***\",\n \"via_id\": \"***\",\n \"via_name\": \"***\",\n \"via_number\": \"***\",\n \"date\": \"2026-01-12\",\n \"start_time\": \"2026-01-12 15:50:19\",\n \"answer_time\": null,\n \"end_time\": \"2026-01-12 15:50:25\",\n \"duration\": 6,\n \"billsec\": 0,\n \"is_transfer_call\": false,\n \"is_conference_call\": false,\n \"is_recorded\": false,\n \"notes_count\": 0,\n \"transcriptions_available\": false,\n \"extras\": []\n },\n {\n \"cdr_id\": \"***\",\n \"pbx_user_id\": \"***\",\n \"pbx_profile_id\": null,\n \"customer_pid\": null,\n \"type\": \"INCOMING\",\n \"is_missed_call\": true,\n \"is_answered\": false,\n \"remote_person_id\": \"***\",\n \"remote_person_name\": \"***\",\n \"remote_person_number\": \"***\",\n \"via_id\": \"***\",\n \"via_name\": \"***\",\n \"via_number\": \"***\",\n \"date\": \"2026-01-08\",\n \"start_time\": \"2026-01-08 10:33:03\",\n \"answer_time\": \"***\",\n \"end_time\": \"2026-01-08 10:38:40\",\n \"duration\": 337,\n \"billsec\": 0,\n \"is_transfer_call\": false,\n \"is_conference_call\": false,\n \"is_recorded\": false,\n \"notes_count\": 0,\n \"transcriptions_available\": false,\n \"extras\": []\n },\n {\n \"cdr_id\": \"***\",\n \"pbx_user_id\": \"***\",\n \"pbx_profile_id\": null,\n \"customer_pid\": null,\n \"type\": \"INCOMING\",\n \"is_missed_call\": true,\n \"is_answered\": false,\n \"remote_person_id\": \"***\",\n \"remote_person_name\": \"***\",\n \"remote_person_number\": \"***\",\n \"via_id\": \"***\",\n \"via_name\": \"***\",\n \"via_number\": \"***\",\n \"date\": \"2026-01-08\",\n \"start_time\": \"2026-01-08 10:21:29\",\n \"answer_time\": \"***\",\n \"end_time\": \"2026-01-08 10:32:40\",\n \"duration\": 671,\n \"billsec\": 0,\n \"is_transfer_call\": false,\n \"is_conference_call\": false,\n \"is_recorded\": false,\n \"notes_count\": 0,\n \"transcriptions_available\": false,\n \"extras\": []\n },\n {\n \"cdr_id\": \"***\",\n \"pbx_user_id\": \"***\",\n \"pbx_profile_id\": null,\n \"customer_pid\": null,\n \"type\": \"INCOMING\",\n \"is_missed_call\": false,\n \"is_answered\": true,\n \"remote_person_id\": \"***\",\n \"remote_person_name\": \"***\",\n \"remote_person_number\": \"***\",\n \"via_id\": \"***\",\n \"via_name\": \"***\",\n \"via_number\": \"***\",\n \"date\": \"2026-01-08\",\n \"start_time\": \"2026-01-08 09:36:45\",\n \"answer_time\": \"***\",\n \"end_time\": \"2026-01-08 09:37:36\",\n \"duration\": 51,\n \"billsec\": 30,\n \"is_transfer_call\": false,\n \"is_conference_call\": false,\n \"is_recorded\": false,\n \"notes_count\": 0,\n \"transcriptions_available\": false,\n \"extras\": []\n },\n {\n \"cdr_id\": \"***\",\n \"pbx_user_id\": \"***\",\n \"pbx_profile_id\": null,\n \"customer_pid\": null,\n \"type\": \"OUTGOING\",\n \"is_missed_call\": false,\n \"is_answered\": true,\n \"remote_person_id\": \"***\",\n \"remote_person_name\": \"***\",\n \"remote_person_number\": \"***\",\n \"via_id\": \"***\",\n \"via_name\": \"***\",\n \"via_number\": \"***\",\n \"date\": \"2026-01-05\",\n \"start_time\": \"2026-01-05 15:33:09\",\n \"answer_time\": \"***\",\n \"end_time\": \"2026-01-05 15:38:02\",\n \"duration\": 293,\n \"billsec\": 293,\n \"is_transfer_call\": false,\n \"is_conference_call\": false,\n \"is_recorded\": true,\n \"notes_count\": 0,\n \"transcriptions_available\": true,\n \"extras\": []\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"first_page_url\": \"***\",\n \"prev_page_url\": null,\n \"next_page_url\": \"***\",\n \"last_page_url\": \"***\",\n \"last_page\": 103,\n \"per_page\": 5,\n \"total\": 515,\n \"path\": \"***\"\n },\n \"cache_hit\": false,\n \"status\": true,\n \"message\": \"CDRs retrieved successfully.\"\n}\n"}],"_postman_id":"0ff79e47-8f70-4b59-bafd-169f69fb0a2a"},{"name":"Call History Detail","id":"e912ddb4-9d32-44aa-bad3-0cca6ea48f2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{cockpit_auth}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/{{version}}/cdrs-utility/cdrs/detail/37419234","description":"Get call details by passing call ID.
\nResponse
\nReturns detailed information for a single call, including caller, receivers, call flow events, recording metadata, and AI processing fields.
\nField behavior
\n- \n
\nis_missed_call- \n
truewhen the call was never answered by any party (no receiver leg has a non-nullanswer_timewithbillsec > 0). \n
\n
\nis_answered- \n
truewhen at least one leg of the call is answered (at least one receiver has a non-nullanswer_timeandbillsec > 0). \n
\n
\ndurationvsbillsec- \n
\ndurationrepresents the overall call length in seconds (from call start to call end) and can be greater than 0 even if the call was never billed. \n
\nbillsecrepresents the billed seconds and may be0even whenduration > 0(for missed calls or calls that are not billed). \n
\nRecording flags
\n- \n
\nis_recording_file_existsindicates whether a full-call recording is available for this call. \n
\nrecording_file_path_callerandrecording_file_path_calleeindicate whether separate caller/callee leg recordings exist; theirpath/download_urlwill benullor empty when the respective leg was not recorded. \n
\nAI processing fields
\n- \n
transcriptionsandai_processing_errorsare populated only when AI processing has been attempted for this call; they will typically benullor empty for calls that have not undergone AI processing. \n
\n
answered, missed, all, incoming, outgoing
\n","type":"text/plain"},"key":"call_type[]","value":"incoming"},{"disabled":true,"key":"call_type[]","value":"all"},{"disabled":true,"key":"search","value":"umair"},{"disabled":true,"key":"id","value":"18457973"},{"disabled":true,"key":"page","value":"100"},{"disabled":true,"key":"remote_extension_number","value":"2041"}],"variable":[]}},"response":[{"id":"f9b1acc5-3ed3-421f-b9ce-1783b6177475","name":"Call History Detail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/{{version}}/cdrs-utility/cdrs/detail/24904193","host":["{{baseUrl}}"],"path":["{{version}}","cdrs-utility","cdrs","detail","24904193"],"query":[{"key":"call_type[]","value":"incoming","description":"answered, missed, all, incoming, outgoing","disabled":true},{"key":"call_type[]","value":"all","type":"text","disabled":true},{"key":"search","value":"umair","type":"text","disabled":true},{"key":"id","value":"18457973","disabled":true},{"key":"page","value":"100","disabled":true},{"key":"remote_extension_number","value":"2041","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8083"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.24"},{"key":"Content-Type","value":"application/json"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 19 Jan 2026 10:53:32 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"60"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Last-Modified","value":"Mon, 19 Jan 2026 10:53:32 GMT"},{"key":"ETag","value":"54878b360d5769f656c287d2377990c7"},{"key":"phpdebugbar-id","value":"01KFAY6WZZJKAYJGJGCTSEWYDR"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 24904193,\n \"company_id\": \"eb2109dd-adc7-455b-bc33-e92fcac4bf38\",\n \"type\": \"OUTGOING\",\n \"date\": \"2026-01-12\",\n \"start_time\": \"2026-01-12 15:50:19\",\n \"answer_time\": null,\n \"end_time\": \"2026-01-12 15:50:25\",\n \"duration\": 6,\n \"billsec\": 0,\n \"is_transfer_call\": false,\n \"is_internal\": true,\n \"is_conference_call\": false,\n \"conference\": [],\n \"is_recording_file_exists\": false,\n \"recording_file\": {\n \"name\": \"\",\n \"path\": null,\n \"download_url\": null,\n \"hint\": \"This recording file is for the entire call, including both caller and callee recordings. You can only download using your Brear token\"\n },\n \"recording_file_path_caller\": {\n \"name\": \"\",\n \"path\": null,\n \"download_url\": null,\n \"hint\": \"This recording file is for the caller part of the call. You can only download using your Brear token\"\n },\n \"recording_file_path_callee\": {\n \"name\": \"\",\n \"path\": null,\n \"download_url\": null,\n \"hint\": \"This recording file is for the callee (receivers who received the call) part of the call. You can only download using your Brear token\"\n },\n \"caller\": {\n \"id\": \"83ea7fdc-8942-49e4-9a87-1bb7bf73f77b\",\n \"name\": \"MATHIEU DEROUCK\",\n \"number\": \"2041\"\n },\n \"receivers\": [\n {\n \"id\": \"6aa692be-d4d3-4689-af39-98197e0a2ea9\",\n \"status\": \"TRIGGERED\",\n \"name\": \"UMAIR ALI\",\n \"number\": \"2039\",\n \"start_time\": \"2026-01-12 15:50:19\",\n \"answer_time\": \"2026-01-12 15:50:19\",\n \"end_time\": \"2026-01-12 15:50:25\",\n \"duration\": 6,\n \"billsec\": 6,\n \"via_id\": \"83ea7fdc-8942-49e4-9a87-1bb7bf73f77b\",\n \"via_name\": \"MATHIEU DEROUCK\",\n \"via_number\": \"2041\",\n \"via_type\": \"CALL_FLOW\"\n },\n {\n \"id\": \"6aa692be-d4d3-4689-af39-98197e0a2ea9\",\n \"status\": \"MISSED\",\n \"name\": \"UMAIR ALI\",\n \"number\": \"2039\",\n \"start_time\": \"2026-01-12 15:50:20\",\n \"answer_time\": null,\n \"end_time\": \"2026-01-12 15:50:25\",\n \"duration\": 6,\n \"billsec\": 0,\n \"via_id\": \"83ea7fdc-8942-49e4-9a87-1bb7bf73f77b\",\n \"via_name\": \"MATHIEU DEROUCK\",\n \"via_number\": \"2041\",\n \"via_type\": null\n },\n {\n \"id\": \"a091ab6b-4ce0-4039-9278-9b0854617f6f\",\n \"status\": \"MISSED\",\n \"name\": \"\",\n \"number\": \"+352661579000\",\n \"start_time\": \"2026-01-12 15:50:21\",\n \"answer_time\": null,\n \"end_time\": \"2026-01-12 15:50:25\",\n \"duration\": 6,\n \"billsec\": 0,\n \"via_id\": \"83ea7fdc-8942-49e4-9a87-1bb7bf73f77b\",\n \"via_name\": \"MATHIEU DEROUCK\",\n \"via_number\": \"2041\",\n \"via_type\": \"TWINNING\"\n }\n ],\n \"call_flow\": [\n {\n \"color\": \"info\",\n \"text\": \"OUTGOING - Call started by MATHIEU DEROUCK (2041)\",\n \"sub_text\": null,\n \"time\": \"2026-01-12 15:50:19\"\n },\n {\n \"color\": \"secondary\",\n \"text\": \"Triggered UMAIR ALI (2039)\",\n \"sub_text\": \"Via [CALL_FLOW] - MATHIEU DEROUCK (2041)\",\n \"time\": \"2026-01-12 15:50:19\"\n },\n {\n \"color\": \"danger\",\n \"text\": \"Missed by UMAIR ALI (2039)\",\n \"sub_text\": \"Via MATHIEU DEROUCK (2041)\",\n \"time\": \"2026-01-12 15:50:20\"\n },\n {\n \"color\": \"info\",\n \"text\": \"Call Finished\",\n \"sub_text\": null,\n \"time\": \"2026-01-12 15:50:25\"\n }\n ],\n \"notes\": [],\n \"transcriptions\": null,\n \"ai_processing_errors\": []\n },\n \"status\": true,\n \"message\": \"CDRs #24904193 detail retrieved successfully.\"\n}"}],"_postman_id":"e912ddb4-9d32-44aa-bad3-0cca6ea48f2b"},{"name":"Get Call Recording","id":"71f41eb0-b650-4248-a3a0-1259710b6eb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{cockpit_auth}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{baseUrl}}/{{version}}/cdrs-utility/call-recording?id=37048552","description":"Description
\nThis API endpoint retrieves the recording file of a call based on the provided CDR ID.
\nRequest
\nPath Parameters
\nResponse
\nSuccess Response (200 OK)
\nThe response will be the audio file in WAV format.
\nError Responses
\nValidation Error (422 Unprocessable Entity)
\n{\n \"errors\": {\n \"id\": [\"The id field is required.\"]\n }\n}\n\nRecording Not Found (404 Not Found)
\n{\n \"message\": \"Recording file not found.\"\n}\n\nVoIP User Not Found (404 Not Found)
\n{\n \"message\": \"Voip user not found.\"\n}\n\nDescription
\nThis API endpoint retrieves the recording file of a call based on the provided CDR ID. We have 3 recordings per call (combined, caller, callee) by passing call id and path of file you can get specific file.
\nRequest
\nPath Parameters
\nResponse
\nSuccess Response (200 OK)
\nThe response will be the audio file in WAV format.
\nError Responses
\nValidation Error (422 Unprocessable Entity)
\n{\n \"errors\": {\n \"id\": [\"The id field is required.\"]\n }\n}\n\nRecording Not Found (404 Not Found)
\n{\n \"message\": \"Recording file not found.\"\n}\n\nVoIP User Not Found (404 Not Found)
\n{\n \"message\": \"Voip user not found.\"\n}\n\nget path from details api or list api when u pass extras: true
\n","type":"text/plain"},"key":"path","value":"/mnt/hdd/recordings/spool/gdelagardelle_USR_9f8f5d47-1ed7-40b5-8037-7b634a2868ad_1782811837.48389.TX.wav"}],"variable":[]}},"response":[],"_postman_id":"538da82e-2342-4e14-8c1b-f61dbaaeab32"}],"id":"ce92af22-86fd-4591-aa7f-9f7052236518","_postman_id":"ce92af22-86fd-4591-aa7f-9f7052236518","description":""}],"id":"7b60e856-1093-4aae-a376-288e7a9d984c","description":"Base URL
All endpoints in this collection are relative to:
https://cockpit.voxbi.com/
Version: v1
API Prefix : api
Complete URL: https://cockpit.voxbi.com/v1/api
\n\n
This collection exposes the public Cockpit APIs used to authenticate a user, fetch their PBX context, discover their devices, and control calls.
\nAt a high level, you will find:
\n- \n
Authentication flows
\n
Support for both classic email + password login and passwordless email/code flows. Use these endpoints to obtain acockpit_authaccess token, which must be sent as aBearertoken in theAuthorizationheader for protected routes. \nUser + PBX context (
\n/me)
The/meendpoint returns the authenticated user’s profile together with their PBX context: extensions, groups, WebRTC configuration, available caller identities, and more. Call this right after login to bootstrap your client with everything it needs for that user. \nTwinnings and SIP Devices
\n
Endpoints to list and inspect a user’s twinnings (logical devices/routes) and SIP devices. These describe where and how calls can be made or received (for example, specific SIP phones, WebRTC clients, or forwarding rules) and provide the identifiers you will reference when placing calls. \nCall control
\n
Endpoints such as Start New Call let you initiate outbound calls using the user’s configured devices and dial strategies. \n
All paths documented here should be understood as relative to https://cockpit.voxbi.com/v1/api (for example, GET /me, GET /twinnings, POST /passwordless/login, GET /calls/new).
Start a new call to a destination from a User using the xtelsio Tapi
\nDialBack mode: we dial first the targets and once one of those has answered we dial the destination. This allows the user to select which device will be used to start a new call
When no targets are specified we dial all linked device for the user in DialBack mode.
When only one target.sip_devices (and no other targets) is specified we try to start the call via the Phone api if this fails we dial the device\nWhen the target is webrtc and we only have one instance of voxbi open we don't use DialBack mode
Display the debug trace from asterisk manager
\n","type":"text/plain"},"key":"debugAmiTrace","value":"true"},{"description":{"content":"Destination number to dial
\n","type":"text/plain"},"key":"destination","value":"20333300"},{"description":{"content":"Target device used to start the call
\n","type":"text/plain"},"key":"targets","value":"a469de67-b79a-4dea-87d2-9a15858f10cd,webrtc,twinning,teams"},{"description":{"content":"Specify the caller identity of the call
\n","type":"text/plain"},"key":"caller_identity","value":"905a334f-5bf6-4ebc-85d3-2d5411187f68"},{"description":{"content":"Auto Answer the call on the src device (default: false) (overrides default behaviors)
\n","type":"text/plain"},"key":"autoAnswer","value":"false"},{"description":{"content":"Forces the pbx to start a call in DialBack mode (default: false) (overrides default behaviors)
\n","type":"text/plain"},"key":"forceDialBack","value":"false"},{"description":{"content":"Should the call be anonymous (default: false)
\n","type":"text/plain"},"key":"anonymous","value":"false"}],"variable":[]}},"response":[{"id":"8133b744-ab80-424c-b93d-563346e3396a","name":"Call Started","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicStart a new multicast announcement
\n","urlObject":{"path":["calls","placemulticast"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Display the debug trace from asterisk manager
\n","type":"text/plain"},"key":"debugAmiTrace","value":"true"},{"description":{"content":"IP to send the call to
\n","type":"text/plain"},"key":"ip","value":"false"},{"description":{"content":"Should the multicast overwrite a call 0 or 1
\n","type":"text/plain"},"key":"emergency","value":"0"},{"description":{"content":"Sound file to play
\n","type":"text/plain"},"key":"soundFile","value":"all-your-base"}],"variable":[]}},"response":[{"id":"72b1cf80-26c5-4b3d-9c78-e93d5deb129d","name":"Call Started","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerHangup calls for a user
\n","urlObject":{"path":["calls","hangup"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Display the debug trace from asterisk manager
\n","type":"text/plain"},"key":"debugAmiTrace","value":"true"}],"variable":[]}},"response":[{"id":"18c1c772-935f-4f92-b27c-204e3d51e6f8","name":"Call has been hangup","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicStart a new call to a destination from a User or Device
\nDialBack mode: we dial first the targets and once one of those has answered we dial the destination. This allows the user to select which device will be used to start a new call
When no targets are specified we dial all linked device for the user in DialBack mode.
When the source parameter is defined we dial the source number in dial back mode and ignore all the other targets.
When only one target.sip_devices (and no other targets) is specified we try to start the call via the Phone api if this fails we dial the device
Display the debug trace from asterisk manager
\n","type":"text/plain"},"key":"debugAmiTrace","value":"true"},{"description":{"content":"Auto Answer the call on the src device (default: false) (overrides default behaviors)
\n","type":"text/plain"},"key":"autoAnswer","value":"false"},{"description":{"content":"Forces the pbx to start a call in DialBack mode (default: false) (overrides default behaviors)
\n","type":"text/plain"},"key":"forceDialBack","value":"false"},{"description":{"content":"Should the call be anonymous (default: false)
\n","type":"text/plain"},"key":"anonymous","value":"false"}],"variable":[]}},"response":[{"id":"0de9ad7c-8983-41c0-ac78-f47a438a0de7","name":"Call Started","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicUser agent used to determine the vendor and model of the phone
\n"}],"url":"{{baseUrl}}/phone/deployment?mac=AABBCCDDEEFF","description":"Main Provisioning for the phones
\n","urlObject":{"path":["phone","deployment"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"MAC of the phone to deploy
\n","type":"text/plain"},"key":"mac","value":"AABBCCDDEEFF"}],"variable":[]}},"response":[{"id":"c74bcbd8-72d5-4577-ae4a-4e11f179bd13","name":"Phone configuration","originalRequest":{"method":"GET","header":[{"description":"User agent used to determine the vendor and model of the phone","key":"User-Agent","value":"Yealink SIP-T53 XX.XX.YY.ZZ AA:BB:CC:DD:EE:FF"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerUser agent used to determine the vendor and model of the phone
\n"}],"url":"{{baseUrl}}/phone/directory?user_id=abcd1234&setting=directory","description":"Get the phone directory
\n","urlObject":{"path":["phone","directory"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"The user ID
\n","type":"text/plain"},"key":"user_id","value":"abcd1234"},{"description":{"content":"Setting to determine directory or super-search
\n","type":"text/plain"},"key":"setting","value":"directory"}],"variable":[]}},"response":[{"id":"a2a72845-84c0-4972-b54e-8b8bf4ef90d3","name":"Phone directory","originalRequest":{"method":"GET","header":[{"description":"User agent used to determine the vendor and model of the phone","key":"User-Agent","value":""}],"url":{"raw":"{{baseUrl}}/phone/directory?user_id=abcd1234&setting=directory&username=User agent used to determine the vendor and model of the phone
\n"}],"url":"{{baseUrl}}/phone/dnd[/{{status}}]?mac=AABBCCDDEEFF&user_id=123&activeUser=Enable / Disable DND
\n","urlObject":{"path":["phone","dnd[","{{status}}]"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"MAC of the phone to deploy
\n","type":"text/plain"},"key":"mac","value":"AABBCCDDEEFF"},{"description":{"content":"Id of the user
\n","type":"text/plain"},"key":"user_id","value":"123"},{"description":{"content":"Username of the line to activate or deactivate
\n","type":"text/plain"},"key":"activeUser","value":"User-Agent used to determine the vendor and the model of the phone
\n"}],"url":"{{baseUrl}}/phone/forwards?action=on&event=always&target=20333000&mac=AABBCCDDEEFF&user_id=123&activeUser=Enable / Disable forwards via a phone or button on a phone linked to the user
\n","urlObject":{"path":["phone","forwards"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Set the status of the forwards
\n","type":"text/plain"},"key":"action","value":"on"},{"description":{"content":"For what event we want to check
\n","type":"text/plain"},"key":"event","value":"always"},{"description":{"content":"Forward Target
\n","type":"text/plain"},"key":"target","value":"20333000"},{"description":{"content":"MAC of the phone to deploy
\n","type":"text/plain"},"key":"mac","value":"AABBCCDDEEFF"},{"description":{"content":"Id of the user
\n","type":"text/plain"},"key":"user_id","value":"123"},{"description":{"content":"Username of the line to activate or deactivate
\n","type":"text/plain"},"key":"activeUser","value":"User-Agent used to determine the vendor and the model of the phone
\n"}],"url":"{{baseUrl}}/user/forwards?action=on&event=always&target=20333000","description":"Enable / Disable forwards for a user via a button on a phone not linked to the user
\n","urlObject":{"path":["user","forwards"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Set the status of the forwards
\n","type":"text/plain"},"key":"action","value":"on"},{"description":{"content":"For what event we want to check
\n","type":"text/plain"},"key":"event","value":"always"},{"description":{"content":"Forward Target
\n","type":"text/plain"},"key":"target","value":"20333000"}],"variable":[]}},"response":[{"id":"a8711de2-7809-42c7-b3e9-ca34379be6ae","name":"Phone reply","originalRequest":{"method":"GET","header":[{"description":"User-Agent used to determine the vendor and the model of the phone","key":"User-Agent","value":"Yealink SIP-T53 XX.XX.YY.ZZ AA:BB:CC:DD:EE:FF"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicUser agent sent by the device
\n"}],"url":"{{baseUrl}}/phone/deployment/gigaset/:key/:filename","description":"Provisioning endpoint for Gigaset devices
\n","urlObject":{"path":["phone","deployment","gigaset",":key",":filename"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"d91dcf40-646f-45f0-8974-7c5bbe0f6891","description":{"content":"Instance API key (path param)
\n","type":"text/plain"},"type":"any","value":"pbx16dev-...","key":"key"},{"id":"ee05c96e-1b94-4db6-9b94-25ee6c36bc7c","description":{"content":"gigaset addition for autoprov
\n","type":"text/plain"},"type":"any","value":"provisioning.xml","key":"filename"}]}},"response":[{"id":"0fca4da5-afeb-41fb-b762-87f0dd4002f2","name":"Gigaset configuration","originalRequest":{"method":"GET","header":[{"description":"User agent sent by the device","key":"User-Agent","value":"Gigaset N870 IP PRO/83.V2.57.0...;589EC65D1E59;Handset=50"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerUser agent used to determine vendor/model (if needed)
\n"}],"url":"{{baseUrl}}/phone/directory/gigaset/:key","description":"Get the shared Gigaset directory (one directory per DECT manager)
\n","urlObject":{"path":["phone","directory","gigaset",":key"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"fc7a4a04-0e9b-403f-bbfa-005366597381","type":"any","key":"key"}]}},"response":[{"id":"555d13a5-6f93-4687-a701-47588b04b3d7","name":"Gigaset directory","originalRequest":{"method":"GET","header":[{"description":"User agent used to determine vendor/model (if needed)","key":"User-Agent","value":"Gigaset N870 IP PRO ..."}],"url":{"raw":"{{baseUrl}}/phone/directory/gigaset/:key?username=User agent used to determine the vendor and model of the phone
\n"}],"url":"{{baseUrl}}/phone/options/info?user_id=123","description":"Get debug infos
\n","urlObject":{"path":["phone","options","info"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Id of the user
\n","type":"text/plain"},"key":"user_id","value":"123"}],"variable":[]}},"response":[{"id":"69fbeb32-fb78-4c95-8666-7acac061a924","name":"Phone debug info","originalRequest":{"method":"GET","header":[{"description":"User agent used to determine the vendor and model of the phone","key":"User-Agent","value":"Yealink SIP-T53 XX.XX.YY.ZZ AA:BB:CC:DD:EE:FF"}],"url":{"raw":"{{baseUrl}}/phone/options/info?user_id=123&username=User agent used to determine the vendor and model of the phone
\n"}],"url":"{{baseUrl}}/phone/options/sync?user_id=123","description":"Init config sync
\n","urlObject":{"path":["phone","options","sync"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Id of the user
\n","type":"text/plain"},"key":"user_id","value":"123"}],"variable":[]}},"response":[{"id":"0ccba2a8-a6fe-4322-b372-55870d4d5d15","name":"Phone config sync reply","originalRequest":{"method":"GET","header":[{"description":"User agent used to determine the vendor and model of the phone","key":"User-Agent","value":"Yealink SIP-T53 XX.XX.YY.ZZ AA:BB:CC:DD:EE:FF"}],"url":{"raw":"{{baseUrl}}/phone/options/sync?user_id=123&username=User agent used to determine the vendor and model of the phone
\n"}],"url":"{{baseUrl}}/phone/options?user_id=123","description":"Get options menu
\n","urlObject":{"path":["phone","options"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Id of the user
\n","type":"text/plain"},"key":"user_id","value":"123"}],"variable":[]}},"response":[{"id":"44efde3b-de2f-4d4a-b51c-b7e014aaf4b2","name":"Phone options menu","originalRequest":{"method":"GET","header":[{"description":"User agent used to determine the vendor and model of the phone","key":"User-Agent","value":"Yealink SIP-T53 XX.XX.YY.ZZ AA:BB:CC:DD:EE:FF"}],"url":{"raw":"{{baseUrl}}/phone/options?user_id=123&username=Remotely control your phone
\n","urlObject":{"path":["phoneControl","action"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Display the debug trace from asterisk manager
\n","type":"text/plain"},"key":"debugAmiTrace","value":"true"},{"description":{"content":"Action to be performed
\n","type":"text/plain"},"key":"action","value":"false"},{"description":{"content":"Id of the sip device you want to perform the action from
\n","type":"text/plain"},"key":"sip_device_id","value":"a469de67-b79a-4dea-87d2-9a15858f10cd"}],"variable":[]}},"response":[{"id":"e3a91a62-d76b-4a99-9f8e-977357012f69","name":"Action Performed","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicGet the all the Phone infos of the currently Authenticated user
\n","urlObject":{"path":["user"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"0d7ca011-fa92-4e02-a7ce-4741592a5325","name":"Current user information","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicVersion 1 of the api
\n","_postman_id":"f9abf2f0-935a-4ae9-ac54-d2fac31fcb47"},{"name":"Phone","item":[{"name":"Deployment for phone","id":"0b0dac34-c957-4daa-ae58-24e035ff0f52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"User-Agent","value":"Yealink SIP-T53 XX.XX.YY.ZZ AA:BB:CC:DD:EE:FF","description":"User agent used to determine the vendor and model of the phone
\n"}],"url":"{{baseUrl}}/phone/deployment?mac=AABBCCDDEEFF","description":"Main Provisioning for the phones
\n","urlObject":{"path":["phone","deployment"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"MAC of the phone to deploy
\n","type":"text/plain"},"key":"mac","value":"AABBCCDDEEFF"}],"variable":[]}},"response":[{"id":"8408a1c3-7c31-4c18-b9ec-761661333200","name":"Phone configuration","originalRequest":{"method":"GET","header":[{"description":"User agent used to determine the vendor and model of the phone","key":"User-Agent","value":"Yealink SIP-T53 XX.XX.YY.ZZ AA:BB:CC:DD:EE:FF"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerUser agent used to determine the vendor and model of the phone
\n"}],"url":"{{baseUrl}}/phone/directory?user_id=abcd1234&setting=directory","description":"Get the phone directory
\n","urlObject":{"path":["phone","directory"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"The user ID
\n","type":"text/plain"},"key":"user_id","value":"abcd1234"},{"description":{"content":"Setting to determine directory or super-search
\n","type":"text/plain"},"key":"setting","value":"directory"}],"variable":[]}},"response":[{"id":"e002f7b4-93e8-43f3-825d-df7e196c211e","name":"Phone directory","originalRequest":{"method":"GET","header":[{"description":"User agent used to determine the vendor and model of the phone","key":"User-Agent","value":""}],"url":{"raw":"{{baseUrl}}/phone/directory?user_id=abcd1234&setting=directory&username=User agent used to determine the vendor and model of the phone
\n"}],"url":"{{baseUrl}}/phone/dnd[/{{status}}]?mac=AABBCCDDEEFF&user_id=123&activeUser=Enable / Disable DND
\n","urlObject":{"path":["phone","dnd[","{{status}}]"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"MAC of the phone to deploy
\n","type":"text/plain"},"key":"mac","value":"AABBCCDDEEFF"},{"description":{"content":"Id of the user
\n","type":"text/plain"},"key":"user_id","value":"123"},{"description":{"content":"Username of the line to activate or deactivate
\n","type":"text/plain"},"key":"activeUser","value":"User-Agent used to determine the vendor and the model of the phone
\n"}],"url":"{{baseUrl}}/phone/forwards?action=on&event=always&target=20333000&mac=AABBCCDDEEFF&user_id=123&activeUser=Enable / Disable forwards via a phone or button on a phone linked to the user
\n","urlObject":{"path":["phone","forwards"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Set the status of the forwards
\n","type":"text/plain"},"key":"action","value":"on"},{"description":{"content":"For what event we want to check
\n","type":"text/plain"},"key":"event","value":"always"},{"description":{"content":"Forward Target
\n","type":"text/plain"},"key":"target","value":"20333000"},{"description":{"content":"MAC of the phone to deploy
\n","type":"text/plain"},"key":"mac","value":"AABBCCDDEEFF"},{"description":{"content":"Id of the user
\n","type":"text/plain"},"key":"user_id","value":"123"},{"description":{"content":"Username of the line to activate or deactivate
\n","type":"text/plain"},"key":"activeUser","value":"User-Agent used to determine the vendor and the model of the phone
\n"}],"url":"{{baseUrl}}/user/forwards?action=on&event=always&target=20333000","description":"Enable / Disable forwards for a user via a button on a phone not linked to the user
\n","urlObject":{"path":["user","forwards"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Set the status of the forwards
\n","type":"text/plain"},"key":"action","value":"on"},{"description":{"content":"For what event we want to check
\n","type":"text/plain"},"key":"event","value":"always"},{"description":{"content":"Forward Target
\n","type":"text/plain"},"key":"target","value":"20333000"}],"variable":[]}},"response":[{"id":"0e6b8ae3-f508-422a-abcc-ffd62b88ff9f","name":"Phone reply","originalRequest":{"method":"GET","header":[{"description":"User-Agent used to determine the vendor and the model of the phone","key":"User-Agent","value":"Yealink SIP-T53 XX.XX.YY.ZZ AA:BB:CC:DD:EE:FF"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicUser agent sent by the device
\n"}],"url":"{{baseUrl}}/phone/deployment/gigaset/:key/:filename","description":"Provisioning endpoint for Gigaset devices
\n","urlObject":{"path":["phone","deployment","gigaset",":key",":filename"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"badfad51-7967-4c75-a94a-7715be152ac2","description":{"content":"Instance API key (path param)
\n","type":"text/plain"},"type":"any","value":"pbx16dev-...","key":"key"},{"id":"bdde6edf-36ed-4028-a11d-9865e456a6c8","description":{"content":"gigaset addition for autoprov
\n","type":"text/plain"},"type":"any","value":"provisioning.xml","key":"filename"}]}},"response":[{"id":"a91727c4-b6b8-4580-bb17-b2aeb61e23c2","name":"Gigaset configuration","originalRequest":{"method":"GET","header":[{"description":"User agent sent by the device","key":"User-Agent","value":"Gigaset N870 IP PRO/83.V2.57.0...;589EC65D1E59;Handset=50"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerUser agent used to determine vendor/model (if needed)
\n"}],"url":"{{baseUrl}}/phone/directory/gigaset/:key","description":"Get the shared Gigaset directory (one directory per DECT manager)
\n","urlObject":{"path":["phone","directory","gigaset",":key"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"e872a9ff-eb7a-4ffa-a2e0-0459f5201194","type":"any","key":"key"}]}},"response":[{"id":"b5d437f1-2ff8-45bd-a9be-69f1f3df3878","name":"Gigaset directory","originalRequest":{"method":"GET","header":[{"description":"User agent used to determine vendor/model (if needed)","key":"User-Agent","value":"Gigaset N870 IP PRO ..."}],"url":{"raw":"{{baseUrl}}/phone/directory/gigaset/:key?username=User agent used to determine the vendor and model of the phone
\n"}],"url":"{{baseUrl}}/phone/options/info?user_id=123","description":"Get debug infos
\n","urlObject":{"path":["phone","options","info"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Id of the user
\n","type":"text/plain"},"key":"user_id","value":"123"}],"variable":[]}},"response":[{"id":"23db9d73-13fa-4788-b44a-c81e598712e8","name":"Phone debug info","originalRequest":{"method":"GET","header":[{"description":"User agent used to determine the vendor and model of the phone","key":"User-Agent","value":"Yealink SIP-T53 XX.XX.YY.ZZ AA:BB:CC:DD:EE:FF"}],"url":{"raw":"{{baseUrl}}/phone/options/info?user_id=123&username=User agent used to determine the vendor and model of the phone
\n"}],"url":"{{baseUrl}}/phone/options/sync?user_id=123","description":"Init config sync
\n","urlObject":{"path":["phone","options","sync"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Id of the user
\n","type":"text/plain"},"key":"user_id","value":"123"}],"variable":[]}},"response":[{"id":"87b0f687-2b94-4898-899a-bb4eddca4a69","name":"Phone config sync reply","originalRequest":{"method":"GET","header":[{"description":"User agent used to determine the vendor and model of the phone","key":"User-Agent","value":"Yealink SIP-T53 XX.XX.YY.ZZ AA:BB:CC:DD:EE:FF"}],"url":{"raw":"{{baseUrl}}/phone/options/sync?user_id=123&username=User agent used to determine the vendor and model of the phone
\n"}],"url":"{{baseUrl}}/phone/options?user_id=123","description":"Get options menu
\n","urlObject":{"path":["phone","options"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Id of the user
\n","type":"text/plain"},"key":"user_id","value":"123"}],"variable":[]}},"response":[{"id":"d7f0f4b8-613b-4dad-8977-dc766e774aed","name":"Phone options menu","originalRequest":{"method":"GET","header":[{"description":"User agent used to determine the vendor and model of the phone","key":"User-Agent","value":"Yealink SIP-T53 XX.XX.YY.ZZ AA:BB:CC:DD:EE:FF"}],"url":{"raw":"{{baseUrl}}/phone/options?user_id=123&username=Actions used by the phones to interact with the PBX
\n","_postman_id":"2eed877a-a5ce-40c1-98d3-6351c3d7e12a"},{"name":"Calls","item":[{"name":"Start new call","id":"ea449bfb-560b-4a01-94f3-462c21b0e8af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{basicAuthUsername}}"},{"key":"password","value":"{{basicAuthPassword}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/calls/new/tapi?debugAmiTrace=true&destination=20333300&targets=a469de67-b79a-4dea-87d2-9a15858f10cd,webrtc,twinning,teams&caller_identity=905a334f-5bf6-4ebc-85d3-2d5411187f68&autoAnswer=false&forceDialBack=false&anonymous=false","description":"Start a new call to a destination from a User using the xtelsio Tapi
\nDialBack mode: we dial first the targets and once one of those has answered we dial the destination. This allows the user to select which device will be used to start a new call
When no targets are specified we dial all linked device for the user in DialBack mode.
When only one target.sip_devices (and no other targets) is specified we try to start the call via the Phone api if this fails we dial the device\nWhen the target is webrtc and we only have one instance of voxbi open we don't use DialBack mode
Display the debug trace from asterisk manager
\n","type":"text/plain"},"key":"debugAmiTrace","value":"true"},{"description":{"content":"Destination number to dial
\n","type":"text/plain"},"key":"destination","value":"20333300"},{"description":{"content":"Target device used to start the call
\n","type":"text/plain"},"key":"targets","value":"a469de67-b79a-4dea-87d2-9a15858f10cd,webrtc,twinning,teams"},{"description":{"content":"Specify the caller identity of the call
\n","type":"text/plain"},"key":"caller_identity","value":"905a334f-5bf6-4ebc-85d3-2d5411187f68"},{"description":{"content":"Auto Answer the call on the src device (default: false) (overrides default behaviors)
\n","type":"text/plain"},"key":"autoAnswer","value":"false"},{"description":{"content":"Forces the pbx to start a call in DialBack mode (default: false) (overrides default behaviors)
\n","type":"text/plain"},"key":"forceDialBack","value":"false"},{"description":{"content":"Should the call be anonymous (default: false)
\n","type":"text/plain"},"key":"anonymous","value":"false"}],"variable":[]}},"response":[{"id":"69cbc3b7-9ed5-4f26-b909-cc7354f73575","name":"Call Started","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicStart a new call to a destination from a User or Device
\nDialBack mode: we dial first the targets and once one of those has answered we dial the destination. This allows the user to select which device will be used to start a new call
When no targets are specified we dial all linked device for the user in DialBack mode.
When the source parameter is defined we dial the source number in dial back mode and ignore all the other targets.
When only one target.sip_devices (and no other targets) is specified we try to start the call via the Phone api if this fails we dial the device
Display the debug trace from asterisk manager
\n","type":"text/plain"},"key":"debugAmiTrace","value":"true"},{"description":{"content":"Auto Answer the call on the src device (default: false) (overrides default behaviors)
\n","type":"text/plain"},"key":"autoAnswer","value":"false"},{"description":{"content":"Forces the pbx to start a call in DialBack mode (default: false) (overrides default behaviors)
\n","type":"text/plain"},"key":"forceDialBack","value":"false"},{"description":{"content":"Should the call be anonymous (default: false)
\n","type":"text/plain"},"key":"anonymous","value":"false"}],"variable":[]}},"response":[{"id":"0936271b-cbe1-4836-8c73-8aca7cd7aeda","name":"Call Started","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicActions to handle Calls
\n","_postman_id":"e61b37bb-585f-433d-adcf-1c72165926aa"},{"name":"User","item":[{"name":"Get user info","id":"d5eaabba-da4e-49a8-b9b7-064151112b6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{basicAuthUsername}}"},{"key":"password","value":"{{basicAuthPassword}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/user","description":"Get the all the Phone infos of the currently Authenticated user
\n","urlObject":{"path":["user"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"db8367a8-79e9-4770-9929-86d29e0ccccc","name":"Current user information","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicActions to interact with the Users endpoints
\n","_postman_id":"91825d71-46ca-4254-938e-ab174d9c3078"},{"name":"Server","item":[{"name":"System status","id":"54e8fb19-b407-40dd-af17-5505c59a4099","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/","description":"Health Check
\n","urlObject":{"path":[""],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"6250d2c9-8b20-43ed-9ef4-5c92e2cb80b6","name":"System Ok","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"status\": \"OK\",\n \"time\": \"1727690094\",\n \"debug\": \"false\"\n}"}],"_postman_id":"54e8fb19-b407-40dd-af17-5505c59a4099"}],"id":"311570c4-a52a-41d9-9c02-5a0b59cf8718","description":"Actions to interact with the Server endpoints
\n","_postman_id":"311570c4-a52a-41d9-9c02-5a0b59cf8718"},{"name":"Cors","item":[{"name":"Cors Options Request","id":"364e55d0-5bfc-4be3-acd2-103fcf61c167","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"OPTIONS","header":[],"url":"{{baseUrl}}/*","description":"Cors Preflight Request
\n","urlObject":{"path":["*"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"0de07d93-35d1-4485-9d7e-2f90be8fedc3","name":"Successful Options request for CORS","originalRequest":{"method":"OPTIONS","header":[],"url":"{{baseUrl}}/*"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"disabled":false,"description":{"content":"Provided Origin header","type":"text/plain"},"key":"Access-Control-Allow-Origin","value":"string"},{"disabled":false,"description":{"content":"Allowed methods","type":"text/plain"},"key":"Access-Control-Allow-Methods","value":"string"},{"disabled":false,"description":{"content":"Allowed Headers","type":"text/plain"},"key":"Access-Control-Allow-Headers","value":"string"},{"disabled":false,"description":{"content":"Max age of the cors request","type":"text/plain"},"key":"Access-Control-Max-Age","value":"string"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"364e55d0-5bfc-4be3-acd2-103fcf61c167"}],"id":"a90a473a-7bf0-47d9-9d2d-09773544573b","description":"cors
\n","_postman_id":"a90a473a-7bf0-47d9-9d2d-09773544573b"},{"name":"Calls","item":[{"name":"Start a new multicast announcement","id":"244b41e9-24be-4e46-b24c-c1814a67a5c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/calls/placemulticast?debugAmiTrace=true&ip=false&emergency=0&soundFile=all-your-base","description":"Start a new multicast announcement
\n","urlObject":{"path":["calls","placemulticast"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Display the debug trace from asterisk manager
\n","type":"text/plain"},"key":"debugAmiTrace","value":"true"},{"description":{"content":"IP to send the call to
\n","type":"text/plain"},"key":"ip","value":"false"},{"description":{"content":"Should the multicast overwrite a call 0 or 1
\n","type":"text/plain"},"key":"emergency","value":"0"},{"description":{"content":"Sound file to play
\n","type":"text/plain"},"key":"soundFile","value":"all-your-base"}],"variable":[]}},"response":[{"id":"f9e425f4-6e99-4f78-a742-af8a250fb0ca","name":"Call Started","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerHangup calls for a user
\n","urlObject":{"path":["calls","hangup"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Display the debug trace from asterisk manager
\n","type":"text/plain"},"key":"debugAmiTrace","value":"true"}],"variable":[]}},"response":[{"id":"e3a1f7d7-7c5e-41c6-9836-20830150e6e8","name":"Call has been hangup","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basiccalls
\n","_postman_id":"2587b2e8-6de3-4b92-9382-a9076e8fc0ab"},{"name":"Phone Control","item":[{"name":"Control your phone","id":"5081eadd-bcd7-48e8-927e-01fc41efadd4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{basicAuthUsername}}"},{"key":"password","value":"{{basicAuthPassword}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/phoneControl/action?debugAmiTrace=true&action=false&sip_device_id=a469de67-b79a-4dea-87d2-9a15858f10cd","description":"Remotely control your phone
\n","urlObject":{"path":["phoneControl","action"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"Display the debug trace from asterisk manager
\n","type":"text/plain"},"key":"debugAmiTrace","value":"true"},{"description":{"content":"Action to be performed
\n","type":"text/plain"},"key":"action","value":"false"},{"description":{"content":"Id of the sip device you want to perform the action from
\n","type":"text/plain"},"key":"sip_device_id","value":"a469de67-b79a-4dea-87d2-9a15858f10cd"}],"variable":[]}},"response":[{"id":"80159647-33b0-47dc-86bb-81ca2574b8ff","name":"Action Performed","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicphoneControl
\n","_postman_id":"043fe283-4c0c-41f3-b779-59566589db65"},{"name":"Webhooks","item":[{"name":"Call flow step Webhook Payload","id":"30e2b404-b3c0-40b1-98b0-4f2199a8231e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"instance_name\": \"string\",\n \"recording\": {\n \"src\": \"string\",\n \"dst\": \"string\",\n \"files\": {\n \"combined\": \"string\",\n \"receive\": \"string\",\n \"transmit\": \"string\"\n }\n },\n \"call\": {\n \"type\": \"string\",\n \"direction\": \"string\"\n },\n \"routing\": {\n \"is_vip\": \"string\",\n \"via_number\": \"string\",\n \"via_name\": \"string\",\n \"callflow_id\": \"string\",\n \"callflow_name\": \"string\"\n },\n \"user\": {\n \"dialed_user_id\": \"string\",\n \"dialed_exten\": \"string\",\n \"dialed_exten_id\": \"string\"\n },\n \"caller_id\": {\n \"name\": \"string\",\n \"number\": \"string\",\n \"number_international\": \"string\",\n \"international_prefix\": \"string\"\n },\n \"queue\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"exit_key\": \"string\",\n \"status\": \"string\",\n \"position\": \"string\",\n \"abandoned\": \"string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://your-server.com/webhook-endpoint","description":"Voxbi PBX – Call Flow Webhook
\nThe Voxbi PBX supports calling a Web hook during a call flow via the web hook call flow step.
The Web hook send a POST request with a JSON body as payload.
Register your server webhook url at https://cockpit.voxbi.com
\nInside callflow edit option.
\nMethod
\nPOST
Content-Type
\napplication/json
\n
Request Body (Schema)
\n{\n \"instance_name\": \"string\",\n \"recording\": {\n \"src\": \"string\",\n \"dst\": \"string\",\n \"files\": {\n \"combined\": \"string\",\n \"receive\": \"string\",\n \"transmit\": \"string\"\n }\n },\n \"call\": {\n \"type\": \"string\",\n \"direction\": \"string\"\n },\n \"routing\": {\n \"is_vip\": \"string\",\n \"via_number\": \"string\",\n \"via_name\": \"string\",\n \"callflow_id\": \"string\",\n \"callflow_name\": \"string\"\n },\n \"user\": {\n \"dialed_user_id\": \"string\",\n \"dialed_exten\": \"string\",\n \"dialed_exten_id\": \"string\"\n },\n \"caller_id\": {\n \"name\": \"string\",\n \"number\": \"string\",\n \"number_international\": \"string\",\n \"international_prefix\": \"string\"\n },\n \"queue\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"exit_key\": \"string\",\n \"status\": \"string\",\n \"position\": \"string\",\n \"abandoned\": \"string\"\n },\n \"ivr\": {\n \"id\": \"54374fbc-8a38-4712-b832-97b86bde5e4a\",\n \"name\": \"Demo IVR\",\n \"step\": {\n \"id\": \"54374fbc-8a38-4712-b832-97b86bde5e4a\",\n \"option\": \"1\"\n }\n }\n}\n\n\n
Sample Request Body
\n{\n \"instance_name\": \"myCoolPbx1234\",\n \"recording\": {\n \"src\": \"+3522033332017\",\n \"dst\": \"+35220602700\",\n \"files\": {\n \"combined\": \"/mnt/hdd/recordings/spool/myCoolPbx1234_CF_8a274b6e-d50b-4abd-ad18-fc153898841c_1751009487.68.wav\",\n \"receive\": \"/mnt/hdd/recordings/spool/myCoolPbx1234_CF_8a274b6e-d50b-4abd-ad18-fc153898841c_1751009487.68.RX.wav\",\n \"transmit\": \"/mnt/hdd/recordings/spool/myCoolPbx1234_CF_8a274b6e-d50b-4abd-ad18-fc153898841c_1751009487.68.TX.wav\"\n }\n },\n \"call\": {\n \"type\": \"external\",\n \"direction\": \"incoming\"\n },\n \"routing\": {\n \"is_vip\": \"TRUE\",\n \"via_number\": \"1234\",\n \"via_name\": \"Test 1234\",\n \"callflow_id\": \"8a274b6e-d50b-4abd-ad18-fc153898841c\",\n \"callflow_name\": \"Default Call Flow External\"\n },\n \"user\": {\n \"dialed_user_id\": \"8a274b6e-ffff-ffff-ad18-fc153898841c\",\n \"dialed_exten\": \"1234\",\n \"dialed_exten_id\": \"8a274b6e-cccc-cccc-ad18-fc153898841c\"\n },\n \"caller_id\": {\n \"name\": \"LAURES Christophe\",\n \"number\": \"+3522033332017\",\n \"number_international\": \"+3522033332017\",\n \"international_prefix\": \"352\"\n },\n \"queue\": {\n \"id\": \"54374fbc-8a38-4712-b832-97b86bde5e4a\",\n \"name\": \"Demo Q\",\n \"exit_key\": \"5\",\n \"status\": \"TIMEOUT\",\n \"position\": \"1\",\n \"abandoned\": \"TRUE\"\n },\n ,\n \"ivr\": {\n \"id\": \"54374fbc-8a38-4712-b832-97b86bde5e4a\",\n \"name\": \"Demo IVR\",\n \"step\": {\n \"id\": \"54374fbc-8a38-4712-b832-97b86bde5e4a\",\n \"option\": \"1\"\n }\n }\n}\n\n\n
Response Body (What Your Webhook Must Return)
\nImportant
\n- \n
All response fields are optional
\n \nYou may return an empty body
\n \nReturning HTTP 200 OK with no JSON is completely valid
\n \n
Sample Response:
\n{\n \"hangup\": false,\n \"vip\": true,\n \"caller_id\": {\n \"number\": \"+35220333300\",\n \"name\": \"My Company\"\n },\n \"queue_priority\": 10,\n \"via\": {\n \"number\": \"+35220333300\",\n \"name\": \"Support Line\",\n \"overwrite\": true\n },\n \"transfer\": {\n \"destination\": \"+35220333300\",\n \"type\": \"number\",\n \"caller_identity_id\": \"8a274b6e-cccc-cccc-ad18-fc153898841c\",\n \"carrier_id\": \"9b385c7f-dddd-dddd-be29-gd264909952d\",\n \"timeout\": 300\n }\n}\n\nSample response schemas:
\n{\n \"hangup\": false,\n \"vip\": false,\n \"caller_id\": {\n \"name\": \"string\",\n \"number\": \"string\"\n },\n \"queue_priority\": 0\n}\n\n\n
Example Response – Do Nothing
\n{\n \"hangup\": false,\n \"vip\": false\n}\n\n\n
Example Response – Hangup Call
\n{\n \"hangup\": true\n}\n\n\n
Example Response – Mark as VIP
\n{\n \"vip\": true\n}\n\n\n
Example Response – Change Caller ID
\n{\n \"caller_id\": {\n \"name\": \"VIP Customer\",\n \"number\": \"+35299999999\"\n }\n}\n\n\n
Example Response – Increase Queue Priority
\n{\n \"queue_priority\": 10\n}\n\nExample Response – Change Via Header
\n{\n \"via\": {\n \"number\": \"+1234567890\",\n \"name\": \"Support Line\",\n \"overwrite\": true\n }\n}\n\nExample Response – Transfer Call to Number
\n{\n \"transfer\": {\n \"destination\": \"+1234567890\",\n \"type\": \"number\",\n \"caller_identity_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"carrier_id\": \"660e8400-e29b-41d4-a716-446655440111\",\n \"timeout\": 30\n }\n}\n\nExample Response – Transfer Call to SIP URI
\n{\n \"transfer\": {\n \"destination\": \"sip:user@example.com\",\n \"type\": \"sip\",\n \"timeout\": 20\n }\n}\n\nExample Response – Transfer Call to Call Flow
\n{\n \"transfer\": {\n \"destination\": \"880e8400-e29b-41d4-a716-446655440333\",\n \"type\": \"call_flow\"\n }\n}\n\nExample Response – Transfer Call to User
\n{\n \"transfer\": {\n \"destination\": \"770e8400-e29b-41d4-a716-446655440222\",\n \"type\": \"user\"\n }\n}\n\nExample Response – Transfer Call to SIP Device
\n{\n \"transfer\": {\n \"destination\": \"990e8400-e29b-41d4-a716-446655440444\",\n \"type\": \"sip_device\"\n }\n}\n\n