Bevatel

Partial diff: added / removed operations, renames, and spec-info fields. Nested schema changes are not tracked yet.

8354edbchore(release): update playground, query params, and cURL snippets
  • info.descriptionCombined public API documentation for Bevatel developer services. Authentication, scopes, workspace binding, and rate limiting are enforced at APISIX. Clients authenticate with Authorization: Bearer <developerapijwt>. APISIX derives upstream context after JWT verification. → Combined public API documentation for Bevatel developer services. Clients authenticate with Authorization: Bearer <developerapijwt>. Authentication, scopes, workspace binding, and rate limiting are enforced for every request.
  • Description changedgetDeveloperAgentsActivityEvents"Private upstream path: /v1/reports/agents/activity-events." → "Returns agent login, logout, pause, and availability events for the selected filters."
  • Description changedgetDeveloperAgentsAvailabilityDetails"Returns paginated activity-event detail rows for the selected availability filters. Private upstream path: /v1/reports/agents/availability/details." → "Returns paginated agent availability event rows for the selected filters."
  • Description changedgetDeveloperAgentsAvailabilityMetrics"Returns per-agent availability metrics for the selected filters. Use /details for paginated underlying activity events. Private upstream path: /v1/reports/agents/availability/metrics." → "Returns per-agent availability metrics for the selected date/time window, queues, and agents."
  • Description changedgetDeveloperAgentsCallDispositionsDetails"Returns paginated activity-event detail rows for the selected call disposition filters. Private upstream path: /v1/reports/agents/call-dispositions/details." → "Returns paginated agent call disposition event rows for the selected filters."
  • Description changedgetDeveloperAgentsCallDispositionsMetrics"Returns per-agent call disposition metrics for the selected filters. Use /details for paginated underlying activity events. Private upstream path: /v1/reports/agents/call-dispositions/metrics." → "Returns per-agent call disposition metrics for the selected date/time window, queues, and agents."
  • Description changedgetDeveloperAgentsPausesDetails"Returns paginated activity-event detail rows for the selected pause filters. Private upstream path: /v1/reports/agents/pauses/details." → "Returns paginated agent pause event rows for the selected filters."
  • Description changedgetDeveloperAgentsPausesMetrics"Returns per-agent pause metrics for the selected filters. Use /details for paginated underlying pause activity events. Private upstream path: /v1/reports/agents/pauses/metrics." → "Returns per-agent pause metrics for the selected date/time window, queues, and agents."
  • Summary changedgetDeveloperAgentsSessionSummary"Agent session summary" → "Agent session summary metrics"
  • Description changedgetDeveloperAgentsSessionSummary"Private upstream path: /v1/reports/agents/session-summary." → "Returns agent session summary metrics for the selected date/time window, queues, and agents."
  • Summary changedgetDeveloperAnsweredByAgentsDetails"Answered calls for agent grouping" → "Answered calls by agent detailed calls"
  • Description changedgetDeveloperAnsweredByAgentsDetails"Returns paginated answered call rows for the selected agent-group filters. Rows include queuename and queuenumber. Private upstream path: /v1/reports/answered/by-agents/details." → "Returns paginated answered call rows for the selected agent grouping filters. Rows include queuename and queuenumber."
  • Summary changedgetDeveloperAnsweredByAgentsMetrics"Answered metrics grouped by agent" → "Answered calls by agent metrics"
  • Description changedgetDeveloperAnsweredByAgentsMetrics"Returns answered-call KPIs grouped by agent for the full filter period. Use /details for paginated answered call rows. Private upstream path: /v1/reports/answered/by-agents/metrics." → "Returns answered-call metrics grouped by agent for the selected date/time window, queues, and agents."
  • Summary changedgetDeveloperAnsweredByCallDurationDetails"Answered calls for call duration grouping" → "Answered calls by call duration detailed calls"
  • Description changedgetDeveloperAnsweredByCallDurationDetails"Returns paginated answered call rows for the selected call-duration filters. Rows include queuename and queuenumber. Private upstream path: /v1/reports/answered/by-call-duration/details." → "Returns paginated answered call rows for the selected call-duration grouping filters. Rows include queuename and queuenumber."
  • Summary changedgetDeveloperAnsweredByCallDurationMetrics"Answered metrics grouped by call duration" → "Answered calls by call duration metrics"
  • Description changedgetDeveloperAnsweredByCallDurationMetrics"Returns answered-call KPIs grouped by call-duration band for the full filter period. Use /details for paginated answered call rows. Private upstream path: /v1/reports/answered/by-call-duration/metrics." → "Returns answered-call metrics grouped by call-duration band for the selected date/time window, queues, and agents."
  • Summary changedgetDeveloperAnsweredByDisconnectionCausesDetails"Answered calls for disconnection cause grouping" → "Answered calls by disconnection cause detailed calls"
  • Description changedgetDeveloperAnsweredByDisconnectionCausesDetails"Returns paginated answered call rows for the selected disconnection-cause filters. Rows include queuename and queuenumber. Private upstream path: /v1/reports/answered/by-disconnection-causes/details." → "Returns paginated answered call rows for the selected disconnection-cause grouping filters. Rows include queuename and queuenumber."
  • Summary changedgetDeveloperAnsweredByDisconnectionCausesMetrics"Answered metrics grouped by disconnection cause" → "Answered calls by disconnection cause metrics"
  • Description changedgetDeveloperAnsweredByDisconnectionCausesMetrics"Returns answered-call KPIs grouped by disconnection cause for the full filter period. Use /details for paginated answered call rows. Private upstream path: /v1/reports/answered/by-disconnection-causes/metrics." → "Returns answered-call metrics grouped by disconnection cause for the selected date/time window, queues, and agents."
  • Summary changedgetDeveloperAnsweredByQueuesDetails"Answered calls for queue grouping" → "Answered calls by queue detailed calls"
  • Description changedgetDeveloperAnsweredByQueuesDetails"Returns paginated answered call rows for the selected queue-group filters. Rows omit redundant queuename / queuenumber because the metrics endpoint identifies queues. Private upstream path: /v1/reports/answered/by-queues/details." → "Returns paginated answered call rows for the selected queue grouping filters. Queue identity is provided by the selected grouping."
  • Summary changedgetDeveloperAnsweredByQueuesMetrics"Answered metrics grouped by queue" → "Answered calls by queue metrics"
  • Description changedgetDeveloperAnsweredByQueuesMetrics"Returns answered-call KPIs grouped by queue for the full filter period. Use /details for paginated answered call rows. Private upstream path: /v1/reports/answered/by-queues/metrics." → "Returns answered-call metrics grouped by queue for the selected date/time window, queues, and agents."
  • Summary changedgetDeveloperAnsweredDetailedCalls"Paginated detailed answered calls with CDR timeline" → "Answered detailed calls"
  • Description changedgetDeveloperAnsweredDetailedCalls"Flat paginated list of answered calls aligned with legacy GET /api/v1/metrics/answered/detailed. Each row matches distribution/detailed-calls (composite answered call fields plus a details array of CDR timeline legs). Legs omit date, queuename, and queuenumber. Call rows omit recording / has_expired. Time fields use HH:MM:SS strings. Results are ordered by datetime descending, then real_uniqueid descending. Empty tags is {}. event may be null on some rows. Private upstream path: /v1/reports/answered/detailed-calls." → "Returns a paginated list of answered calls for the selected filters. Each call includes summary fields and a details timeline of call legs. Time fields use HH:MM:SS strings. Results are ordered by call datetime descending."
  • Summary changedgetDeveloperAnsweredServiceLevelDetails"Answered service level details" → "Answered service level detailed calls"
  • Description changedgetDeveloperAnsweredServiceLevelDetails"Returns paginated answered call rows for the selected service-level filters. Rows include queuename and queuenumber. Private upstream path: /v1/reports/answered/service-level/details." → "Returns paginated answered call rows for the selected service-level filters. Rows include queuename and queuenumber."
  • Description changedgetDeveloperAnsweredServiceLevelMetrics"Returns answered SLA threshold metrics for the full filter period. Use /details for paginated answered call rows in the selected wait-time bands. Private upstream path: /v1/reports/answered/service-level/metrics." → "Returns answered-call service-level metrics grouped by wait-time threshold for the selected date/time window, queues, and agents."
  • Summary changedgetDeveloperAnsweredSummary"Answered aggregate KPIs" → "Answered summary metrics"
  • Description changedgetDeveloperAnsweredSummary"Workspace answered-call summary for the selected date/time window, queues, and agents. Response uses snake_case integer seconds for talk/wait averages; legacy GET /api/v1/metrics/answered/summary uses camelCase and HH:MM:SS strings. Private upstream path: /v1/reports/answered/summary." → "Returns answered-call summary metrics for the selected date/time window, queues, and agents. Average talk and wait values are returned in seconds."
  • Summary changedgetDeveloperDistributionByDidDetails"Distribution calls for DID grouping" → "Distribution by DID detailed calls"
  • Description changedgetDeveloperDistributionByDidDetails"Returns paginated distribution call rows for the selected DID-group filters. Rows include queuename and queuenumber. Private upstream path: /v1/reports/distribution/by-did/details." → "Returns paginated distribution call rows for the selected DID grouping filters. Rows include queuename and queuenumber."
  • Summary changedgetDeveloperDistributionByDidMetrics"Distribution metrics grouped by DID" → "Distribution by DID metrics"
  • Description changedgetDeveloperDistributionByDidMetrics"Returns aggregate distribution KPIs grouped by DID for the full filter window. Use /details for paginated call rows. Private upstream path: /v1/reports/distribution/by-did/metrics." → "Returns distribution metrics grouped by DID for the selected date/time window, queues, and agents."
  • Summary changedgetDeveloperDistributionByQueuesDetails"Distribution calls for queue grouping" → "Distribution by queue detailed calls"
  • Description changedgetDeveloperDistributionByQueuesDetails"Returns paginated distribution call rows for the selected queue-group filters. Rows omit redundant queuename / queuenumber because the metrics endpoint identifies queues. Private upstream path: /v1/reports/distribution/by-queues/details." → "Returns paginated distribution call rows for the selected queue grouping filters. Queue identity is provided by the selected grouping."
  • Summary changedgetDeveloperDistributionByQueuesMetrics"Distribution metrics grouped by queue" → "Distribution by queue metrics"
  • Description changedgetDeveloperDistributionByQueuesMetrics"Returns aggregate distribution KPIs grouped by queue for the full filter window. Use /details for paginated call rows. Private upstream path: /v1/reports/distribution/by-queues/metrics." → "Returns distribution metrics grouped by queue for the selected date/time window, queues, and agents."
  • Summary changedgetDeveloperDistributionByTimeDetails"Distribution calls for time grouping" → "Distribution by time period detailed calls"
  • Description changedgetDeveloperDistributionByTimeDetails"Returns paginated distribution call rows for the selected time-group filters. Rows include queuename and queuenumber. Private upstream path: /v1/reports/distribution/by-time/details." → "Returns paginated distribution call rows for the selected time-period grouping filters. Rows include queuename and queuenumber."
  • Summary changedgetDeveloperDistributionByTimeMetrics"Distribution metrics grouped by time period" → "Distribution by time period metrics"
  • Description changedgetDeveloperDistributionByTimeMetrics"Returns aggregate distribution KPIs grouped by period for the full filter window. Use /details for paginated call rows. Private upstream path: /v1/reports/distribution/by-time/metrics." → "Returns distribution metrics grouped by the requested time period for the selected date/time window, queues, and agents."
  • Summary changedgetDeveloperDistributionDetailedCalls"Paginated detailed distribution calls with CDR timeline" → "Distribution detailed calls"
  • Description changedgetDeveloperDistributionDetailedCalls"Flat paginated list of distribution calls. Each row matches distribution/by-did nested calls[] (includes queuename / queuenumber) plus a details array of CDR timeline legs. Legs omit date, queuename, and queuenumber. Call rows omit recording / has_expired. Time fields use HH:MM:SS strings. Empty tags is {}. Private upstream path: /v1/reports/distribution/detailed-calls." → "Returns a paginated list of distribution calls for the selected filters. Each call includes summary fields and a details timeline of call legs. Time fields use HH:MM:SS strings. Results are ordered by call datetime descending."
  • Summary changedgetDeveloperDistributionSummary"Distribution aggregate KPIs" → "Distribution summary metrics"
  • Description changedgetDeveloperDistributionSummary"Workspace distribution summary for the selected date/time window, queues, and agents. Includes login/logoff counts and SLA percentage (answered within 60s wait / received). Response uses snake_case; legacy GET /api/v1/metrics/distribution/summary uses camelCase. Private upstream path: /v1/reports/distribution/summary." → "Returns distribution summary metrics for the selected date/time window, queues, and agents, including login/logoff counts and service-level percentage."
  • Summary changedgetDeveloperOutboundByDisconnectionCausesDetails"Outbound calls for disconnection cause grouping" → "Outbound calls by disconnection cause detailed calls"
  • Description changedgetDeveloperOutboundByDisconnectionCausesDetails"Returns paginated outbound call rows for the selected disconnection-cause filters. Private upstream path: /v1/reports/outbound/by-disconnection-causes/details." → "Returns paginated outbound call rows for the selected disconnection-cause grouping filters."
  • Summary changedgetDeveloperOutboundByDisconnectionCausesMetrics"Outbound metrics grouped by disconnection cause" → "Outbound calls by disconnection cause metrics"
  • Description changedgetDeveloperOutboundByDisconnectionCausesMetrics"Returns outbound KPIs grouped by disconnection cause for the full filter period. Use /details for paginated outbound call rows. Private upstream path: /v1/reports/outbound/by-disconnection-causes/metrics." → "Returns outbound-call metrics grouped by disconnection cause for the selected date/time window, queues, and agents."
  • Summary changedgetDeveloperOutboundByTimeDetails"Outbound calls for time grouping" → "Outbound calls by time period detailed calls"
  • Description changedgetDeveloperOutboundByTimeDetails"Returns paginated outbound call rows for the selected time-group filters. Private upstream path: /v1/reports/outbound/by-time/details." → "Returns paginated outbound call rows for the selected time-period grouping filters."
  • Summary changedgetDeveloperOutboundByTimeMetrics"Outbound metrics grouped by time period" → "Outbound calls by time period metrics"
  • Description changedgetDeveloperOutboundByTimeMetrics"Returns outbound KPIs grouped by period for the full filter period. Use /details for paginated outbound call rows. Private upstream path: /v1/reports/outbound/by-time/metrics." → "Returns outbound-call metrics grouped by the requested time period for the selected date/time window, queues, and agents."
  • Summary changedgetDeveloperOutboundDetailedCalls"Paginated detailed outbound calls with CDR timeline" → "Outbound detailed calls"
  • Description changedgetDeveloperOutboundDetailedCalls"Flat paginated list aligned with legacy GET /api/v1/metrics/outbound/detailed. Each row uses outbound call shape (number, duration, queue) plus nested details legs. Omits recording / has_expired. Private upstream path: /v1/reports/outbound/detailed-calls." → "Returns a paginated list of outbound calls for the selected filters. Each call includes outbound call fields and a details timeline of call legs."
  • Summary changedgetDeveloperOutboundDialedByAgentsDetails"Outbound dialed calls for agent grouping" → "Outbound dialed calls by agent detailed calls"
  • Description changedgetDeveloperOutboundDialedByAgentsDetails"Returns paginated outbound dialed call rows for the selected agent-group filters. Private upstream path: /v1/reports/outbound/dialed-by-agents/details." → "Returns paginated outbound dialed call rows for the selected agent grouping filters."
  • Summary changedgetDeveloperOutboundDialedByAgentsMetrics"Outbound dialed metrics grouped by agent" → "Outbound dialed calls by agent metrics"
  • Description changedgetDeveloperOutboundDialedByAgentsMetrics"Returns outbound answered-call KPIs grouped by agent for the full filter period. Use /details for paginated dialed call rows. Private upstream path: /v1/reports/outbound/dialed-by-agents/metrics." → "Returns outbound dialed-call metrics grouped by agent for the selected date/time window, queues, and agents."
  • Summary changedgetDeveloperOutboundSummary"Outbound aggregate KPIs" → "Outbound summary metrics"
  • Description changedgetDeveloperOutboundSummary"Workspace outbound call summary for the selected date/time window, outbound queues, and agents. Aligned with legacy GET /api/v1/metrics/outbound/summary. Response uses snake_case and omits recording fields. Private upstream path: /v1/reports/outbound/summary." → "Returns outbound-call summary metrics for the selected date/time window, outbound queues, and agents."
  • Summary changedgetDeveloperOutboundUnansweredCalls"Paginated unanswered outbound calls with CDR timeline" → "Outbound unanswered detailed calls"
  • Description changedgetDeveloperOutboundUnansweredCalls"Flat paginated list aligned with legacy GET /api/v1/metrics/outbound/unanswered. Each row includes outbound position fields and a details array of CDR timeline legs. Omits recording / has_expired. Private upstream path: /v1/reports/outbound/unanswered-calls." → "Returns a paginated list of unanswered outbound calls for the selected filters. Each call includes outbound position fields and a details timeline of call legs."
  • Description changedsearchDeveloperReportCalls"Paginated workspace call search across queue stats rows. Private upstream path: /v1/reports/calls." → "Returns paginated call records for the selected search and filter criteria."
  • Summary changedgetDeveloperSummaryAgents"Per-agent call summary KPIs for today (paginated)" → "Today per-agent summary metrics"
  • Description changedgetDeveloperSummaryAgents"Paginated per-agent metrics for the current day (DB CURRENT_DATE window). Uses the same dashboard queue-type rules as GET /v1/reports/summary/calls: splits inbound vs outbound, includes inbound unanswered, and scopes break time to workspace queues. Response shape is snake_case and differs from legacy GET /api/v1/metrics/agents/summary (camelCase, single received count). Aggregates all agents and queues permitted for the workspace — no queue, agent, or date range query parameters. Private upstream path: /v1/reports/summary/agents." → "Returns paginated per-agent call summary metrics for the current day, including inbound, outbound, unanswered, and break-time values."
  • Summary changedgetDeveloperSummaryCalls"Workspace call summary KPIs (today)" → "Today workspace summary metrics"
  • Description changedgetDeveloperSummaryCalls"Aggregated call metrics for the current day, aligned with the dashboard GET /api/v1/metrics/dashboard/summary per-queue data and the same client-side aggregation rules (summaryTotals, inboundCalls, outboundCalls). When queue is omitted, includes all queues permitted for the workspace. No date range parameters — window is always today (server local day / same as dashboard SQL). Private upstream path: /v1/reports/summary/calls." → "Returns aggregated workspace call summary metrics for the current day. When queue is omitted, the response includes all inbound and outbound queues available to the workspace."
  • Summary changedgetDeveloperSummaryQueues"Per-queue call summary KPIs for today (paginated)" → "Today per-queue summary metrics"
  • Description changedgetDeveloperSummaryQueues"Paginated per-queue metrics for the current day (DB CURRENT_DATE window). Uses the same dashboard per-queue SQL as GET /v1/reports/summary/calls (inbound/outbound union, SLA, wait/talk totals) with pagination. Response shape is snake_case and differs from legacy GET /api/v1/metrics/dashboard/summary (camelCase field names). Aggregates all queues permitted for the workspace — no queue, agent, or date range query parameters. Private upstream path: /v1/reports/summary/queues." → "Returns paginated per-queue call summary metrics for the current day, including inbound, outbound, service-level, wait-time, and talk-time values."
  • Summary changedgetDeveloperUnansweredByDisconnectionCausesDetails"Unanswered calls for disconnection cause grouping" → "Unanswered calls by disconnection cause detailed calls"
  • Description changedgetDeveloperUnansweredByDisconnectionCausesDetails"Returns paginated incomplete call rows for the selected disconnection-cause filters. Rows include queuename and queuenumber. Private upstream path: /v1/reports/unanswered/by-disconnection-causes/details." → "Returns paginated unanswered call rows for the selected disconnection-cause grouping filters. Rows include queuename and queuenumber."
  • Summary changedgetDeveloperUnansweredByDisconnectionCausesMetrics"Unanswered metrics grouped by disconnection cause" → "Unanswered calls by disconnection cause metrics"
  • Description changedgetDeveloperUnansweredByDisconnectionCausesMetrics"Returns incomplete-call KPIs grouped by disconnection cause for the full filter period. Use /details for paginated incomplete call rows. Private upstream path: /v1/reports/unanswered/by-disconnection-causes/metrics." → "Returns unanswered-call metrics grouped by disconnection cause for the selected date/time window, queues, and agents."
  • Summary changedgetDeveloperUnansweredByQueuesDetails"Unanswered calls for queue grouping" → "Unanswered calls by queue detailed calls"
  • Description changedgetDeveloperUnansweredByQueuesDetails"Returns paginated incomplete call rows for the selected queue-group filters. Rows omit redundant queuename / queuenumber because the metrics endpoint identifies queues. Private upstream path: /v1/reports/unanswered/by-queues/details." → "Returns paginated unanswered call rows for the selected queue grouping filters. Queue identity is provided by the selected grouping."
  • Summary changedgetDeveloperUnansweredByQueuesMetrics"Unanswered metrics grouped by queue" → "Unanswered calls by queue metrics"
  • Description changedgetDeveloperUnansweredByQueuesMetrics"Returns incomplete-call KPIs grouped by queue for the full filter period. Use /details for paginated incomplete call rows. Private upstream path: /v1/reports/unanswered/by-queues/metrics." → "Returns unanswered-call metrics grouped by queue for the selected date/time window, queues, and agents."
  • Summary changedgetDeveloperUnansweredDetailedCalls"Paginated detailed unanswered calls with CDR timeline" → "Unanswered detailed calls"
  • Description changedgetDeveloperUnansweredDetailedCalls"Flat paginated list of incomplete calls aligned with legacy GET /api/v1/metrics/unanswered/detailed. Each row matches distribution/detailed-calls (composite call fields plus a details array of CDR timeline legs). Legs omit date, queuename, and queuenumber. Call rows omit recording / has_expired. Time fields use HH:MM:SS strings. Results are ordered by datetime descending, then real_uniqueid descending. Empty tags is {}. event may be null on some rows. Private upstream path: /v1/reports/unanswered/detailed-calls." → "Returns a paginated list of unanswered calls for the selected filters. Each call includes summary fields and a details timeline of call legs. Time fields use HH:MM:SS strings. Results are ordered by call datetime descending."
  • Summary changedgetDeveloperUnansweredServiceLevelDetails"Unanswered service level details" → "Unanswered service level detailed calls"
  • Description changedgetDeveloperUnansweredServiceLevelDetails"Returns paginated incomplete call rows for the selected service-level filters. Rows include queuename and queuenumber. Private upstream path: /v1/reports/unanswered/service-level/details." → "Returns paginated unanswered call rows for the selected service-level filters. Rows include queuename and queuenumber."
  • Description changedgetDeveloperUnansweredServiceLevelMetrics"Returns unanswered SLA threshold metrics for the full filter period. Use /details for paginated incomplete call rows in the selected wait-time bands. Private upstream path: /v1/reports/unanswered/service-level/metrics." → "Returns unanswered-call service-level metrics grouped by wait-time threshold for the selected date/time window, queues, and agents."
  • Summary changedgetDeveloperUnansweredSummary"Unanswered aggregate KPIs" → "Unanswered summary metrics"
  • Description changedgetDeveloperUnansweredSummary"Workspace incomplete-call summary for the selected date/time window, queues, and agents. Response uses snake_case integer seconds for wait averages; legacy GET /api/v1/metrics/unanswered/summary uses camelCase and HH:MM:SS strings for avgWait. avgstartposition, avgendposition, and avgwaitseconds are computed from abandoned calls only (ABANDON event). incompleted is the total of all incomplete events (unanswered + abandoned). Private upstream path: /v1/reports/unanswered/summary." → "Returns unanswered-call summary metrics for the selected date/time window, queues, and agents. Average position and wait values are calculated from abandoned calls."
  • Description changedlistDeveloperContacts"Returns non-blocked contacts in the workspace (isblocked = false), ordered by createdat descending. Blocked contacts are excluded from the list but can still be retrieved by identifier via GET /v1/contacts/{identifier}. Empty workspace returns 200 with data: [] and meta.total: 0. Private upstream path: /v1/contacts." → "Returns non-blocked contacts, ordered by created_at descending. Blocked contacts are excluded from this list but can still be retrieved by identifier. Empty results return 200 with data: [] and meta.total: 0."
  • Description changedcreateDeveloperContact"Creates a contact in the workspace resolved from the verified developer API JWT. Defaults: source=api, type=external when omitted. phone_number is required. Tags and custom attributes are not accepted on create or update; use dedicated metadata endpoints when they are introduced. createdat and updatedat are server-managed (prohibited in body). Private upstream path: /v1/contacts." → "Creates a contact. fullname and phonenumber are required. Optional fields include email, source, type, companyname, countryname, cityname, bio, additionalattributes, and isblocked. When omitted, source defaults to api, type defaults to external, and isblocked defaults to false."
  • Description changedgetDeveloperContact"Returns a single contact object in data (no meta). Identifier resolution (scoped to workspace from header): 1. Valid ULID → match id 2. Contains @ → match email (URL-decode path segment, e.g. encoded%40example.com) 3. Otherwise → exact E.164 phone_number match Blocked contacts are included on show (unlike list). Private upstream path: /v1/contacts/{identifier}." → "Returns a single contact by ULID, email address, or E.164 phone number. Email addresses in the path must be URL-encoded. Blocked contacts can be retrieved by this endpoint."
  • Description changedupdateDeveloperContact"Partial update of a contact resolved by {identifier} (same rules as GET). Send only the fields to change; omitted fields are left unchanged. Returns the updated contact in data via DeveloperContactResource. Tags and custom attributes are not accepted on contact update; use dedicated metadata endpoints when they are introduced. workspaceid, contactid, createdat, and updatedat must not appear in the body. Private upstream path: /v1/contacts/{identifier}." → "Updates a contact identified by ULID, email address, or E.164 phone number. Send one or more editable contact fields: fullname, email, phonenumber, companyname, countryname, cityname, bio, or isblocked. Omitted fields are left unchanged."
  • Description changeddeleteDeveloperContact"Permanently deletes the contact resolved by {identifier}. Returns a human-readable message and echoes the raw path parameter in data.identifier (e.g. if the client calls DELETE .../[email protected], the response contains "identifier": "[email protected]"). Subsequent GET/PUT/DELETE with the same identifier returns 404. Private upstream path: /v1/contacts/{identifier}." → "Permanently deletes a contact identified by ULID, email address, or E.164 phone number. A successful response includes a confirmation message and echoes the requested identifier. Subsequent requests for the same contact return 404."
  • AddedlistDeveloperSettingsAgents
  • AddedlistDeveloperSettingsQueues
  • AddedlistDeveloperSettingsQueuesWithAgents
