telnyx 7.26.0 → 7.27.0

package/src/resources/calls/actions.ts

@@ -1210,6 +1210,12 @@ export interface ConversationRelayTranscriptionEngineConfig {
   [k: string]: unknown;
 }
 
+/**
+ * Language to transcribe. Deepgram's medical and phonecall models support English
+ * only.
+ */
+export type DeepgramEnglishTranscriptionLanguage = 'en' | 'en-US' | 'en-AU' | 'en-GB' | 'en-IN' | 'en-NZ';
+
 export interface DeepgramNova2Config {
   transcription_engine: 'deepgram/nova-2';
 
@@ -1217,8 +1223,9 @@ export interface DeepgramNova2Config {
 
   /**
    * Nova-2 keyword biasing without intensifiers. Up to 100 terms to bias recognition
-   * toward. For weighted biasing, use `keywords_boosting` instead. Nova-2-only; use
-   * `keyterms` on Nova-3.
+   * toward. For weighted biasing, use `keywords_boosting` instead. Supported on
+   * Nova-2 models only (`deepgram/nova-2`, `deepgram/nova-2-medical`,
+   * `deepgram/nova-2-phonecall`); use `keyterms` on Nova-3 and Flux.
    */
   hints?: Array<string>;
 
@@ -1312,8 +1319,10 @@ export interface DeepgramNova3Config {
   interim_results?: boolean;
 
   /**
-   * Nova-3 keyterm prompting. Up to 100 domain-specific terms or brand names to bias
-   * recognition toward. Nova-3-only; use `hints` on Nova-2.
+   * Keyterm prompting. Up to 100 domain-specific terms or brand names to bias
+   * recognition toward. Supported on Nova-3 and Flux models (`deepgram/nova-3`,
+   * `deepgram/nova-3-medical`, `deepgram/flux`, `deepgram/flux-multi`); use `hints`
+   * on Nova-2.
    */
   keyterms?: Array<string>;
 
@@ -1771,7 +1780,11 @@ export interface TranscriptionConfig {
    * detection, and the language codes `nl`, `en`, `fr`, `fy`, `de`, `it`, `pl`,
    * `pt`, `es`, and `sv` to fix the transcription language. For `cohere/ar-stt`,
    * supported values are `ar` and `en`; unlike other models, this model does not
-   * auto-detect and defaults to `ar` when `language` is omitted.
+   * auto-detect and defaults to `ar` when `language` is omitted. For
+   * `speechmatics/linden-1`, there is no auto-detect; set a code from Speechmatics'
+   * Realtime language list (see `SpeechmaticsTranscriptionLanguage`); unset defaults
+   * to `en`, while an explicit `auto`, `auto_beta`, or `multi` is rejected (unlike
+   * `speechmatics/standard`, which defaults to `en`).
    */
   language?: string;
 
@@ -1783,6 +1796,9 @@ export interface TranscriptionConfig {
    * - `deepgram/nova-3` and `deepgram/nova-2` for live streaming transcription.
    * - `speechmatics/standard` and `speechmatics/enhanced` for live streaming
    *   transcription.
+   * - `speechmatics/linden-1` (preview, vendor-hosted) for live streaming
+   *   transcription; no auto-detect, so set `language` from Speechmatics' Realtime
+   *   language list (defaults to `en`).
    * - `assemblyai/universal-3-5-pro` for live streaming transcription. The legacy
    *   alias `assemblyai/universal-streaming` is still accepted and resolves to the
    *   same model.
@@ -1813,6 +1829,7 @@ export interface TranscriptionConfig {
     | 'deepgram/nova-2'
     | 'speechmatics/standard'
     | 'speechmatics/enhanced'
+    | 'speechmatics/linden-1'
     | 'assemblyai/universal-3-5-pro'
     | 'assemblyai/universal-streaming'
     | 'xai/grok-stt'
@@ -2060,7 +2077,183 @@ export interface TranscriptionEngineCohereConfig {
   transcription_model?: 'cohere/ar-stt';
 }
 
-export type TranscriptionEngineDeepgramConfig = DeepgramNova2Config | DeepgramNova3Config;
+/**
+ * Deepgram Nova-2 specialty models: `deepgram/nova-2-medical` (medical vocabulary)
+ * and `deepgram/nova-2-phonecall` (low-bandwidth phone audio). English only.
+ */
+export type TranscriptionEngineDeepgramConfig =
+  | DeepgramNova2Config
+  | TranscriptionEngineDeepgramConfig.DeepgramNova2SpecialtyConfig
+  | DeepgramNova3Config
+  | TranscriptionEngineDeepgramConfig.DeepgramNova3MedicalConfig
+  | TranscriptionEngineDeepgramConfig.DeepgramFluxConfig
+  | TranscriptionEngineDeepgramConfig.DeepgramFluxMultiConfig;
+
+export namespace TranscriptionEngineDeepgramConfig {
+  /**
+   * Deepgram Nova-2 specialty models: `deepgram/nova-2-medical` (medical vocabulary)
+   * and `deepgram/nova-2-phonecall` (low-bandwidth phone audio). English only.
+   */
+  export interface DeepgramNova2SpecialtyConfig {
+    transcription_engine: 'Deepgram';
+
+    transcription_model: 'deepgram/nova-2-medical' | 'deepgram/nova-2-phonecall';
+
+    /**
+     * Nova-2 keyword biasing without intensifiers. Up to 100 terms to bias recognition
+     * toward. For weighted biasing, use `keywords_boosting` instead. Supported on
+     * Nova-2 models only (`deepgram/nova-2`, `deepgram/nova-2-medical`,
+     * `deepgram/nova-2-phonecall`); use `keyterms` on Nova-3 and Flux.
+     */
+    hints?: Array<string>;
+
+    /**
+     * Whether to send also interim results. If set to false, only final results will
+     * be sent.
+     */
+    interim_results?: boolean;
+
+    /**
+     * Keywords and their respective intensifiers (boosting values) to improve
+     * transcription accuracy for specific words or phrases. The intensifier should be
+     * a numeric value. Example: `{"snuffleupagus": 5, "systrom": 2, "krieger": 1}`.
+     */
+    keywords_boosting?: { [key: string]: number };
+
+    /**
+     * Language to transcribe. Deepgram's medical and phonecall models support English
+     * only.
+     */
+    language?: ActionsAPI.DeepgramEnglishTranscriptionLanguage;
+
+    /**
+     * Enable Deepgram's smart formatting (capitalization, punctuation, and digit
+     * normalization). Note: Telnyx defaults this to `true`, overriding Deepgram's
+     * underlying default of `false` — omit the field to get a smart-formatted
+     * transcript, or set it to `false` to receive the raw lowercase transcript without
+     * punctuation.
+     */
+    smart_format?: boolean;
+
+    /**
+     * Number of milliseconds of silence to consider an utterance ended. Ranges from 0
+     * to 5000 ms.
+     */
+    utterance_end_ms?: number;
+  }
+
+  /**
+   * Deepgram Nova-3 medical model, tuned for medical vocabulary. English only.
+   */
+  export interface DeepgramNova3MedicalConfig {
+    transcription_engine: 'Deepgram';
+
+    transcription_model: 'deepgram/nova-3-medical';
+
+    /**
+     * Whether to send also interim results. If set to false, only final results will
+     * be sent.
+     */
+    interim_results?: boolean;
+
+    /**
+     * Keyterm prompting. Up to 100 domain-specific terms or brand names to bias
+     * recognition toward. Supported on Nova-3 and Flux models (`deepgram/nova-3`,
+     * `deepgram/nova-3-medical`, `deepgram/flux`, `deepgram/flux-multi`); use `hints`
+     * on Nova-2.
+     */
+    keyterms?: Array<string>;
+
+    /**
+     * Keywords and their respective intensifiers (boosting values) to improve
+     * transcription accuracy for specific words or phrases. The intensifier should be
+     * a numeric value. Example: `{"snuffleupagus": 5, "systrom": 2, "krieger": 1}`.
+     */
+    keywords_boosting?: { [key: string]: number };
+
+    /**
+     * Language to transcribe. Deepgram's medical and phonecall models support English
+     * only.
+     */
+    language?: ActionsAPI.DeepgramEnglishTranscriptionLanguage;
+
+    /**
+     * Enable Deepgram's smart formatting (capitalization, punctuation, and digit
+     * normalization). Note: Telnyx defaults this to `true`, overriding Deepgram's
+     * underlying default of `false` — omit the field to get a smart-formatted
+     * transcript, or set it to `false` to receive the raw lowercase transcript without
+     * punctuation.
+     */
+    smart_format?: boolean;
+
+    /**
+     * Number of milliseconds of silence to consider an utterance ended. Ranges from 0
+     * to 5000 ms.
+     */
+    utterance_end_ms?: number;
+  }
+
+  /**
+   * Deepgram Flux (English), a conversational speech recognition model with built-in
+   * end-of-turn detection. `smart_format`, `utterance_end_ms`, `hints` and
+   * `keywords_boosting` do not apply to Flux.
+   */
+  export interface DeepgramFluxConfig {
+    transcription_engine: 'Deepgram';
+
+    transcription_model: 'deepgram/flux';
+
+    /**
+     * Whether to send also interim results. If set to false, only final results will
+     * be sent.
+     */
+    interim_results?: boolean;
+
+    /**
+     * Keyterm prompting. Up to 100 domain-specific terms or brand names to bias
+     * recognition toward. Supported on Nova-3 and Flux models (`deepgram/nova-3`,
+     * `deepgram/nova-3-medical`, `deepgram/flux`, `deepgram/flux-multi`); use `hints`
+     * on Nova-2.
+     */
+    keyterms?: Array<string>;
+
+    /**
+     * Language to transcribe. `deepgram/flux` supports English only.
+     */
+    language?: 'en';
+  }
+
+  /**
+   * Deepgram Flux multilingual, a conversational speech recognition model with
+   * built-in end-of-turn detection. `smart_format`, `utterance_end_ms`, `hints` and
+   * `keywords_boosting` do not apply to Flux.
+   */
+  export interface DeepgramFluxMultiConfig {
+    transcription_engine: 'Deepgram';
+
+    transcription_model: 'deepgram/flux-multi';
+
+    /**
+     * Whether to send also interim results. If set to false, only final results will
+     * be sent.
+     */
+    interim_results?: boolean;
+
+    /**
+     * Keyterm prompting. Up to 100 domain-specific terms or brand names to bias
+     * recognition toward. Supported on Nova-3 and Flux models (`deepgram/nova-3`,
+     * `deepgram/nova-3-medical`, `deepgram/flux`, `deepgram/flux-multi`); use `hints`
+     * on Nova-2.
+     */
+    keyterms?: Array<string>;
+
+    /**
+     * Language to transcribe. Flux-multi uses the language as a hint; `auto` lets Flux
+     * detect the language.
+     */
+    language?: 'en' | 'es' | 'fr' | 'de' | 'hi' | 'ru' | 'pt' | 'ja' | 'it' | 'nl' | 'auto';
+  }
+}
 
 export interface TranscriptionEngineGoogleConfig {
   /**
@@ -2237,7 +2430,21 @@ export interface TranscriptionEngineSpeechmaticsConfig {
   interim_results?: boolean;
 
   /**
-   * Language to use for speech recognition
+   * Language to use for speech recognition. Accepted values depend on the selected
+   * `transcription_model`. `speechmatics/standard` supports: `en`, `ba`, `eu`, `gl`,
+   * `ga`, `mt`, `mn`, `sw`, `ug`, `cy`, `ar_en`, `cmn_en`, `en_ms`, `en_ta`, `tl`,
+   * `es-bilingual-en`, `cmn_en_ms_ta`. `speechmatics/linden-1` (preview) supports
+   * the same languages as Speechmatics Realtime: `ar`, `ar_en`, `ba`, `be`, `bg`,
+   * `bn`, `ca`, `cmn`, `cmn_en`, `cmn_en_ms_ta`, `cs`, `cy`, `da`, `de`, `el`, `en`,
+   * `en_ms`, `en_ta`, `eo`, `es`, `es-bilingual-en`, `et`, `eu`, `fa`, `fi`, `fr`,
+   * `ga`, `gl`, `he`, `hi`, `hr`, `hu`, `ia`, `id`, `it`, `ja`, `ko`, `lt`, `lv`,
+   * `mn`, `mr`, `ms`, `mt`, `nl`, `no`, `pl`, `pt`, `ro`, `ru`, `sk`, `sl`, `sv`,
+   * `sw`, `ta`, `th`, `tl`, `tr`, `ug`, `uk`, `ur`, `vi`, `yue`, plus the spelling
+   * and script variants `en-US`, `en-GB`, `en-AU`, `cmn-Hans`, and `cmn-Hant` (`en`
+   * alone uses the default spelling). A value outside the selected model's list is
+   * rejected. For `speechmatics/standard`, unset, blank, `auto`, `auto_beta`, or
+   * `multi` defaults to `en`; for `speechmatics/linden-1`, only an unset language
+   * defaults to `en`, and `auto`, `auto_beta`, or `multi` is rejected.
    */
   language?:
     | 'en'
@@ -2256,7 +2463,57 @@ export interface TranscriptionEngineSpeechmaticsConfig {
     | 'en_ta'
     | 'tl'
     | 'es-bilingual-en'
-    | 'cmn_en_ms_ta';
+    | 'cmn_en_ms_ta'
+    | 'ar'
+    | 'be'
+    | 'bg'
+    | 'bn'
+    | 'ca'
+    | 'cmn'
+    | 'cs'
+    | 'da'
+    | 'de'
+    | 'el'
+    | 'eo'
+    | 'es'
+    | 'et'
+    | 'fa'
+    | 'fi'
+    | 'fr'
+    | 'he'
+    | 'hi'
+    | 'hr'
+    | 'hu'
+    | 'ia'
+    | 'id'
+    | 'it'
+    | 'ja'
+    | 'ko'
+    | 'lt'
+    | 'lv'
+    | 'mr'
+    | 'ms'
+    | 'nl'
+    | 'no'
+    | 'pl'
+    | 'pt'
+    | 'ro'
+    | 'ru'
+    | 'sk'
+    | 'sl'
+    | 'sv'
+    | 'ta'
+    | 'th'
+    | 'tr'
+    | 'uk'
+    | 'ur'
+    | 'vi'
+    | 'yue'
+    | 'en-US'
+    | 'en-GB'
+    | 'en-AU'
+    | 'cmn-Hans'
+    | 'cmn-Hant';
 
   /**
    * Engine identifier for Speechmatics transcription service
@@ -2264,9 +2521,10 @@ export interface TranscriptionEngineSpeechmaticsConfig {
   transcription_engine?: 'Speechmatics';
 
   /**
-   * The model to use for transcription.
+   * The model to use for transcription. `speechmatics/linden-1` is a preview,
+   * vendor-hosted model with its own language support (see `language`).
    */
-  transcription_model?: 'speechmatics/standard';
+  transcription_model?: 'speechmatics/standard' | 'speechmatics/linden-1';
 }
 
 export interface TranscriptionEngineTelnyxConfig {
@@ -3695,6 +3953,18 @@ export interface ActionHangupParams {
    * Custom headers to be added to the SIP BYE message.
    */
   custom_headers?: Array<CallsAPI.CustomSipHeader>;
+
+  /**
+   * Text for the SIP `Reason` header (RFC 3326) sent when cancelling an unanswered
+   * outbound leg. The SIP CANCEL carries `Reason: SIP;cause=200;text="<reason>"`;
+   * phones such as Poly and Yealink use it to suppress the missed-call entry for a
+   * call answered elsewhere. Has no effect on an answered leg or an inbound leg. A
+   * hangup sent before the leg's `call.initiated` webhook still hangs up the leg,
+   * but without the `Reason` header. Must not contain `"`, `\`, control characters,
+   * or characters outside the Basic Multilingual Plane (such as emoji); invalid
+   * values are rejected with a 422.
+   */
+  reason?: string;
 }
 
 export interface ActionLeaveQueueParams {
@@ -5777,6 +6047,7 @@ export declare namespace Actions {
     type CallControlCommandResultWithConversationID as CallControlCommandResultWithConversationID,
     type ConversationRelayInterruptible as ConversationRelayInterruptible,
     type ConversationRelayTranscriptionEngineConfig as ConversationRelayTranscriptionEngineConfig,
+    type DeepgramEnglishTranscriptionLanguage as DeepgramEnglishTranscriptionLanguage,
     type DeepgramNova2Config as DeepgramNova2Config,
     type DeepgramNova3Config as DeepgramNova3Config,
     type DeveloperMessage as DeveloperMessage,

package/src/resources/calls/calls.ts

@@ -94,6 +94,7 @@ import {
   CallControlCommandResultWithConversationID,
   ConversationRelayInterruptible,
   ConversationRelayTranscriptionEngineConfig,
+  DeepgramEnglishTranscriptionLanguage,
   DeepgramNova2Config,
   DeepgramNova3Config,
   DeveloperMessage,
@@ -1659,6 +1660,7 @@ export declare namespace Calls {
     type CallControlCommandResultWithConversationID as CallControlCommandResultWithConversationID,
     type ConversationRelayInterruptible as ConversationRelayInterruptible,
     type ConversationRelayTranscriptionEngineConfig as ConversationRelayTranscriptionEngineConfig,
+    type DeepgramEnglishTranscriptionLanguage as DeepgramEnglishTranscriptionLanguage,
     type DeepgramNova2Config as DeepgramNova2Config,
     type DeepgramNova3Config as DeepgramNova3Config,
     type DeveloperMessage as DeveloperMessage,

package/src/resources/calls/index.ts

@@ -9,6 +9,7 @@ export {
   type CallControlCommandResultWithConversationID,
   type ConversationRelayInterruptible,
   type ConversationRelayTranscriptionEngineConfig,
+  type DeepgramEnglishTranscriptionLanguage,
   type DeepgramNova2Config,
   type DeepgramNova3Config,
   type DeveloperMessage,

package/src/resources/credential-connections/credential-connections.ts

@@ -170,6 +170,17 @@ export interface CredentialConnection {
    */
   android_push_credential_id?: string | null;
 
+  /**
+   * Stores the connection preference for generating silent RTP toward the opposite
+   * call leg when comfort-noise packets (CN, payload type 13) are received during
+   * hold. Defaults to false and returns the saved value. Only JSON true and false
+   * are accepted; null and non-boolean values are rejected. This preference is
+   * independent of default_on_hold_comfort_noise_enabled and does not modify that
+   * setting. This API provisions the preference; call-processing behavior is
+   * implemented separately.
+   */
+  bridge_generate_comfort_noise_on_cn?: boolean;
+
   /**
    * Specifies if call cost webhooks should be sent for this connection.
    */
@@ -209,8 +220,8 @@ export interface CredentialConnection {
   encode_contact_header_enabled?: boolean;
 
   /**
-   * Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
-   * TLS.
+   * Enable use of SRTP for encryption. Can only be set when the SIP signaling
+   * transport protocol is TLS.
    */
   encrypted_media?: EncryptedMedia | null;
 
@@ -467,8 +478,8 @@ export interface CredentialOutbound {
 export type DtmfType = 'RFC 2833' | 'Inband' | 'SIP INFO';
 
 /**
- * Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
- * TLS.
+ * Enable use of SRTP for encryption. Can only be set when the SIP signaling
+ * transport protocol is TLS.
  */
 export type EncryptedMedia = 'SRTP' | null;
 
@@ -589,6 +600,17 @@ export interface CredentialConnectionCreateParams {
    */
   android_push_credential_id?: string | null;
 
+  /**
+   * Stores the connection preference for generating silent RTP toward the opposite
+   * call leg when comfort-noise packets (CN, payload type 13) are received during
+   * hold. Optional; defaults to false when omitted on creation. Only JSON true and
+   * false are accepted; null and non-boolean values are rejected. This preference is
+   * independent of default_on_hold_comfort_noise_enabled and does not modify that
+   * setting. This API provisions the preference; call-processing behavior is
+   * implemented separately.
+   */
+  bridge_generate_comfort_noise_on_cn?: boolean;
+
   /**
    * Specifies if call cost webhooks should be sent for this connection.
    */
@@ -614,8 +636,8 @@ export interface CredentialConnectionCreateParams {
   encode_contact_header_enabled?: boolean;
 
   /**
-   * Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
-   * TLS.
+   * Enable use of SRTP for encryption. Can only be set when the SIP signaling
+   * transport protocol is TLS.
    */
   encrypted_media?: EncryptedMedia | null;
 
@@ -719,6 +741,17 @@ export interface CredentialConnectionUpdateParams {
    */
   android_push_credential_id?: string | null;
 
+  /**
+   * Stores the connection preference for generating silent RTP toward the opposite
+   * call leg when comfort-noise packets (CN, payload type 13) are received during
+   * hold. Optional; omitting this field preserves the saved value. Only JSON true
+   * and false are accepted; null and non-boolean values are rejected. This
+   * preference is independent of default_on_hold_comfort_noise_enabled and does not
+   * modify that setting. This API provisions the preference; call-processing
+   * behavior is implemented separately.
+   */
+  bridge_generate_comfort_noise_on_cn?: boolean;
+
   /**
    * Specifies if call cost webhooks should be sent for this connection.
    */
@@ -756,8 +789,8 @@ export interface CredentialConnectionUpdateParams {
   encode_contact_header_enabled?: boolean;
 
   /**
-   * Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
-   * TLS.
+   * Enable use of SRTP for encryption. Can only be set when the SIP signaling
+   * transport protocol is TLS.
    */
   encrypted_media?: EncryptedMedia | null;
 

package/src/resources/dial-metrics.ts

@@ -0,0 +1,185 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { CloudfsCursorPagination, type CloudfsCursorPaginationParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Call information
+ */
+export class DialMetrics extends APIResource {
+  /**
+   * Returns dials-per-second (DPS) metrics for your account's outbound dials made
+   * with the Call Control `Dial` command and TeXML, as time buckets with dial
+   * counts, accepted and rejected dials, average and peak DPS, and the DPS limit in
+   * force.
+   *
+   * The result has one record per region per bucket, ordered by `start_time` and
+   * then `region`, newest first unless `sort=start_time`. Regions are never summed:
+   * the DPS limit is enforced per region, so a cross-region total cannot be compared
+   * with it.
+   *
+   * Only buckets that saw dials are returned. Treat a missing bucket as zero dials.
+   *
+   * Only complete 5-second windows are counted, and a window is counted about 15
+   * seconds after it closes. The newest `granularity=second` record is therefore
+   * your live DPS, about 20 seconds old. Request the last minute or two with
+   * `sort=-start_time`; the first record of each `region` is that region's live rate
+   * (`page[limit]=1` would hide every region but one). If no recent record exists,
+   * the live rate is zero.
+   *
+   * Results are cursor paginated. Follow `meta.next`, or pass `meta.cursors.after`
+   * as `page[after]`, until `meta.next` is absent. No total count is returned.
+   *
+   * This endpoint is in development and can change before general availability.
+   */
+  list(
+    query: DialMetricListParams,
+    options?: RequestOptions,
+  ): PagePromise<DialMetricListResponsesCloudfsCursorPagination, DialMetricListResponse> {
+    return this._client.getAPIList('/dial_metrics', CloudfsCursorPagination<DialMetricListResponse>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type DialMetricListResponsesCloudfsCursorPagination = CloudfsCursorPagination<DialMetricListResponse>;
+
+/**
+ * Dial counts and rates for one region in one time bucket. One record per region
+ * per bucket.
+ */
+export interface DialMetricListResponse {
+  /**
+   * `dials.total` divided by the bucket duration in seconds, rounded to 4 decimal
+   * places. Counts every dial attempt, rejected ones included.
+   */
+  average_dps?: number;
+
+  /**
+   * Dial attempt counts in the bucket.
+   */
+  dials?: DialMetricListResponse.Dials;
+
+  /**
+   * DPS limit in force during the busiest 5-second window, so it compares directly
+   * with `peak_dps`. `null` means unlimited. Enforcement near the limit is
+   * approximate; `dials.rejected.dps_limit` is the authoritative signal that the
+   * limit was reached.
+   */
+  dps_limit?: number | null;
+
+  /**
+   * End of the bucket (exclusive), UTC. Five seconds, one minute or one hour after
+   * `start_time`, depending on `granularity`.
+   */
+  end_time?: string;
+
+  /**
+   * Dials per second, rounded to 4 decimal places, in the busiest 5-second window of
+   * the bucket, summed across all call-processing nodes of the region. Counts every
+   * dial attempt, rejected ones included, so `peak_dps` above `dps_limit` is
+   * expected when dials were rejected. For `granularity=second` it equals
+   * `average_dps`.
+   */
+  peak_dps?: number;
+
+  record_type?: 'dial_metric';
+
+  /**
+   * Region where the dials were handled. Current values are `us`, `eu`, `australia`,
+   * `middle_east`, `canada` and `india`. New values can be added, so clients must
+   * tolerate values not listed here. Buckets of different regions are separate
+   * records.
+   */
+  region?: string;
+
+  /**
+   * Start of the bucket (inclusive), UTC.
+   */
+  start_time?: string;
+}
+
+export namespace DialMetricListResponse {
+  /**
+   * Dial attempt counts in the bucket.
+   */
+  export interface Dials {
+    /**
+     * Dial attempts that were not rejected by a limit.
+     */
+    accepted?: number;
+
+    /**
+     * Dial attempts rejected by a limit.
+     */
+    rejected?: Dials.Rejected;
+
+    /**
+     * All dial attempts, rejected ones included: accepted plus every rejected count.
+     */
+    total?: number;
+  }
+
+  export namespace Dials {
+    /**
+     * Dial attempts rejected by a limit.
+     */
+    export interface Rejected {
+      /**
+       * Rejected by a daily limit.
+       */
+      daily_limit?: number;
+
+      /**
+       * Rejected by the dials-per-second limit.
+       */
+      dps_limit?: number;
+
+      /**
+       * Rejected by an hourly limit.
+       */
+      hourly_limit?: number;
+    }
+  }
+}
+
+export interface DialMetricListParams extends CloudfsCursorPaginationParams {
+  /**
+   * Exclusive end of the range, ISO 8601. Must be after `start_time`. Buckets that
+   * start before this time are returned.
+   */
+  end_time: string;
+
+  /**
+   * Bucket size. `second` returns 5-second buckets (the finest resolution) and is
+   * kept for the last 48 hours. `minute` and `hour` are kept for the last 30 days.
+   */
+  granularity: 'second' | 'minute' | 'hour';
+
+  /**
+   * Inclusive start of the range, ISO 8601 (for example `2026-09-29T12:00:00.000Z`).
+   * Buckets that start at or after this time are returned. A `start_time` older than
+   * the retention window of the chosen `granularity` is moved forward to the start
+   * of that window, and `meta.start_time` returns the start actually used.
+   */
+  start_time: string;
+
+  /**
+   * Sort order of the buckets by `start_time`. `-start_time` (default) returns the
+   * newest first, `start_time` the oldest first. `region` follows the same direction
+   * for buckets with the same `start_time`. To read the live rate, use
+   * `granularity=second` and `sort=-start_time`, then take the first record of each
+   * `region`.
+   */
+  sort?: '-start_time' | 'start_time';
+}
+
+export declare namespace DialMetrics {
+  export {
+    type DialMetricListResponse as DialMetricListResponse,
+    type DialMetricListResponsesCloudfsCursorPagination as DialMetricListResponsesCloudfsCursorPagination,
+    type DialMetricListParams as DialMetricListParams,
+  };
+}