The Qvara API allows users to interact with the Qvara hosted phone system with any programming language they require.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"3692698","collectionId":"35a295d4-1bba-45da-a0ae-e9335d271dc4","publishedId":"2sBYArUYAk","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-08-20T15:13:21.000Z"},"item":[{"name":"Enums","item":[{"name":"Timezones","event":[{"script":{"packages":[],"type":"text/javascript","id":"d31122fe-e77b-4b12-bdf3-0009329137c6","exec":[""]},"listen":"test"}],"id":"ddcf0afc-b38c-4d2e-ab6f-91c397af327c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://qvara.net/api/v1/enums/timezones","description":"Retrieve a list of timezones for use in creating or updating various resources.
\nReturns a 200 with a JSON object mapping each IANA timezone identifier to a human-readable label prefixed with its UTC offset:
\nAmerica/New_York.(UTC-05:00) America/New_York.Retrieve the definitions of every webhook event supported by the system. Useful for understanding which events can trigger a webhook and what parameters each event's payload includes.
\nReturns a 200 with an array containing a single object:
\naccountId (string): Placeholder describing the field type sent with every event (\"UUID\").callId (string): Placeholder describing the field type sent with every event (\"long integer\").channelId (string): Placeholder describing the field type sent with every event (\"string\").callerIdNum (string): Placeholder describing the field type sent with every event (\"string\").callerIdName (string): Placeholder describing the field type sent with every event (\"string\").events (object): A map of every webhook event name to an object describing that event's additional payload parameters (or [] for events that add none, e.g. Hangup). Pass an event name from this list to GET /enums/webhook-sample/:eventType to see a full sample payload.Retrieve a sample webhook payload for a specific event type. Useful for developers who want to understand the structure of the payloads they will receive for different webhook events before writing an integration.
\neventType (required, string): The event name to preview, from the list returned by GET /enums/webhook-definitions. Example: IvrMenuOptionPushed.Returns a 200 with an array containing a single sample payload object. The object always includes event, accountId, callId, channelId, callerIdNum, and callerIdName, plus the additional parameters specific to the requested eventType.
From the list of events provided by the enums/webhook-definitions endpoint
\n","type":"text/plain"},"type":"any","value":"","key":"eventType"}]}},"response":[{"id":"ce5120e3-27ef-4422-8f9c-717d16265cbb","name":"IvrMenuOptionPushed","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://qvara.net/api/v1/enums/webhook-sample/:eventType","host":["https://qvara.net/api/v1"],"path":["enums","webhook-sample",":eventType"],"variable":[{"key":"eventType","value":"IvrMenuOptionPushed"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 May 2025 13:42:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Cf-Cache-Status","value":"DYNAMIC"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=Gk3QSeI1%2Fj%2FjM2Qmmjo0HD1a9dK4qWFncrs%2FcBIBJec5UjNbKnUudglFghS7ESOZ4o2NgYKfjLJnxL6SHboqeK6Tll0AZdID\"}]}"},{"key":"Content-Encoding","value":"br"},{"key":"CF-RAY","value":"943cbc2a8ef05831-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"event\": \"IvrMenuOptionPushed\",\n \"accountId\": \"UUID\",\n \"callId\": \"long integer\",\n \"channelId\": \"string\",\n \"callerIdNum\": \"string\",\n \"callerIdName\": \"string\",\n \"ivrMenuId\": \"UUID\",\n \"ivrMenuExtension\": \"string\",\n \"optionPushed\": \"string\"\n }\n]"}],"_postman_id":"2a08ab68-b30e-4a1f-9e60-dbe977c240d8"},{"name":"Accounts: Service Types","id":"8f519545-91a4-49df-8fc7-a7498de871ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://qvara.net/api/v1/enums/accounts/service-types","description":"Retrieve a list of service types for use in creating or updating an account.
\n","urlObject":{"path":["enums","accounts","service-types"],"host":["https://qvara.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"6593eb6f-d9cf-477e-935d-fbb1b943b2b5","name":"Example","originalRequest":{"method":"GET","header":[],"url":"https://qvara.net/api/v1/enums/accounts/service-types"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Fri, 27 Jun 2025 19:15:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"business\": \"Business\",\n \"residential\": \"Residential\",\n \"government\": \"Government\"\n}"}],"_postman_id":"8f519545-91a4-49df-8fc7-a7498de871ec"},{"name":"Accounts: Retention Policies","id":"134a3b71-0a29-4875-9bfd-fdbc523ddac4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://qvara.net/api/v1/enums/accounts/retention-policies","description":"Retrieve a list of retention policy durations of various types of account assets.
\n","urlObject":{"path":["enums","accounts","retention-policies"],"host":["https://qvara.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"7d73a011-a8e0-437d-ae80-33968b16345e","name":"Example","originalRequest":{"method":"GET","header":[],"url":"https://qvara.net/api/v1/enums/accounts/retention-policies"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Fri, 27 Jun 2025 19:17:25 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"15d\": \"15 Days\",\n \"30d\": \"30 Days\",\n \"60d\": \"60 Days\",\n \"90d\": \"90 Days\",\n \"6m\": \"6 Months\",\n \"12m\": \"12 Months\",\n \"18m\": \"18 Months\",\n \"24m\": \"24 Months\"\n}"}],"_postman_id":"134a3b71-0a29-4875-9bfd-fdbc523ddac4"},{"name":"Accounts: Statuses","id":"54256dcd-abd9-4d1f-a740-7b47598f5021","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://qvara.net/api/v1/enums/accounts/statuses","description":"Retrieve a list of account statuses for use in creating or updating an account.
\nReturns a 200 with a JSON object mapping each status value to its human-readable label:
\nactive: \"Active\"inactive: \"Inactive\"disconnected: \"Disconnected\"suspended: \"Suspended\"deleted: \"Deleted\"Retrieve a list of industries for use in creating or updating an account.
\n","urlObject":{"path":["enums","accounts","industries"],"host":["https://qvara.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"025d18f2-40bc-4114-868b-bb5e549e6cd5","name":"Example","originalRequest":{"method":"GET","header":[],"url":"https://qvara.net/api/v1/enums/accounts/industries"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"localhost:8000","key":"Host"},{"value":"close","key":"Connection"},{"value":"PHP/8.3.13","key":"X-Powered-By"},{"value":"no-cache, private","key":"Cache-Control"},{"value":"Fri, 27 Jun 2025 19:19:43 GMT","key":"Date"},{"value":"application/json","key":"Content-Type"},{"value":"*","key":"Access-Control-Allow-Origin"}],"cookie":[],"responseTime":null,"body":"[\n \"Agriculture\",\n \"Media and Communication\",\n \"Construction, Materials, and Trade Services\",\n \"Education\",\n \"Energy and Utilities\",\n \"Entertainment\",\n \"Financial Services\",\n \"Gambling and Lottery\",\n \"Government Services and Agencies\",\n \"Healthcare and Life Sciences\",\n \"Hospitality and Travel\",\n \"HR\",\n \"Staffing or Recruitment\",\n \"Insurance\",\n \"Legal\",\n \"Manufacturing\",\n \"Non-profit Organization\",\n \"Political\",\n \"Postal and Delivery\",\n \"Professional Services\",\n \"Real Estate\",\n \"Retail and Consumer Products\",\n \"Information Technology Services\",\n \"Transportation or Logistics\"\n]"}],"_postman_id":"529e5e75-3567-4c54-9adc-9780bb0ac421"},{"name":"Automation Actions: Types","id":"839fd222-6f05-4861-9c15-3495fe288cbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://qvara.net/api/v1/enums/automation-actions/types","description":"Retrieve a list of automation action types available for use when configuring automations.
\nReturns a 200 with a JSON object mapping each action type value to its human-readable label:
\nemail: \"Email message to user(s)\"two-way-toggle-state: \"Change the state of a two-way toggle\"multiway-toggle-dest: \"Change the active destination of a multiway toggle\"dynamic-caller-id: \"Change dynamic callerID of an extension\"sms: \"Send a SMS (text) message\"call-queue-login: \"Call Queue Login\"call-queue-logout: \"Call Queue Logout\"Retrieve a list of accounts with details such as customer name, service type, industry, status, timezone, and other related information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"35a295d4-1bba-45da-a0ae-e9335d271dc4","id":"35a295d4-1bba-45da-a0ae-e9335d271dc4","name":"Qvara API v1","type":"collection"}},"urlObject":{"path":["accounts"],"host":["https://qvara.net/api/v1"],"query":[],"variable":[]}},"response":[{"id":"f1c284ed-5590-4253-b8b9-1267a699f774","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"https://qvara.net/api/v1/accounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Fri, 27 Jun 2025 19:53:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"9e3c95b1-0bf6-4345-8ad0-83e9a5c613df\",\n \"customer_name\": \"Little LLC\",\n \"service_type\": \"Business\",\n \"industry\": \"Investment\",\n \"status\": \"Active\",\n \"timezone\": \"America/New_York\",\n \"iso\": \"US\",\n \"authorization_pin\": \"479030\",\n \"outbound_phone_number_id\": \"9ee71ebf-5c6b-4003-9beb-e0c581980481\",\n \"emergency_phone_number_id\": \"9e60ac17-2629-4119-9ab5-77ee3eb5bd5f\",\n \"retain_digital_faxes\": \"90d\",\n \"retain_call_recordings\": \"18m\",\n \"retain_voicemails\": \"18m\",\n \"retain_messages\": \"6m\",\n \"fraud_forwarding_concurrency_limit\": 4,\n \"fraud_extension_concurrency_limit\": 4,\n \"created_at\": \"2025-03-07T20:46:50.000000Z\",\n \"updated_at\": \"2025-06-23T14:45:22.000000Z\"\n },\n {\n \"id\": \"9e60ac14-aafa-484f-857b-4a39b99d8b5c\",\n \"customer_name\": \"Wolf LLC\",\n \"service_type\": \"Government\",\n \"industry\": \"Fishery\",\n \"status\": \"Active\",\n \"timezone\": \"America/Chicago\",\n \"iso\": \"US\",\n \"authorization_pin\": \"713951\",\n \"outbound_phone_number_id\": null,\n \"emergency_phone_number_id\": null,\n \"retain_digital_faxes\": \"90d\",\n \"retain_call_recordings\": \"18m\",\n \"retain_voicemails\": \"18m\",\n \"retain_messages\": \"6m\",\n \"fraud_forwarding_concurrency_limit\": 4,\n \"fraud_extension_concurrency_limit\": 4,\n \"created_at\": \"2025-03-07T20:46:50.000000Z\",\n \"updated_at\": \"2025-03-07T20:46:50.000000Z\"\n },\n {\n \"id\": \"9e60ac14-abb4-4d37-8179-2ed471f2e7e8\",\n \"customer_name\": \"Wisoky, Okuneva and Satterfield\",\n \"service_type\": \"Business\",\n \"industry\": \"Mining\",\n \"status\": \"Active\",\n \"timezone\": \"America/Chicago\",\n \"iso\": \"US\",\n \"authorization_pin\": \"213390\",\n \"outbound_phone_number_id\": \"9e60ac17-4645-440b-8ec7-d0a235ba3885\",\n \"emergency_phone_number_id\": \"9e60ac17-4645-440b-8ec7-d0a235ba3885\",\n \"retain_digital_faxes\": \"90d\",\n \"retain_call_recordings\": \"18m\",\n \"retain_voicemails\": \"18m\",\n \"retain_messages\": \"6m\",\n \"fraud_forwarding_concurrency_limit\": 4,\n \"fraud_extension_concurrency_limit\": 4,\n \"created_at\": \"2025-03-07T20:46:50.000000Z\",\n \"updated_at\": \"2025-06-09T18:34:37.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"http://localhost:8000/api/v1/accounts?page=1\",\n \"last\": \"http://localhost:8000/api/v1/accounts?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"http://localhost:8000/api/v1/accounts?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": null,\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"http://localhost:8000/api/v1/accounts\",\n \"per_page\": 15,\n \"to\": 3,\n \"total\": 3\n }\n}"}],"_postman_id":"3e44bc3d-70b4-45e7-ba3e-78cea38c4755"},{"name":"Create Account","event":[{"script":{"type":"text/javascript","packages":[],"exec":[""],"id":"4953fbdd-170c-41cd-94de-1fd4d4088de2"},"listen":"test"}],"id":"0cfa039a-1955-4191-93d3-140f1bf51545","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"customer_name\":\"Aardvark Construction\",\"service_type_enum\":\"business\",\"industry\":\"Engineering\",\"iso\":\"US\",\"timezone\":\"America/Chicago\"}","options":{"raw":{"language":"json"}}},"url":"https://qvara.net/api/v1/accounts","description":"Create a new account with the provided customer details.
\ncustomer_name (required, string): The name of the customer.
service_type_enum (required, string): The type of service, e.g., \"business\". (Must be one of Enums > Accounts: Service Types.)
industry (required, string): The industry of the customer. (Must be one of Enums > Accounts: Industries.)
iso (required, string): A supported ISO (country-code). (Must be one of Enums > Supported ISO's.)
timezone (required, string): (Must be one of Enums > Timezones.)
Upon successful creation, the endpoint returns a status code of 200 and a JSON response with the following fields:
\nmessage (string): A message indicating the result of the operation.
data (object): An object containing the details of the newly created account, including:
id (string): The unique identifier of the account.
customer_name (string): The name of the customer.
service_type (string): The type of service.
industry (string): The industry of the customer.
status (string): The status of the account.
timezone (string): The timezone associated with the account.
iso (string): The ISO code associated with the account.
authorization_pin (string): The authorization PIN for the account.
outbound_phone_number_id (string): The ID of the outbound phone number associated with the account.
emergency_phone_number_id (string): The ID of the emergency phone number associated with the account.
retain_digital_faxes (boolean): Indicates whether digital faxes are retained.
retain_call_recordings (boolean): Indicates whether call recordings are retained.
retain_voicemails (boolean): Indicates whether voicemails are retained.
retain_messages (boolean): Indicates whether messages are retained.
created_at (string): The timestamp of the account creation.
updated_at (string): The timestamp of the last update to the account.
Retrieve the details of a specific account identified by the account_id.
The response will be in JSON format and will contain the following fields:
\nid (string): The unique identifier of the account.customer_name (string): The name of the customer associated with the account.service_type (string): The type of service provided for the account.industry (string): The industry to which the account belongs.status (string): The status of the account.timezone (string): The timezone setting for the account.iso (string): The ISO code associated with the account.authorization_pin (string): The authorization PIN for the account.outbound_phone_number_id (string or null): The ID of the outbound phone number associated with the account, or null if not available.emergency_phone_number_id (string or null): The ID of the emergency phone number associated with the account, or null if not available.retain_digital_faxes (string): Data retention policy for digital fax records.retain_call_recordings (string): Data retention policy for call recordings.retain_voicemails (string): Data retention policy for voicemails.retain_messages (string): Data retention policy for SMS/MMS records.fraud_forwarding_concurrency_limit (integer or null): The maximum number of concurrent forwarded calls allowed before fraud protection kicks in.fraud_extension_concurrency_limit (integer or null): The maximum number of concurrent extension calls allowed before fraud protection kicks in.created_at (string): The timestamp when the account was created.updated_at (string): The timestamp when the account was last updated.Update the details of a specific account.
\nenterprise_id (optional, string): The unique identifier of the enterprise to associate with this account. Must be one of the reseller's enterprises.customer_name (optional, string): The name of the customer.service_type_enum (optional, string): The type of service, e.g., \"business\". (Must be one of Enums > Accounts: Service Types.)industry (optional, string): The demographic industry of the customer. (Must be one of Enums> Accounts: Industries.)iso (optional, string): A supported ISO (country-code). (Must be one of Enums: Supported ISO's.)timezone (optional, string): (Must be one of Enums: Timezones.)outbound_phone_number_id (optional, string): The unique identifier for the default outbound phone number for this account. (A default outbound phone number must be assigned to the account before extensions may be created.)emergency_phone_number_id (optional, string): The unique identifier for the default emergency phone number for this account. (A default emergency phone number must be assigned to the account before extensions may be created.)retain_digital_faxes (optional, string): Data retention policy for digital fax records. (Must be one of Enums > Accounts: Retention Policies.)retain_call_recordings (optional, string): Data retention policy for call recordings. (Must be one of Enums > Accounts: Retention Policies.)retain_voicemails (optional, string): Data retention policy for voicemails. (Must be one of Enums > Accounts: Retention Policies.)retain_messages (optional, string): Data retention policy for SMS/MMS records. (Must be one of Enums > Accounts: Retention Policies.)fraud_forwarding_concurrency_limit (optional, integer): Minimum 1, Maximum 20fraud_extension_concurrency_limit (optional, integer): Minimum 1, Maximum 20Returns a 200 with:
\nmessage (string): A message indicating the result of the operation.data (object): The updated account, with the same fields as the Read Account response (id, customer_name, service_type, industry, status, timezone, iso, authorization_pin, outbound_phone_number_id, emergency_phone_number_id, retain_digital_faxes, retain_call_recordings, retain_voicemails, retain_messages, fraud_forwarding_concurrency_limit, fraud_extension_concurrency_limit, created_at, updated_at).Initiate a click-to-call action for a specific account. It facilitates the process of connecting a call to a recipient phone number using an external number and optionally overriding the caller ID.
\next_number (required, string): The extension number to originate the call from. Must be one of the account's existing extension numbers.recipient_phone_number (required, string): The phone number to dial. Numeric only, up to 14 digits.override_cid_phone_number (optional, string): A phone number to use as the outbound caller ID instead of the extension's default. Numeric only, up to 14 digits.Returns a 200 with:
\nmessage (string): Confirmation that the click-to-call request was dispatched.account_id (string): The unique identifier of the account.request_tracking_id (string): A UUID that can be used to track this specific click-to-call request.data (object): The validated call parameters that were dispatched:ext_number (string): The extension the call was originated from.recipient_phone_number (string): The phone number that was dialed.override_cid_phone_number (string or null): The caller ID override used, if any.(string): The extension number to be used for the call.
\n","type":"text/plain"},"key":"ext_number","value":"108"},{"description":{"content":"(string): The phone number of the recipient to whom the call is directed.
\n","type":"text/plain"},"key":"recipient_phone_number","value":"19726001151"},{"disabled":true,"description":{"content":"(string): An optional parameter that allows overriding the caller ID with a specified phone number.
\n","type":"text/plain"},"key":"override_cid_phone_number","value":""}],"variable":[{"id":"b431115e-a0d5-4b2a-a9c3-383e17d3487e","type":"any","value":"9e3c95b1-0bf6-4345-8ad0-83e9a5c613df","key":"account_id"}]}},"response":[{"id":"17a455eb-06c0-465f-b5f2-015c6b2a146e","name":"200 OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://qvara.io/api/v1/accounts/:account_id/click-to-call?ext_number=80369&recipient_phone_number=15559876543&override_cid_phone_number=15557654321","protocol":"https","host":["qvara","io"],"path":["api","v1","accounts",":account_id","click-to-call"],"query":[{"key":"ext_number","value":"80369"},{"key":"recipient_phone_number","value":"15559876543"},{"key":"override_cid_phone_number","value":"15557654321"}],"variable":[{"key":"account_id","value":"9e3c95b1-0bf6-4345-8ad0-83e9a5c613df"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 30 Jun 2025 16:04:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Click-to-call request dispatched!\",\n \"account_id\": \"9e3c95b1-0bf6-4345-8ad0-83e9a5c613df\",\n \"request_tracking_id\": \"4601cf2a-4d0e-42ef-8d97-38729e7e4db9\",\n \"data\": {\n \"ext_number\": \"80369\",\n \"recipient_phone_number\": \"15559876543\",\n \"override_cid_phone_number\": \"15557654321\"\n }\n}"}],"_postman_id":"62f7f43e-6d43-4a52-8e46-ba487deebf8b"},{"name":"Search Call Parking Lots","id":"46f9a6c5-ac2b-47e3-9125-a23a4ccc31c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://qvara.net/api/v1/accounts/:account_id/call-parking-lots","description":"Retrieve the call parking lots configured for a specific account.
\naccount_id (required, string): The unique identifier of the account.Returns a 200 with a data array of call parking lot objects:
id (string): The unique identifier of the call parking lot.account_id (string): The account this parking lot belongs to.ext_number (string): The extension number used to access this parking lot.label (string): A short label describing the parking lot.description (string): A longer description of the parking lot.notes (string): Internal notes about the parking lot.slots (integer): The number of parking spaces available.parking_spaces (array of integers): The individual parking space numbers.timeout_seconds (integer): How long a parked call rings before timing out.cdr_tags (string or null): Tags applied to CDR records generated by this parking lot.dialing_address (string): The full dialing address used to reach this parking lot.album_id (string or null): The unique identifier of the associated hold-music album.webhook_id (string or null): The unique identifier of the webhook fired by this parking lot's events.created_at (string): Timestamp when the parking lot was created.updated_at (string): Timestamp when the parking lot was last updated.Retrieve the multiway toggles configured for a specific account.
\naccount_id (required, string): The unique identifier of the account.Returns a 200 with a data array of multiway toggle objects:
id (string): The unique identifier of the multiway toggle.account_id (string): The account this toggle belongs to.label (string): A short label describing the toggle.description (string): A longer description of the toggle.notes (string): Internal notes about the toggle.authorization_pin (string): The PIN required to change the toggle's active destination.created_at (string): Timestamp when the toggle was created.updated_at (string): Timestamp when the toggle was last updated.ext_number (string or null): The extension number used to access this toggle.dialing_address (string or null): The full dialing address used to reach this toggle.webhook_id (string or null): The unique identifier of the webhook fired by this toggle's events.multiwayToggleDestinations (array): The toggle's configured destinations, each with:id (string): The unique identifier of the destination.status (string): Active if this is the toggle's currently-active destination, otherwise Inactive.digits (string or null): Digits associated with the destination.disable_voicemail (boolean): Whether voicemail is disabled for this destination.cdr_tags (string or null): Tags applied to CDR records generated by calls sent to this destination.type_enum (string): The type of call flow this destination routes to.destination_id (string): The unique identifier of the call flow's target.iso (string or null): ISO country code associated with the destination's phone number, if any.phone_number (string or null): The phone number associated with the destination, if any.created_at (string): Timestamp when the destination was created.updated_at (string): Timestamp when the destination was last updated.Soft-delete an account. The account and its data are retained but the account becomes inaccessible until restored.
\nmessage (string): Confirmation that the account was deleted.Restore a previously soft-deleted account.
\nmessage (string): Confirmation that the account was reactivated.Retrieve the list of currently active call channels for a specific account.
\naccount_id (required, string): The unique identifier for the account whose active calls are being requested.Returns a 200 with a JSON array of active call channel objects reported by the account's realtime PBX service; an empty array ([]) means the account currently has no active calls.
(string): The unique identifier for the account whose active calls are being requested.
\n","type":"text/plain"},"type":"any","value":"","key":"account_id"}]}},"response":[{"id":"d32290e1-f4a3-4f46-9b01-507b0210a5ca","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://qvara.net/api/v1/accounts/:account_id/active-calls","host":["https://qvara.net/api/v1"],"path":["accounts",":account_id","active-calls"],"variable":[{"key":"account_id","value":"9e3c95b1-0bf6-4345-8ad0-83e9a5c613df"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 30 Jun 2025 16:20:27 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"6fd05c96-a849-4d72-976c-cde7ed3b8f42"},{"name":"Hangup Call","id":"2d9f4feb-abfb-46c1-8bcb-f9ac4ee430c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://qvara.net/api/v1/accounts/:account_id/active-calls/hangup","description":"Hang up an active call associated with a specific account.
\naccount_id (required, string): The unique identifier of the account whose active call you want to hang up.channel_id (required, string): The identifier of the channel associated with the active call you wish to hang up, e.g. PJSIP/external-kamailio/200029992.Returns a 200 with:
\nmessage (string): Confirmation message.data.channel_id (string): The channel that was hung up.(string): The identifier of the channel associated with the active call that you wish to hang up. For example, PJSIP/external-kamailio/#########.
(string): The unique identifier of the account whose active call you want to hang up.
\n","type":"text/plain"},"type":"any","value":"","key":"account_id"}]}},"response":[{"id":"3da0f48c-9cf4-4727-bff2-e1c650b0496e","name":"200 OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://qvara.net/api/v1/accounts/:account_id/active-calls/hangup?channel_id=PJSIP/external-kamailio/200029992","host":["https://qvara.net/api/v1"],"path":["accounts",":account_id","active-calls","hangup"],"query":[{"key":"channel_id","value":"PJSIP/external-kamailio/200029992","description":"(string): The identifier of the channel associated with the active call that you wish to hang up. For example, `PJSIP/external-kamailio/#########`."}],"variable":[{"key":"account_id","value":"9e3c95b1-0bf6-4345-8ad0-83e9a5c613df","description":"(string): The unique identifier of the account whose active call you want to hang up."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 30 Jun 2025 16:29:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Call dropped!\",\n \"data\": {\n \"channel_id\": \"PJSIP/external-kamailio/200029992\"\n }\n}"}],"_postman_id":"2d9f4feb-abfb-46c1-8bcb-f9ac4ee430c5"},{"name":"Transfer Call","id":"c3ba25e6-b608-4d96-8d7c-dc5e975d174c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://qvara.net/api/v1/accounts/:account_id/active-calls/transfer","description":"Transfer an active call associated with a specific account to another extension or phone number.
\naccount_id (required, string): The unique identifier of the account whose active call you want to transfer.channel_id (required, string): The identifier of the channel associated with the active call you wish to transfer, e.g. PJSIP/external-kamailio/200029992.destination (required, string): The extension number or phone number to transfer the call to.Returns a 200 with:
\nmessage (string): Confirmation message.data.channel_id (string): The channel that was transferred.data.destination (string): The destination the call was transferred to.(string): The identifier of the channel associated with the active call that you wish to transfer. For example, PJSIP/external-kamailio/#########.
(string): Extension number or phone number to transfer the call to
\n","type":"text/plain"},"key":"destination","value":""}],"variable":[{"id":"e2e1ba98-e0bd-4590-abbf-1a01c52d618b","description":{"content":"(string): The unique identifier of the account whose active call you want to hang up.
\n","type":"text/plain"},"type":"any","value":"","key":"account_id"}]}},"response":[{"id":"a35f8432-72f9-4102-8cc0-e5e4927f938a","name":"200 OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://qvara.net/api/v1/accounts/:account_id/active-calls/transfer?channel_id=PJSIP/external-kamailio/200029992&destination=502","host":["https://qvara.net/api/v1"],"path":["accounts",":account_id","active-calls","transfer"],"query":[{"key":"channel_id","value":"PJSIP/external-kamailio/200029992","description":"(string): The identifier of the channel associated with the active call that you wish to transfer. For example, `PJSIP/external-kamailio/#########`."},{"key":"destination","value":"502","description":"(string): Extension number or phone number to transfer the call to"}],"variable":[{"key":"account_id","value":"9e3c95b1-0bf6-4345-8ad0-83e9a5c613df","description":"(string): The unique identifier of the account whose active call you want to hang up."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 30 Jun 2025 19:26:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Call transferred!\",\n \"data\": {\n \"channel_id\": \"PJSIP/external-kamailio/200029992\",\n \"destination\": \"502\"\n }\n}"}],"_postman_id":"c3ba25e6-b608-4d96-8d7c-dc5e975d174c"},{"name":"Park Call","id":"bdb38571-88fe-41bb-982a-64b3a96c530d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://qvara.net/api/v1/accounts/:account_id/active-calls/park","description":"Park an active call associated with a specific account in a call parking lot. See Call Parking Lots > Search Call Parking Lots for valid parking_lot_id values.
account_id (required, string): The unique identifier of the account whose active call you want to park.channel_id (required, string): The identifier of the channel associated with the active call you wish to park, e.g. PJSIP/external-kamailio/200029992.parking_lot_id (required, string): The ID of one of the account's call parking lots. Must match a call parking lot that belongs to this account.parking_space (optional, numeric): The specific parking space/slot to use within the parking lot.Returns a 200 with:
\nmessage (string): Confirmation message.data.channel_id (string): The channel that was parked.data.parking_lot_id (string): The parking lot the call was parked in.data.parking_space (string): The parking space used.(string): The identifier for the communication channel, formatted as PJSIP/external-kamailio/{number}
\n","type":"text/plain"},"key":"channel_id","value":""},{"disabled":true,"description":{"content":"(string): A unique identifier for the parking lot where the call will be parked.
\n","type":"text/plain"},"key":"parking_lot_id","value":""},{"disabled":true,"description":{"content":"(string): The specific parking space identifier within the parking lot.
\n","type":"text/plain"},"key":"parking_space","value":""}],"variable":[{"id":"6863cb5b-9a0f-4de3-8a90-e380efcecafe","description":{"content":"(string): The unique identifier of the account whose active call you want to park
\n","type":"text/plain"},"type":"any","value":"","key":"account_id"}]}},"response":[{"id":"f7e8eb91-da04-4fc1-804b-5859a380b479","name":"200 OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://qvara.net/api/v1/accounts/:account_id/active-calls/park?channel_id=PJSIP/external-kamailio/200029992&parking_lot_id=9e60ac17-1e6e-4534-adcb-fa8b4ce5a0f2&parking_space=37245","host":["https://qvara.net/api/v1"],"path":["accounts",":account_id","active-calls","park"],"query":[{"key":"channel_id","value":"PJSIP/external-kamailio/200029992","description":"(string): The identifier for the communication channel, formatted as PJSIP/external-kamailio/{number}"},{"key":"parking_lot_id","value":"9e60ac17-1e6e-4534-adcb-fa8b4ce5a0f2","description":"(string): A unique identifier for the parking lot where the call will be parked."},{"key":"parking_space","value":"37245","description":"(string): The specific parking space identifier within the parking lot."}],"variable":[{"key":"account_id","value":"9e3c95b1-0bf6-4345-8ad0-83e9a5c613df","description":"(string): The unique identifier of the account whose active call you want to park"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 30 Jun 2025 19:30:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Call parked!\",\n \"data\": {\n \"channel_id\": \"PJSIP/external-kamailio/200029992\",\n \"parking_lot_id\": \"9e60ac17-1e6e-4534-adcb-fa8b4ce5a0f2\",\n \"parking_space\": \"37245\"\n }\n}"}],"_postman_id":"bdb38571-88fe-41bb-982a-64b3a96c530d"},{"name":"Start Recording","id":"b0641b8f-65ec-4855-ae12-49d7f2ca6663","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://qvara.net/api/v1/accounts/:account_id/active-calls/start-recording","description":"Start recording an active call associated with a specific account.
\naccount_id (required, string): The unique identifier of the account whose active call you want to record.channel_id (required, string): The identifier of the channel associated with the active call to record, e.g. PJSIP/external-kamailio/200029992.Returns a 200 with:
\nmessage (string): Confirmation message.data.channel_id (string): The channel that started recording.(string): The identifier for the communication channel, formatted as PJSIP/external-kamailio/{number}
\n","type":"text/plain"},"key":"channel_id","value":""}],"variable":[{"id":"16c9a795-6eb2-455c-93ad-80f0d45e44e4","description":{"content":"(string): The unique identifier of the account whose active call you want to park
\n","type":"text/plain"},"type":"any","value":"","key":"account_id"}]}},"response":[{"id":"082fcb7c-412d-4cb3-817e-5c0e74212db7","name":"200 OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://qvara.net/api/v1/accounts/:account_id/active-calls/start-recording?channel_id=PJSIP/external-kamailio/200029992","host":["https://qvara.net/api/v1"],"path":["accounts",":account_id","active-calls","start-recording"],"query":[{"key":"channel_id","value":"PJSIP/external-kamailio/200029992"}],"variable":[{"key":"account_id","value":"9e3c95b1-0bf6-4345-8ad0-83e9a5c613df"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 30 Jun 2025 19:36:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Call recording started!\",\n \"data\": {\n \"channel_id\": \"PJSIP/external-kamailio/200029992\"\n }\n}"}],"_postman_id":"b0641b8f-65ec-4855-ae12-49d7f2ca6663"},{"name":"Stop Recording","id":"16f665fa-a00b-448f-b277-a0de95431964","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://qvara.net/api/v1/accounts/:account_id/active-calls/stop-recording","description":"Stop recording an active call associated with a specific account.
\naccount_id (required, string): The unique identifier of the account whose active call recording you want to stop.channel_id (required, string): The identifier of the channel associated with the active call to stop recording, e.g. PJSIP/external-kamailio/200029992.Returns a 200 with:
\nmessage (string): Confirmation message.data.channel_id (string): The channel that stopped recording.(string): The identifier for the communication channel, formatted as PJSIP/external-kamailio/{number}
\n","type":"text/plain"},"key":"channel_id","value":""}],"variable":[{"id":"f376fc20-e4d8-4f24-8972-2ec49b405a7c","description":{"content":"(string): The unique identifier of the account whose active call you want to park
\n","type":"text/plain"},"type":"any","value":"","key":"account_id"}]}},"response":[{"id":"46315260-3e75-4617-a69d-9cc1ba36d593","name":"200 OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://qvara.net/api/v1/accounts/:account_id/active-calls/stop-recording?channel_id=PJSIP/external-kamailio/200029992","host":["https://qvara.net/api/v1"],"path":["accounts",":account_id","active-calls","stop-recording"],"query":[{"key":"channel_id","value":"PJSIP/external-kamailio/200029992","description":"(string): The identifier for the communication channel, formatted as PJSIP/external-kamailio/{number}"}],"variable":[{"key":"account_id","value":"9e3c95b1-0bf6-4345-8ad0-83e9a5c613df","description":"(string): The unique identifier of the account whose active call you want to park"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.3.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 30 Jun 2025 19:36:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Call recording stopped!\",\n \"data\": {\n \"channel_id\": \"PJSIP/external-kamailio/200029992\"\n }\n}"}],"_postman_id":"16f665fa-a00b-448f-b277-a0de95431964"}],"id":"90a9cc65-f318-4328-8535-cda5c29a54df","_postman_id":"90a9cc65-f318-4328-8535-cda5c29a54df","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"35a295d4-1bba-45da-a0ae-e9335d271dc4","id":"35a295d4-1bba-45da-a0ae-e9335d271dc4","name":"Qvara API v1","type":"collection"}}},{"name":"Call Detail Records","item":[{"name":"Search Calls by Account","event":[{"script":{"packages":[],"exec":[""],"type":"text/javascript","id":"74a84569-0f9b-49bd-8a09-fc91928c9f68"},"listen":"test"}],"id":"6fc1db24-2c12-4b8c-b3c7-2073c73635d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://qvara.net/api/v1/accounts/:account_id/call-detail-records","description":"Retrieve a paginated list of call detail records (CDRs) for a specific account, newest first.
\npage (optional, integer): The page of results to retrieve. Defaults to page 1, 100 records per page.Returns a 200 with:
\ncurrent_page (integer): The current page number.data (array): The call detail records for this page, each with:id (integer): The unique identifier of the call.direction (string): inbound or outbound.cid_name (string): The caller ID name.cid_num (string): The caller ID number.number_dialed (string): The number that was dialed.duration (integer): Call duration in seconds.recorded (boolean): Whether the call was recorded.did_description (string): A label for the DID/number that received the call.cid_prefix (string): Any prefix applied to the caller ID.flagged (boolean): Whether the call has been flagged for review.severity (integer or null): The severity rating assigned to the call, 1-5.notes (string or null): Notes left on the call.transcription (string or null): The AI-generated transcript of the call.went_to_voicemail (boolean): Whether the call went to voicemail.spoke_to_extension (boolean): Whether the call was answered by an extension.cdr_tags (string or null): Tags applied to this call's CDR.sentiment_positive (integer): Positive sentiment score.sentiment_negative (integer): Negative sentiment score.sentiment_analysis (string or null): Raw per-utterance sentiment analysis, as a JSON string.summary (string or null): The AI-generated summary of the call.rawEvents (array): The raw dialplan event log for this call.parsedEvents (array): The event log rendered for display, each entry with time, event (a human-readable label), and info (a string, array of strings, or null).from (integer): The starting record number for this page.per_page (integer): The number of records per page.to (integer): The ending record number for this page.total (integer): The total number of matching records.Retrieve the full details of a single call detail record (CDR) for a specific account, including its transcription, sentiment analysis, summary, and call event history.
\naccount_id (required, string): The unique identifier of the account.call_id (required, integer): The unique identifier of the call detail record.Returns a 200 with:
\nid (integer): The unique identifier of the call.direction (string): inbound or outbound.cid_name (string): The caller ID name.cid_num (string): The caller ID number.number_dialed (string): The number that was dialed.duration (integer): Call duration in seconds.recorded (boolean): Whether the call was recorded.did_description (string): A label for the DID/number that received the call.cid_prefix (string): Any prefix applied to the caller ID.flagged (boolean): Whether the call has been flagged for review.severity (integer or null): The severity rating assigned to the call, 1-5.notes (string or null): Notes left on the call.transcription (string or null): The AI-generated transcript of the call.went_to_voicemail (boolean): Whether the call went to voicemail.spoke_to_extension (boolean): Whether the call was answered by an extension.cdr_tags (string or null): Tags applied to this call's CDR.sentiment_positive (integer): Positive sentiment score.sentiment_negative (integer): Negative sentiment score.sentiment_analysis (string or null): Raw per-utterance sentiment analysis, as a JSON string.summary (string or null): The AI-generated summary of the call.created_at (string): Timestamp when the call started.rawEvents (array): The raw dialplan event log for this call.parsedEvents (array): The event log rendered for display, each entry with time, event (a human-readable label), and info (a string, array of strings, or null).Update the flagged status, severity rating, or notes on a call detail record.
\nflagged (optional, boolean): Flag the call for future review.severity (optional, integer): A severity rating for the call, from 1 to 5.notes (optional, string): Free-text notes about the call.Returns a 200 with:
\nmessage (string): Confirmation that the call detail record was updated.data (object): The updated call detail record, with the same fields as the Show Call Details response (id, direction, cid_name, cid_num, number_dialed, duration, recorded, did_description, cid_prefix, flagged, severity, notes, transcription, went_to_voicemail, spoke_to_extension, cdr_tags, sentiment_positive, sentiment_negative, sentiment_analysis, summary, created_at, rawEvents, parsedEvents).Retrieve the star codes (feature codes) available to a specific account, including any codes the account has customized away from the system defaults.
\naccount_id (required, string): The unique identifier of the account.Returns a 200 with an object keyed by star code identifier (e.g. echo-test, call-fwd), each entry containing:
label (string): A human-readable name for the star code.code (string): The digits dialed to trigger this feature. Reflects the account's custom code if one has been configured, otherwise the system default.Retrieve the call parking lots belonging to a specific account.
\naccount_id (required, string): The unique identifier of the account whose call parking lots are being requested.Returns a 200 with a JSON array of call parking lot objects:
\nid (string): The call parking lot's unique identifier.label (string): The call parking lot's display name.description (string, nullable): An optional description.slots (integer): The number of parking slots/spaces available in this lot.Retrieve the full details of a single call parking lot.
\ncall_parking_lot_id (required, string): The unique identifier of the call parking lot to retrieve.Returns a 200 with:
\nid (string): The call parking lot's unique identifier.label (string): The call parking lot's display name.description (string, nullable): An optional description.notes (string, nullable): Internal notes about the call parking lot.slots (integer): The number of parking slots/spaces available in this lot.timeout_seconds (integer): How long a call may sit parked before it's routed to the lot's timeout destination.cdr_tags (string, nullable): CDR tag(s) applied to calls that pass through this parking lot.album_id (string, nullable): The ID of the hold-music album played to parked callers, if one is set.webhook_id (string, nullable): The ID of the webhook that fires for this parking lot's events, if one is configured.created_at / updated_at (string): Timestamps.ext_number (string, nullable): The extension number used to dial into this parking lot.Retrieve the current live occupancy of each parking slot in a call parking lot.
\ncall_parking_lot_id (required, string): The unique identifier of the call parking lot whose slots are being requested.Returns a 200 with a JSON object keyed by each slot's extension number. The value is null if the slot is empty, or an object describing the parked call if occupied:
cid_name (string): The parked caller's caller ID name.cid_number (string): The parked caller's caller ID number.Retrieve all call queues belonging to an account.
\naccount_id (string, required): The unique identifier of the account whose call queues you want to list.Returns a 200 with an array of call queue objects:
\nid (string): The unique identifier of the call queue.label (string, nullable): The call queue's display name.created_at (string, datetime)updated_at (string, datetime)ext_number (string, nullable): The extension number assigned to the queue.extensions_count (integer): The number of agent extensions assigned to the queue.(string): The unique identifier of the account whose active call you want to park
\n","type":"text/plain"},"type":"any","value":"","key":"account_id"}]}},"response":[{"id":"1551d83a-8979-4ea0-e002-738137841c06","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://qvara.net/api/v1/accounts/:account_id/call-queues","host":["https://qvara.net/api/v1"],"path":["accounts",":account_id","call-queues"],"variable":[{"id":"3072f0f2-74dd-48ee-980b-178752c8bdbb","key":"account_id","value":"","description":"(string): The unique identifier of the account whose active call you want to park"}]},"description":"Retrieve all call queues belonging to an account.\n\n#### Path Variables\n- `account_id` (string, required): The unique identifier of the account whose call queues you want to list.\n\n#### Response\nReturns a 200 with an array of call queue objects:\n- `id` (string): The unique identifier of the call queue.\n- `label` (string, nullable): The call queue's display name.\n- `created_at` (string, datetime)\n- `updated_at` (string, datetime)\n- `ext_number` (string, nullable): The extension number assigned to the queue.\n- `extensions_count` (integer): The number of agent extensions assigned to the queue."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"a02f4faa-b48a-4c77-af99-b243377e201f\",\n \"label\": \"Sales Queue\",\n \"created_at\": \"2025-03-07T20:46:51.000000Z\",\n \"updated_at\": \"2025-06-06T18:19:16.000000Z\",\n \"ext_number\": \"1001\",\n \"extensions_count\": 4\n },\n {\n \"id\": \"b13f5faa-c48a-4c77-af99-b243377e2020\",\n \"label\": \"Support Queue\",\n \"created_at\": \"2025-04-02T14:12:03.000000Z\",\n \"updated_at\": \"2025-06-01T09:45:22.000000Z\",\n \"ext_number\": \"1002\",\n \"extensions_count\": 6\n }\n]"},{"id":"28561125-e6a0-0b7b-6c68-c0b4075002ff","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://qvara.net/api/v1/accounts/:account_id/call-queues","host":["https://qvara.net/api/v1"],"path":["accounts",":account_id","call-queues"],"variable":[{"id":"3072f0f2-74dd-48ee-980b-178752c8bdbb","key":"account_id","value":"","description":"(string): The unique identifier of the account whose active call you want to park"}]},"description":"Retrieve all call queues belonging to an account.\n\n#### Path Variables\n- `account_id` (string, required): The unique identifier of the account whose call queues you want to list.\n\n#### Response\nReturns a 200 with an array of call queue objects:\n- `id` (string): The unique identifier of the call queue.\n- `label` (string, nullable): The call queue's display name.\n- `created_at` (string, datetime)\n- `updated_at` (string, datetime)\n- `ext_number` (string, nullable): The extension number assigned to the queue.\n- `extensions_count` (integer): The number of agent extensions assigned to the queue."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"a02f4faa-b48a-4c77-af99-b243377e201f\",\n \"label\": \"Sales Queue\",\n \"created_at\": \"2025-03-07T20:46:51.000000Z\",\n \"updated_at\": \"2025-06-06T18:19:16.000000Z\",\n \"ext_number\": \"1001\",\n \"extensions_count\": 4\n },\n {\n \"id\": \"b13f5faa-c48a-4c77-af99-b243377e2020\",\n \"label\": \"Support Queue\",\n \"created_at\": \"2025-04-02T14:12:03.000000Z\",\n \"updated_at\": \"2025-06-01T09:45:22.000000Z\",\n \"ext_number\": \"1002\",\n \"extensions_count\": 6\n }\n]"}],"_postman_id":"ee4d69aa-c330-480a-897f-ee6630a071bf"},{"name":"Read Call Queue","id":"a40f8d9d-6bcc-4969-b30a-4c5d0bf35ea5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://qvara.net/api/v1/call-queues/:call_queue_id","description":"Retrieve the full configuration for a single call queue, including its assigned agent extensions.
\ncall_queue_id (string, required): The unique identifier of the call queue to retrieve.Returns a 200 with the call queue object:
\nid (string)account_id (string)label (string, nullable)description (string, nullable)notes (string, nullable)skip_busy (boolean): Skip agents currently on another call.auto_logout (boolean): Automatically log agents out after a missed call.record_calls (boolean)enable_callback (boolean)require_callback_name (boolean)announce_position (boolean)disable_voicemail (boolean)wrap_up_time (integer): Seconds an agent is paused after finishing a call.agent_ring_seconds (integer): Seconds a given agent rings before moving on.timeout_enum (string): One of infinite, dynamic, limited.total_ring_seconds (integer)ring_strategy_enum (string): One of all, least-recent, fewest-calls, random, ordered, round-robin.ring_mode (string)album_id (integer, nullable): Hold-music album, if configured.announcement_interval_seconds (integer)recording_id (integer, nullable)cdr_tags (string, nullable)cid_prefix (string, nullable)webhook_id (integer, nullable)automation_id (integer, nullable)ringtone_enum (string, nullable)created_at (string, datetime)updated_at (string, datetime)deleted_at (string, nullable)ext_number (string, nullable): The queue's assigned extension number.extensions (array): Agents assigned to this queue, each with:id (string)label (string, nullable)ext_number (string, nullable)priority (integer): The agent's ring priority within the queue.logged_in (boolean): Whether the agent is currently logged into this queue.Log an extension into a call queue as an available agent, and fire the queue's agent-logged-in webhook event, if configured.
call_queue_id (string, required): The unique identifier of the call queue.extension_id (string, required): The unique identifier of the extension to log in.Returns a 200 with:
\nmessage (string)callQueue (object): id, label, ext_number.extension (object): id, label, ext_number.Returns a 400 if the call queue does not have an extension number assigned:
\nerror (string)Log an extension out of a call queue so it stops receiving queue calls, and fire the queue's agent-logged-out webhook event, if configured.
call_queue_id (string, required): The unique identifier of the call queue.extension_id (string, required): The unique identifier of the extension to log out.Returns a 200 with:
\nmessage (string)callQueue (object): id, label, ext_number.extension (object): id, label, ext_number.Returns a 400 if the call queue does not have an extension number assigned:
\nerror (string)Retrieve real-time agent status and queue statistics for a call queue, sourced from the realtime PBX server via Redis.
\ncall_queue_id (string, required): The unique identifier of the call queue.Returns a 200 with:
\ndatetime (string): Current server time in the account's timezone.success (boolean): Whether the realtime data could be retrieved.stats (object): Queue-wide statistics:num_callers_waiting (string)avg_hold_time (string): Formatted as MMm SSs.avg_talk_time (string): Formatted as MMm SSs.longest_hold_time (string): Formatted as MMm SSs.num_calls_answered (string)num_calls_abandoned (string)agents (object): Keyed by extension number, each value:label (string)extension_id (string)num_calls_answered (string)last_call_timestamp (string, nullable)status (string): One of offline, available, in_call, ringing, in_call_ringing, holding.logged_in (boolean)pivot_priority (integer): The agent's ring priority in this queue.pivot_logged_in (boolean): Whether the agent is currently logged into this queue.Retrieve the calls currently waiting in a call queue, sourced in real time from the realtime PBX server.
\ncall_queue_id (string, required): The unique identifier of the call queue.Returns a 200 with:
\ndatetime (string): Current server time in the account's timezone.success (boolean): Whether the realtime data could be retrieved.calls (object): Keyed by channel, each value:position (integer): The caller's position in the queue.caller_name (string, nullable)phone_number (string): Formatted caller phone number.wait_time (string): Formatted as MMm SSs.Retrieve all phone numbers accessible to the authenticated reseller's API key (scoped to that key's assigned accounts, if any are configured).
\nReturns a 200 with:
\ndata (array): A list of phone number objects, each with:id (string)account_id (string)phone_number (string)label (string, nullable): Always null on this endpoint (see note below).description (string, nullable): Always null on this endpoint (see note below).notes (string, nullable): Always null on this endpoint (see note below).usage_enum (string, nullable): Always null on this endpoint (see note below).Retrieve the full configuration for a single phone number.
\nphone_number_id (string, required): The unique identifier of the phone number to retrieve.Returns a 200 with:
\ndata (object): The phone number, with:id (string)account_id (string)phone_number (string)label (string, nullable)description (string, nullable)notes (string, nullable)caller_id (string, nullable)is_routable (boolean)is_e911_enabled (boolean)has_pending_cnam_order (boolean)usage_enum (string): e.g. voice, fax.fax_usage_enum (string, nullable)fax_receive_via_enum (string, nullable)anonymize_cid (boolean)hide_cid_from_reports (boolean)cid_prefix (string, nullable)record_inbound_calls (boolean)transcribe_inbound_calls (boolean)record_outbound_calls (boolean)transcribe_outbound_calls (boolean)cid_fetch_url (string, nullable)cid_fetch_custom_header_name (string, nullable)cid_fetch_custom_header_value (string, nullable)cid_fetch_json_field (string, nullable)sms_auto_response_enabled (boolean)sms_auto_response_text (string, nullable)sms_auto_response_limit_days (integer)fax_cover_page_enabled (boolean)fax_cover_page_settings (array)created_at (string, datetime)updated_at (string, datetime)Retrieve all phone numbers belonging to an account.
\naccount_id (string, required): The unique identifier of the account whose phone numbers you want to list.Returns a 200 with:
\ndata (array): A list of phone number objects, each with:id (string)account_id (string)phone_number (string)label (string, nullable)description (string, nullable)notes (string, nullable)usage_enum (string)Search for available phone numbers to purchase, matching optional filter criteria.
\niso (string, optional): The country ISO code to search within. Must be one of US or CA -- only these are currently queryable via the API.rate_center (string, optional): Filter by rate center name.city (string, optional): Filter by city name.state (string, optional): Two-letter state abbreviation.area_code (numeric string, optional): Three-digit area code to search within.toll_free (boolean, optional): When true, only returns toll-free numbers.vanity (string, optional): A vanity pattern to match against available numbers (e.g. BE5T).Returns a 200 with:
\ncount (integer): Total number of matching results found by the carrier.results (array): A list of available phone numbers, each with:phone_number (string)rate_center (string)city (string)state (string)iso (string)carrier_enum (string): The carrier the number is sourced from, e.g. bandwidth, telnyx.string - Only US and CA are currently queryable via the API.
\n","type":"text/plain"},"key":"iso","value":""},{"disabled":true,"key":"rate_center","value":""},{"disabled":true,"key":"area_code","value":""},{"disabled":true,"key":"toll_free","value":""},{"disabled":true,"key":"vanity","value":""}],"variable":[]}},"response":[{"id":"49e03efc-f8dc-4bd3-bf1a-a0c9f57fba15","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://qvara.net/api/v1/phone-number-purchasing/available?iso=US&vanity=BE5T","host":["https://qvara.net/api/v1"],"path":["phone-number-purchasing","available"],"query":[{"key":"iso","value":"US","description":"string - Only US and CA are currently queryable via the API."},{"key":"rate_center","value":"saint louis","disabled":true},{"key":"area_code","value":"865","disabled":true},{"key":"toll_free","value":"true","disabled":true},{"key":"vanity","value":"BE5T"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"localhost:8000","key":"Host"},{"value":"close","key":"Connection"},{"value":"PHP/8.3.13","key":"X-Powered-By"},{"value":"no-cache, private","key":"Cache-Control"},{"value":"Tue, 01 Jul 2025 16:49:57 GMT","key":"Date"},{"value":"application/json","key":"Content-Type"},{"value":"*","key":"Access-Control-Allow-Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"results\": [\n {\n \"phone_number\": \"18655551000\",\n \"rate_center\": \"KNOXVILLE\",\n \"city\": \"KNOXVILLE\",\n \"state\": \"TN\",\n \"iso\": \"US\",\n \"carrier_enum\": \"bandwidth\"\n },\n {\n \"phone_number\": \"18655551017\",\n \"rate_center\": \"KNOXVILLE\",\n \"city\": \"KNOXVILLE\",\n \"state\": \"TN\",\n \"iso\": \"US\",\n \"carrier_enum\": \"telnyx\"\n }\n ]\n}"}],"_postman_id":"c7e582b5-36dd-4f91-8c86-d28343d0bb44"},{"name":"Order Phone Numbers","id":"81b3f499-ac87-4195-8e44-b0b82356905e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"phone_numbers\": [\n {\n \"phone_number\": \"15555551234\",\n \"carrier_enum\": \"bandwidth\"\n }\n ],\n \"account_id\": \"9e3c95b1-0bf6-4345-8ad0-83e9a5c613df\"\n}"},"url":"https://qvara.net/api/v1/phone-number-purchasing/order","description":"Order one or more available phone numbers for purchase from the specified carrier(s).
\nphone_numbers (required, array): The numbers to order, each an object with:phone_number (required, string): The number to order, e.g. 15559876543.carrier_enum (required, string): The carrier to order the number from. Must be one of bandwidth or telnyx.account_id (optional, string): The unique identifier of the account to assign the purchased numbers to. Must be one of the accounts accessible to the API key. If omitted, the numbers are ordered without being assigned to an account.Returns a 200 with an array of order results, one per requested number:
\nphone_number (string)carrier_enum (string)status (string): success or failed.error (string, present only when status is failed): The carrier's error message.Retrieve all extensions belonging to an account.
\naccount_id (string, required): The unique identifier of the account whose extensions you want to list.Returns a 200 with:
\ndata (array): A list of extension objects, each with:id (string)label (string, nullable)description (string, nullable)notes (string, nullable)created_at (string, datetime)updated_at (string, datetime)Retrieve the full configuration for a single extension.
\nextension_id (string, required): The unique identifier of the extension to retrieve.Returns a 200 with:
\ndata (object): The extension, with:id (string)label (string, nullable)description (string, nullable)notes (string, nullable)created_at (string, datetime)updated_at (string, datetime)account_id (string)audio_codec_enum (string, nullable)audio_pitch_shift_rx (integer, nullable)audio_pitch_shift_tx (integer, nullable)extension_id (integer, nullable): Internal numeric extension record reference, distinct from id.billing_enum (string, nullable)call_confirmation_enum (string, nullable)call_forwarding_enabled (boolean)cdr_tags (string, nullable)iso (string, nullable)dialout_prefix (string, nullable)do_not_ring (boolean)outbound_dialing_enabled (boolean)record_inbound_calls (boolean)record_outbound_calls (boolean)ring_time (integer)sip_password (string)timezone (string, nullable)transcribe_inbound_calls (boolean)transcribe_outbound_calls (boolean)video_enabled (boolean)vm_allow_message_leaving (boolean)vm_can_change_greeting (boolean)vm_can_transfer_messages (boolean)vm_delete_after_emailed (boolean)vm_dnd_start_time (string, nullable)vm_dnd_end_time (string, nullable)vm_enabled (boolean)vm_force_notify (boolean)vm_greet_enabled (boolean)vm_outside_connect_attempt (boolean)vm_outside_connect_cid (string, nullable)vm_authorization_pin (string, nullable)vm_pin_required_remote (boolean)vm_pin_required_self (boolean)vm_play_box_name_upon_entry (boolean)vm_play_box_number_upon_entry (boolean)vm_play_callerid (boolean)vm_play_timestamp (boolean)vm_require_callback_number (boolean)international_calling_enabled (boolean)listen_enabled (boolean)whisper_enabled (boolean)barge_enabled (boolean)vm_has_temporary_greeting (boolean)vm_has_standard_greeting (boolean)vm_has_name_greeting (boolean)emergency_phone_number_id (string, nullable)outbound_phone_number_id (string, nullable)automation_id (integer, nullable)recording_id (integer, nullable)album_id (integer, nullable)webhook_id (integer, nullable)Retrieve the dynamic caller IDs configured for an extension -- phone numbers the extension can dynamically use as outbound caller ID.
\nextension_id (string, required): The unique identifier of the extension.Returns a 200 with:
\ndata (array): A list of dynamic caller ID objects, each with:id (string)extension_id (string)phone_number_id (string)phoneNumber (object): The associated phone number record (see Phone Numbers > Read Phone Number for its full field list).digits (string, nullable): The dial pattern that triggers this caller ID.is_active (boolean)created_at (string, datetime)updated_at (string, datetime)Retrieve real-time SIP registration/call status for every extension (and its clones/web dialer) on an account, for use by the extension monitor dashboard.
\naccount_id (string, required): The unique identifier of the account.Returns a 200 with:
\ndatetime (string): Current server time in the account's timezone.monitored_extensions (object): Keyed by extension ID, each value:ext_number (string)username (string): The extension's SIP username.label (string, nullable)latency (integer): Milliseconds; 0 if not currently registered.lastCheckin (string, nullable)call (object): Active call info, if any (empty object when there is no active call).clones (object): Keyed by extension clone ID, each with username, label, latency, lastCheckin, call.webDialer (object, nullable): username, label, latency, lastCheckin, call.online (integer): Number of extensions (or clones) currently showing latency.offline (integer): Number of extensions with no latency.calls (integer): Number of extensions currently on a call.success (boolean): Whether the realtime server could be reached.Retrieve a point-in-time snapshot of SIP registration details (IP addresses, transport, user agent, latency) for every extension, clone, and web dialer on an account, sourced from the customer SIP servers.
\naccount_id (string, required): The unique identifier of the account.Returns a 200 with:
\nconnected (boolean): Whether the SIP servers could be reached.message (string): success, or Realtime server currently unavailable.extensions (object): Keyed by SIP username, each value:ext_number (string)label (string, nullable)private_ip (string, nullable)public_ip (string, nullable)transport (string): e.g. udp, tcp, ws.sip_proxy (string, nullable)user_agent (string, nullable)latency (integer): Round-trip time in milliseconds.last_checkin (string, nullable): Human-readable relative time.extension_id (string, nullable)extension_clone_id (string, nullable)List all automations belonging to an account.
\naccount_id (string, required): The ID of the account to list automations for.Returns a 200 with:
\ndata (array): List of automations, each including:id (string): The unique identifier of the automation.label (string, nullable): The automation's label.description (string, nullable): A description of the automation.notes (string, nullable): Additional notes.authorization_pin (string, nullable): PIN required to trigger the automation by phone.ext_number (string, nullable): The extension number used to reach this automation.created_at (string): Creation timestamp.updated_at (string): Last update timestamp.account_id (string): The account this automation belongs to.webhook_id (string, nullable): The webhook fired when the automation runs.automation_action_ids (array of strings): IDs of this automation's actions.automation_one_time_run_ids (array of strings): IDs of scheduled one-time runs.automation_recurring_run_ids (array of strings): IDs of scheduled recurring runs.count (integer): Total number of automations returned.Create a new automation for a specified account.
\nlabel (optional, string, max 64 chars): The label for the automation.description (optional, string, max 255 chars): A brief description of the automation.notes (optional, string, max 1024 chars): Additional notes related to the automation.webhook_id (optional, string): The ID of a webhook belonging to this account to fire when the automation runs.authorization_pin (optional, numeric, up to 5 digits): A PIN required to trigger the automation by phone.ext_number (optional, numeric, 1-5 digits): An extension number used to reach this automation; must be unique within the account.Returns a 201 with:
\nmessage (string): Confirmation message.data (object): The created automation:id (string): The unique identifier of the automation.label (string, nullable): The automation's label.description (string, nullable): A description of the automation.notes (string, nullable): Additional notes.authorization_pin (string, nullable): PIN required to trigger the automation by phone.ext_number (string, nullable): The extension number used to reach this automation.created_at (string): Creation timestamp.updated_at (string): Last update timestamp.account_id (string): The account this automation belongs to.webhook_id (string, nullable): The webhook fired when the automation runs.automation_action_ids (array of strings): IDs of this automation's actions.automation_one_time_run_ids (array of strings): IDs of scheduled one-time runs.automation_recurring_run_ids (array of strings): IDs of scheduled recurring runs.Retrieve a single automation by ID.
\nautomation_id (string, required): The ID of the automation to retrieve.Returns a 200 with:
\ndata (object): The automation:id (string): The unique identifier of the automation.label (string, nullable): The automation's label.description (string, nullable): A description of the automation.notes (string, nullable): Additional notes.authorization_pin (string, nullable): PIN required to trigger the automation by phone.ext_number (string, nullable): The extension number used to reach this automation.created_at (string): Creation timestamp.updated_at (string): Last update timestamp.account_id (string): The account this automation belongs to.webhook_id (string, nullable): The webhook fired when the automation runs.automation_action_ids (array of strings): IDs of this automation's actions.automation_one_time_run_ids (array of strings): IDs of scheduled one-time runs.automation_recurring_run_ids (array of strings): IDs of scheduled recurring runs.Queue an immediate run of an automation's actions, in priority order. Takes no request body - the automation's saved actions are executed as-is.
\nautomation_id (string, required): The ID of the automation to run.Returns a 200 with:
\nmessage (string): Confirmation the run was queued.automation (object): The automation that was run (see [Automations > Read Automation] for field details).Soft-delete an automation. It can be brought back later via the restore endpoint.
\nautomation_id (string, required): The ID of the automation to delete.Returns a 200 with:
\nmessage (string): Confirmation message.Restore a previously soft-deleted automation.
\nautomation_id (string, required): The ID of the automation to restore.Returns a 200 with:
\nmessage (string): Confirmation message.List all actions belonging to an automation, in priority order.
\nautomation_id (string, required): The ID of the automation whose actions to list.Returns a 200 with:
\ndata (array): List of automation actions, each including:id (string): The unique identifier of the action.automation_id (string): The automation this action belongs to.priority (integer): The order in which this action runs relative to its siblings.label (string, nullable): The action's label.type_enum (string, nullable): The type of action; see Enums > Automation Actions: Types.two_way_toggle_is_enabled (boolean): Target state for a two-way-toggle-state action.email (string, nullable): Recipient email for an email action.message (string, nullable): The message body for email/sms actions.two_way_toggle_id (string, nullable): The two-way toggle acted on.multiway_toggle_destination_id (string, nullable): The multiway toggle destination selected.dynamic_caller_id_id (string, nullable): The dynamic caller ID selected.sms_phone_number_id (string, nullable): The phone number an sms action sends from.sms_recipient_phone_number (string, nullable): The recipient of an sms action.call_queue_id (string, nullable): The call queue logged into/out of.extension_id (string, nullable): The extension logged into/out of the call queue.created_at (string): Creation timestamp.updated_at (string): Last update timestamp.count (integer): Total number of actions returned.Add a new action to a specified automation.
\nlabel (optional, string, max 64 chars): A label for the action.type_enum (required, string): The type of action to perform; see Enums > Automation Actions: Types.email (string, required if type_enum is email): Email address to send a message to.sms_phone_number_id (string, required if type_enum is sms): Identifier for the phone number to text from; see Phone Numbers > Search Phone Numbers.sms_destination_type (string, optional, caller or static): For sms actions, whether to text the caller or a fixed recipient.sms_recipient_phone_number (string, optional): Full phone number of the SMS recipient, used only when sms_destination_type is static; cleared otherwise.iso (string, optional): Two-letter ISO country code used to interpret sms_recipient_phone_number when it isn't already in E.164 format.message (string, required if type_enum is email or sms, max 1024 chars): Plaintext message to send.two_way_toggle_id (string, required if type_enum is two-way-toggle-state): Identifier for the two-way toggle; see Accounts > Search Two-Way Toggles.two_way_toggle_is_enabled (boolean, required if type_enum is two-way-toggle-state): Whether the two-way toggle should become enabled or disabled.multiway_toggle_destination_id (string, required if type_enum is multiway-toggle-dest): Identifier for the destination of the multiway toggle; see Accounts > Search Multiway Toggles.extension_id (string, required if type_enum is call-queue-login or call-queue-logout): Identifier for the extension; see Extensions > Search Extensions by Account.dynamic_caller_id_id (string, required if type_enum is dynamic-caller-id): Identifier for the dynamic caller ID; see Extensions > Search Dynamic CallerIDs.call_queue_id (string, required if type_enum is call-queue-login or call-queue-logout): Identifier for the call queue; see Accounts > Search Call Queues.Returns a 201 with:
\nmessage (string): Confirmation message.data (object): The created action, with the same fields as [Automation Actions > Search Actions] (id, automation_id, priority, label, type_enum, two_way_toggle_is_enabled, email, message, two_way_toggle_id, multiway_toggle_destination_id, dynamic_caller_id_id, sms_phone_number_id, sms_recipient_phone_number, call_queue_id, extension_id, created_at, updated_at).List all inbound faxes received on a phone number.
\nphone_number_id (string, required): The ID of the phone number to list inbound faxes for.Returns a 200 with:
\ndata (array): List of inbound faxes, each including:id (string): The unique identifier of the inbound fax.phone_number_id (string): The phone number the fax was received on.read_at (string, nullable): When the fax was marked read.cid_name (string, nullable): Caller ID name of the sender.cid_phone_number (string): Caller ID phone number of the sender.pages (integer): Number of pages received.received (string): Timestamp the fax was received.download_url (string): URL to download the fax as a PDF.Download a specific inbound fax as a PDF file.
\ninbound_fax_id (string, required): The ID of the inbound fax to download.Returns a 200 with the raw PDF file content (Content-Type: application/pdf). There is no JSON body.
Send an outbound fax from a phone number to a recipient number, using a publicly-accessible file as the fax content.
\nrecipient_phone_number (required, numeric string): The destination fax number, digits only, without a leading country code.iso (required, string): Two-letter ISO country code of the destination number, used to interpret the digit count; only countries that support fax forwarding are permitted.file_url (required, string): A publicly-reachable URL of the file to fax; it's downloaded server-side and converted into a fax.subject (optional, string, max 128 chars): A subject line for the fax.Returns a 200 with:
\nmessage (string): Confirmation the fax was queued.data (object):id (string): The unique identifier of the outbound fax.phone_number_id (string): The phone number the fax is being sent from.subject (string): The fax's subject line.recipient_phone_number (string): The full, normalized destination number.status (string): The initial status of the fax (Preparing to Send).pages (integer): Number of pages in the fax.download_url (string): URL to download the source file.date_created (string): Timestamp the fax was queued.Retrieve a single outbound fax by ID.
\noutbound_fax_id (string, required): The ID of the outbound fax to retrieve.Returns a 200 with:
\ndata (object):id (string): The unique identifier of the outbound fax.phone_number_id (string): The phone number the fax was sent from.recipient_phone_number (string): The destination number.subject (string, nullable): The fax's subject line.started_at (string, nullable): When transmission started.completed_at (string, nullable): When transmission completed.pages (integer): Number of pages.status_enum (string): The current status, as an enum key (e.g. preparing, dialing, transmitting, retrying-line-busy, completed, failed, cancelled).status_formatted (string): The current status, human-readable (e.g. Preparing to Send).retries (integer): Number of retry attempts so far.last_retried_at (string, nullable): When the last retry occurred.last_retry_error (string, nullable): Error message from the last retry, if any.List all outbound faxes sent (or queued to be sent) from a phone number.
\nphone_number_id (string, required): The ID of the phone number to list outbound faxes for.Returns a 200 with:
\ndata (array): List of outbound faxes, each including:id (string): The unique identifier of the outbound fax.phone_number_id (string): The phone number the fax was sent from.recipient_phone_number (string): The destination number.subject (string, nullable): The fax's subject line.started_at (string, nullable): When transmission started.completed_at (string, nullable): When transmission completed.pages (integer): Number of pages.status_enum (string): The current status, as an enum key.status_formatted (string): The current status, human-readable.retries (integer): Number of retry attempts so far.last_retried_at (string, nullable): When the last retry occurred.last_retry_error (string, nullable): Error message from the last retry, if any.Download a specific outbound fax as a PDF file.
\noutbound_fax_id (string, required): The ID of the outbound fax to download.Returns a 200 with the raw PDF file content (Content-Type: application/pdf). There is no JSON body.
Retrieve outbound faxes for a phone number that have completed successfully (status_enum = completed).
phone_number_id (string, required): The ID of the phone number to list sent outbound faxes for.Returns a 200 with:
\ndata (array): List of outbound faxes (see [Faxing > Search Outbound Faxes by Phone Number] for field details), each including id, phone_number_id, recipient_phone_number, subject, started_at, completed_at, pages, status_enum, status_formatted, retries, last_retried_at, last_retry_error.Retrieve outbound faxes for a phone number that have not completed successfully (status_enum is anything other than completed), including pending, in-progress, retrying, failed, and cancelled faxes.
phone_number_id (string, required): The ID of the phone number to list unsent outbound faxes for.Returns a 200 with:
\ndata (array): List of outbound faxes (see [Faxing > Search Outbound Faxes by Phone Number] for field details), each including id, phone_number_id, recipient_phone_number, subject, started_at, completed_at, pages, status_enum, status_formatted, retries, last_retried_at, last_retry_error.Cancel and delete a pending outbound fax. The fax status is set to cancelled before it is soft-deleted.
outbound_fax_id (string, required): The ID of the outbound fax to cancel.Returns a 200 with:
\nmessage (string): Confirmation message.data (object): The cancelled outbound fax, with status_enum set to cancelled and status_formatted set to Cancelled (see [Faxing > Read Outbound Fax] for the full field list).Retrieve all message threads (conversations) for a phone number.
\ndata (array): List of message threads, each including:
id (string): The unique identifier of the message thread.
phone_number_id (string): The phone number this thread belongs to.
recipient_phone_numbers (array): The other participant(s) in the thread.
messages_count (integer): Total number of messages in the thread.
is_read (boolean): Whether the thread has been read.
is_pinned (boolean): Whether the thread is pinned.
last_read_at (string or null): Timestamp the thread was last read.
latest_at (string or null): Timestamp of the most recent message.
created_at (string): The timestamp the thread was created.
Retrieve all messages belonging to a message thread, in chronological order.
\ndata (array): List of messages, each including:
id (string): The unique identifier of the message.
message_thread_id (string): The thread this message belongs to.
scheduled_at (string or null): When the message is/was scheduled to send.
timezone (string or null): Timezone used for scheduled_at.
delivered_at (string or null): When the message was delivered.
created_by (string): Who/what created the message (e.g. an extension or the API key).
inbound_number (string or null): For inbound messages, the sender's phone number.
status (string): Carrier-reported delivery status (e.g. queued, sent, delivered, undelivered, failed, received).
text (string or null): The message body.
attachment (string or null): URL of an MMS attachment, if any.
created_at (string): The timestamp the message was created.
Send a message from a phone number to one or more recipients. If to contains more than one recipient, a group message thread is created (or reused, if one already exists for that exact recipient set). The phone number must be registered for 10DLC messaging.
to (required, array of strings): Recipient phone number(s). Group limits apply (9 recipients for Bandwidth numbers, 7 for Telnyx, plus the sender).
text (required unless file_url is present, string, max 1200 characters): The message body. Messages over 10 SMS segments are rejected.
file_url (nullable, string, must be a reachable URL): URL of an MMS attachment.
message (string): Confirmation the message was sent.
lastMessage (object): The created message (see Messaging > Search Messages by Thread for field details).
Reply within an existing message thread. Registers the phone number for 10DLC messaging on first use if it isn't already.
\ntext (required unless file_url is present, string, max 1200 characters): The message body.
file_url (nullable, string, must be a reachable URL): URL of an MMS attachment.
message (string): Confirmation the message was sent.
lastMessage (object): The created message.
Retrieve all schedules belonging to the specified account.
\naccount_id (required, string): The UUID of the account whose schedules to retrieve.Returns a 200 with an array of schedule objects:
\nid (string): The schedule's UUID.account_id (string): The UUID of the account the schedule belongs to.label (string, nullable): The schedule's display name.description (string, nullable): A description of the schedule.notes (string, nullable): Internal notes about the schedule.timezone (string): The IANA timezone used to evaluate the schedule's rules.webhook_id (string, nullable): The UUID of the webhook fired on schedule events, if one is configured.created_at (string): ISO 8601 timestamp of creation.updated_at (string): ISO 8601 timestamp of last update.deleted_at (string, nullable): ISO 8601 timestamp the schedule was soft-deleted, if applicable.Retrieve a single schedule by its ID, including its weekly rules, one-time rules, and holiday overrides.
\nschedule_id (required, string): The UUID of the schedule to retrieve.Returns a 200 with:
\nid (string): The schedule's UUID.label (string, nullable): The schedule's display name.description (string, nullable): A description of the schedule.notes (string, nullable): Internal notes about the schedule.timezone (string): The IANA timezone used to evaluate the schedule's rules.account_id (string): The UUID of the account the schedule belongs to.webhook_id (string, nullable): The UUID of the webhook fired on schedule events, if configured.weeklyRules (array): The schedule's recurring weekly rules, each with id, schedule_id, label, weekday (sun-sat), start_time (H:i), end_time (H:i), cdr_tags, created_at, updated_at.oneTimeRules (array): The schedule's one-time date-range rules, each with id, schedule_id, label, start_date, end_date, cdr_tags, created_at, updated_at.holidays (array): The schedule's holiday overrides, each with id, schedule_id, holiday_id, cdr_tags, created_at, updated_at.created_at (string): ISO 8601 timestamp of creation.updated_at (string): ISO 8601 timestamp of last update.Update a schedule's weekly recurring rule. Only the fields provided are updated; omitted fields are left unchanged.
\nlabel (optional, string): A display name for the rule.weekday (optional, string): The day the rule applies to. One of sun, mon, tue, wed, thu, fri, sat.start_time (optional, string): The rule's start time, in H:i (24-hour) format.end_time (optional, string): The rule's end time, in H:i (24-hour) format.cdr_tags (optional, string): CDR tags to merge onto calls that match this rule.Returns a 200 with:
\nmessage (string): Confirmation message.scheduleWeeklyRule (object): The updated weekly rule, with id, schedule_id, label, weekday, start_time, end_time, cdr_tags, created_at, updated_at.Update a schedule's one-time date-range rule. Only the fields provided are updated; omitted fields are left unchanged.
\nlabel (optional, string): A display name for the rule.start_date (optional, string): The rule's start date/time, as an ISO 8601 timestamp.end_date (optional, string): The rule's end date/time, as an ISO 8601 timestamp. Must be after start_date.cdr_tags (optional, string): CDR tags to merge onto calls that match this rule.Returns a 200 with:
\nmessage (string): Confirmation message.scheduleWeeklyRule (object): The updated one-time rule, with id, schedule_id, label, start_date, end_date, cdr_tags, created_at, updated_at. (Note: the API returns this object under the key scheduleWeeklyRule, not scheduleOneTimeRule — see flags.)Retrieve all two-way toggles belonging to the specified account.
\naccount_id (required, string): The UUID of the account whose two-way toggles to retrieve.Returns a 200 with:
\ndata (array): The account's two-way toggles, each with id, account_id, label, description, notes, is_enabled (boolean), authorization_pin, enabled_cdr_tags, disabled_cdr_tags, dialing_address, enabled_recording_id, disabled_recording_id, webhook_id, created_at, updated_at.count (integer): The number of two-way toggles returned.Retrieve a single two-way toggle by its ID.
\ntwo_way_toggle_id (required, string): The UUID of the two-way toggle to retrieve.Returns a 200 with:
\nid (string): The two-way toggle's UUID.account_id (string): The UUID of the account it belongs to.label (string, nullable): The toggle's display name.description (string, nullable): A description of the toggle.notes (string, nullable): Internal notes.is_enabled (boolean): Whether the toggle is currently enabled.authorization_pin (string, nullable): The PIN required to change the toggle's state from a phone.enabled_cdr_tags (string, nullable): CDR tags merged onto calls while enabled.disabled_cdr_tags (string, nullable): CDR tags merged onto calls while disabled.dialing_address (string, nullable): The toggle's internal dialing address.enabled_recording_id (string, nullable): The UUID of the recording played when enabling.disabled_recording_id (string, nullable): The UUID of the recording played when disabling.webhook_id (string, nullable): The UUID of the webhook fired on state changes, if configured.created_at (string): ISO 8601 timestamp of creation.updated_at (string): ISO 8601 timestamp of last update.Enable a two-way toggle. Takes no request body.
\ntwo_way_toggle_id (required, string): The UUID of the two-way toggle to enable.Returns a 200 with:
\nmessage (string): Confirmation message.Disable a two-way toggle. Takes no request body.
\ntwo_way_toggle_id (required, string): The UUID of the two-way toggle to disable.Returns a 200 with:
\nmessage (string): Confirmation message.Search web dialers (soft phones) belonging to the authenticated reseller's users, optionally filtered by user email.
\nemail (optional, string): Filter results to a web dialer whose user's email contains this value.Returns a 200 with:
\nid (string): The web dialer's UUID.ext_number (string, nullable): The extension number assigned to the web dialer.fqdn (string): The SIP server FQDN the web dialer connects to.server (string): The WSS SIP server URL, e.g. wss://{fqdn}:8443.aor (string): The SIP address of record, e.g. sip:{username}@{fqdn}.username (string): The SIP registration username.password (string): The SIP registration password.Retrieve the SIP registration configuration for a web dialer (soft phone), for use by a WebRTC/SIP.js-based client.
\nsoft_phone_id (required, string): The UUID of the web dialer.Returns a 200 with:
\next_number (string, nullable): The extension number assigned to the web dialer.fqdn (string): The SIP server FQDN the web dialer connects to.server (string): The WSS SIP server URL, e.g. wss://{fqdn}:8443.aor (string): The SIP address of record, e.g. sip:{username}@{fqdn}.username (string): The SIP registration username.password (string): The SIP registration password.Calculate SMS segmentation details for a given message body, accounting for GSM-7 vs. Unicode encoding and any non-GSM characters (e.g. emoji). This endpoint is public and does not require authentication.
\nmessage (required, string): The SMS message text to analyze.Returns a 200 with:
\nreal_encoding_name (string): The detected encoding used to segment the message, e.g. GSM-7 or UTF-16.total_size (integer): The total size of the message, in the units used for segment calculation.message_size (integer): The size of the message content.segments_count (integer): The number of SMS segments the message will be split into.non_gsm_characters (array of strings): The characters in the message that fall outside the GSM-7 alphabet.number_of_unicode_scalars (integer): The number of Unicode scalar values in the message.number_of_characters (integer): The number of characters in the message.Returns the list of countries Qvara supports, optionally filtered to countries that support a given capability.
\nsupport (optional, string): Only return countries where this capability is enabled. One of supports_calling, supports_forwarding, supports_localizing, supports_messaging, supports_purchasing.Returns an array of country objects:
\niso (string): The ISO 3166-1 alpha-2 country code.label (string): The country's display name.supports_calling (boolean): Whether voice calling is supported for this country.supports_forwarding (boolean): Whether call forwarding is supported for this country.supports_localizing (boolean): Whether local phone numbers are available for this country.supports_messaging (boolean): Whether SMS/MMS messaging is supported for this country.supports_purchasing (boolean): Whether phone numbers can be purchased for this country.