60d8641Webhooks docs and custom APIs try-it section
  • AddedgetDeveloperAgentsAvailabilityDetails
  • AddedgetDeveloperAgentsAvailabilityMetrics
  • AddedgetDeveloperAgentsCallDispositionsDetails
  • AddedgetDeveloperAgentsCallDispositionsMetrics
  • AddedgetDeveloperAgentsPausesDetails
  • AddedgetDeveloperAgentsPausesMetrics
  • AddedgetDeveloperAnsweredByAgentsDetails
  • AddedgetDeveloperAnsweredByAgentsMetrics
  • AddedgetDeveloperAnsweredByCallDurationDetails
  • AddedgetDeveloperAnsweredByCallDurationMetrics
  • AddedgetDeveloperAnsweredByDisconnectionCausesDetails
  • AddedgetDeveloperAnsweredByDisconnectionCausesMetrics
  • AddedgetDeveloperAnsweredByQueuesDetails
  • AddedgetDeveloperAnsweredByQueuesMetrics
  • AddedgetDeveloperAnsweredServiceLevelDetails
  • AddedgetDeveloperAnsweredServiceLevelMetrics
  • AddedgetDeveloperDistributionByDidDetails
  • AddedgetDeveloperDistributionByDidMetrics
  • AddedgetDeveloperDistributionByQueuesDetails
  • AddedgetDeveloperDistributionByQueuesMetrics
  • AddedgetDeveloperDistributionByTimeDetails
  • AddedgetDeveloperDistributionByTimeMetrics
  • AddedgetDeveloperOutboundByDisconnectionCausesDetails
  • AddedgetDeveloperOutboundByDisconnectionCausesMetrics
  • AddedgetDeveloperOutboundByTimeDetails
  • AddedgetDeveloperOutboundByTimeMetrics
  • AddedgetDeveloperOutboundDialedByAgentsDetails
  • AddedgetDeveloperOutboundDialedByAgentsMetrics
  • AddedgetDeveloperUnansweredByDisconnectionCausesDetails
  • AddedgetDeveloperUnansweredByDisconnectionCausesMetrics
  • AddedgetDeveloperUnansweredByQueuesDetails
  • AddedgetDeveloperUnansweredByQueuesMetrics
  • AddedgetDeveloperUnansweredServiceLevelDetails
  • AddedgetDeveloperUnansweredServiceLevelMetrics
  • RemovedgetDeveloperAgentsAvailability
  • RemovedgetDeveloperAgentsCallDispositions
  • RemovedgetDeveloperAgentsPauses
  • RemovedgetDeveloperAnsweredByAgents
  • RemovedgetDeveloperAnsweredByCallDuration
  • RemovedgetDeveloperAnsweredByDisconnectionCauses
  • RemovedgetDeveloperAnsweredByQueues
  • RemovedgetDeveloperAnsweredServiceLevel
  • RemovedgetDeveloperDistributionByDid
  • RemovedgetDeveloperDistributionByQueues
  • RemovedgetDeveloperDistributionByTime
  • RemovedgetDeveloperOutboundByDisconnectionCauses
  • RemovedgetDeveloperOutboundByTime
  • RemovedgetDeveloperOutboundDialedByAgents
  • RemovedgetDeveloperUnansweredDisconnectionCauses
  • RemovedgetDeveloperUnansweredByQueues
  • RemovedgetDeveloperUnansweredServiceLevel