telnyx 7.22.0 → 7.23.0

package/src/resources/messages/messages.ts

@@ -2,7 +2,6 @@
 
 import { APIResource } from '../../core/resource';
 import * as MessagesAPI from './messages';
-import * as Shared from '../shared';
 import * as RcsAPI from './rcs';
 import {
   RcGenerateDeeplinkParams,
@@ -258,8 +257,15 @@ export interface MessagingInboundMessagePayload {
   id?: string;
 
   /**
-   * WhatsApp message body. For message edits and revocations, inspect `type` and the
-   * corresponding `edit` or `revoke` object.
+   * Automatic response type triggered by an inbound opt-in, opt-out, or help
+   * keyword. Examples include START, STOP, and HELP.
+   */
+  autoresponse_type?: string;
+
+  /**
+   * Message body for RCS and WhatsApp. RCS messages contain text, user_file,
+   * location, or suggestion_response. For WhatsApp edits and revocations, inspect
+   * type and the corresponding edit or revoke object.
    */
   body?: MessagingInboundMessagePayload.Body;
 
@@ -366,15 +372,16 @@ export interface MessagingInboundMessagePayload {
   text?: string;
 
   /**
-   * Receiving address. SMS and MMS webhooks use an array of recipients. WhatsApp
-   * webhooks use one E.164 phone number.
+   * Receiving address. SMS, MMS and RCS webhooks use an array of recipients. RCS
+   * recipients are identified by agent_id and agent_name. WhatsApp webhooks use one
+   * E.164 phone number.
    */
   to?: Array<MessagingInboundMessagePayload.UnionMember0> | string;
 
   /**
    * The messaging channel used for the message.
    */
-  type?: 'SMS' | 'MMS' | 'WHATSAPP';
+  type?: 'SMS' | 'MMS' | 'WHATSAPP' | 'RCS';
 
   /**
    * Not used for inbound messages.
@@ -395,8 +402,9 @@ export interface MessagingInboundMessagePayload {
 
 export namespace MessagingInboundMessagePayload {
   /**
-   * WhatsApp message body. For message edits and revocations, inspect `type` and the
-   * corresponding `edit` or `revoke` object.
+   * Message body for RCS and WhatsApp. RCS messages contain text, user_file,
+   * location, or suggestion_response. For WhatsApp edits and revocations, inspect
+   * type and the corresponding edit or revoke object.
    */
   export interface Body {
     /**
@@ -419,11 +427,26 @@ export namespace MessagingInboundMessagePayload {
      */
     from?: string;
 
+    /**
+     * Location shared in an RCS message.
+     */
+    location?: Body.Location;
+
     /**
      * Details for a revoked WhatsApp message.
      */
     revoke?: Body.Revoke;
 
+    /**
+     * Selected RCS suggestion.
+     */
+    suggestion_response?: Body.SuggestionResponse;
+
+    /**
+     * RCS text string or WhatsApp text object.
+     */
+    text?: string | Body.Body;
+
     /**
      * Unix timestamp supplied by Meta.
      */
@@ -435,6 +458,11 @@ export namespace MessagingInboundMessagePayload {
      */
     type?: string;
 
+    /**
+     * RCS file attachment and optional thumbnail.
+     */
+    user_file?: Body.UserFile;
+
     [k: string]: unknown;
   }
 
@@ -455,6 +483,15 @@ export namespace MessagingInboundMessagePayload {
       original_message_id: string;
     }
 
+    /**
+     * Location shared in an RCS message.
+     */
+    export interface Location {
+      latitude?: number;
+
+      longitude?: number;
+    }
+
     /**
      * Details for a revoked WhatsApp message.
      */
@@ -465,6 +502,52 @@ export namespace MessagingInboundMessagePayload {
        */
       original_message_id: string;
     }
+
+    /**
+     * Selected RCS suggestion.
+     */
+    export interface SuggestionResponse {
+      postback_data?: string;
+
+      text?: string;
+    }
+
+    export interface Body {
+      body?: string;
+
+      [k: string]: unknown;
+    }
+
+    /**
+     * RCS file attachment and optional thumbnail.
+     */
+    export interface UserFile {
+      payload?: UserFile.Payload;
+
+      thumbnail?: UserFile.Thumbnail;
+    }
+
+    export namespace UserFile {
+      export interface Payload {
+        file_name?: string;
+
+        file_size_bytes?: number;
+
+        file_uri?: string;
+
+        mime_type?: string;
+      }
+
+      export interface Thumbnail {
+        file_name?: string;
+
+        file_size_bytes?: number;
+
+        file_uri?: string;
+
+        mime_type?: string;
+      }
+    }
   }
 
   export interface Cc {
@@ -549,7 +632,7 @@ export namespace MessagingInboundMessagePayload {
     /**
      * The line-type of the sender.
      */
-    line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '';
+    line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '' | 'long_code';
 
     /**
      * Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short
@@ -557,7 +640,7 @@ export namespace MessagingInboundMessagePayload {
      */
     phone_number?: string;
 
-    status?: 'received' | 'delivered';
+    status?: 'received' | 'delivered' | 'webhook_delivered';
   }
 
   export interface Media {
@@ -583,6 +666,16 @@ export namespace MessagingInboundMessagePayload {
   }
 
   export interface UnionMember0 {
+    /**
+     * RCS agent identifier.
+     */
+    agent_id?: string;
+
+    /**
+     * RCS agent name.
+     */
+    agent_name?: string;
+
     /**
      * The carrier of the receiver.
      */
@@ -616,6 +709,11 @@ export interface MessagingOutboundMessagePayload {
    */
   id?: string;
 
+  /**
+   * RCS webhook message body. Text messages use the text property.
+   */
+  body?: MessagingOutboundMessagePayload.Body;
+
   cc?: Array<MessagingOutboundMessagePayload.Cc>;
 
   /**
@@ -731,7 +829,7 @@ export interface MessagingOutboundMessagePayload {
   /**
    * The type of message.
    */
-  type?: 'SMS' | 'MMS';
+  type?: 'SMS' | 'MMS' | 'RCS';
 
   /**
    * Message must be out of the queue by this time or else it will be discarded and
@@ -760,6 +858,16 @@ export interface MessagingOutboundMessagePayload {
 }
 
 export namespace MessagingOutboundMessagePayload {
+  /**
+   * RCS webhook message body. Text messages use the text property.
+   */
+  export interface Body {
+    /**
+     * RCS text message.
+     */
+    text?: string;
+  }
+
   export interface Cc {
     /**
      * The carrier of the receiver.
@@ -834,6 +942,16 @@ export namespace MessagingOutboundMessagePayload {
   }
 
   export interface From {
+    /**
+     * RCS agent identifier.
+     */
+    agent_id?: string;
+
+    /**
+     * RCS agent name.
+     */
+    agent_name?: string;
+
     /**
      * The carrier of the receiver.
      */
@@ -900,7 +1018,8 @@ export namespace MessagingOutboundMessagePayload {
       | 'sending_failed'
       | 'delivery_unconfirmed'
       | 'delivered'
-      | 'delivery_failed';
+      | 'delivery_failed'
+      | 'read';
   }
 }
 
@@ -910,6 +1029,11 @@ export interface OutboundMessagePayload {
    */
   id?: string;
 
+  /**
+   * RCS webhook message body. Text messages use the text property.
+   */
+  body?: OutboundMessagePayload.Body;
+
   cc?: Array<OutboundMessagePayload.Cc>;
 
   /**
@@ -939,7 +1063,7 @@ export interface OutboundMessagePayload {
    * These errors may point at addressees when referring to unsuccessful/unconfirmed
    * delivery statuses.
    */
-  errors?: Array<Shared.MessagingError>;
+  errors?: Array<MessagingError0b38e7044b>;
 
   from?: OutboundMessagePayload.From;
 
@@ -1025,7 +1149,7 @@ export interface OutboundMessagePayload {
   /**
    * The type of message.
    */
-  type?: 'SMS' | 'MMS';
+  type?: 'SMS' | 'MMS' | 'RCS';
 
   /**
    * Message must be out of the queue by this time or else it will be discarded and
@@ -1054,6 +1178,16 @@ export interface OutboundMessagePayload {
 }
 
 export namespace OutboundMessagePayload {
+  /**
+   * RCS webhook message body. Text messages use the text property.
+   */
+  export interface Body {
+    /**
+     * RCS text message.
+     */
+    text?: string;
+  }
+
   export interface Cc {
     /**
      * The carrier of the receiver.
@@ -1128,6 +1262,16 @@ export namespace OutboundMessagePayload {
   }
 
   export interface From {
+    /**
+     * RCS agent identifier.
+     */
+    agent_id?: string;
+
+    /**
+     * RCS agent name.
+     */
+    agent_name?: string;
+
     /**
      * The carrier of the receiver.
      */
@@ -1194,7 +1338,8 @@ export namespace OutboundMessagePayload {
       | 'sending_failed'
       | 'delivery_unconfirmed'
       | 'delivered'
-      | 'delivery_failed';
+      | 'delivery_failed'
+      | 'read';
   }
 }
 
@@ -1917,7 +2062,7 @@ export interface WhatsappReaction {
 }
 
 export interface MessageRetrieveResponse {
-  data?: MessagingOutboundMessagePayload | MessagingInboundMessagePayload;
+  data?: OutboundMessagePayload | MessagingInboundMessagePayload;
 }
 
 export interface MessageCancelScheduledResponse {
@@ -2216,31 +2361,31 @@ export namespace MessageCancelScheduledResponse {
 }
 
 export interface MessageRetrieveGroupMessagesResponse {
-  data?: Array<MessagingOutboundMessagePayload>;
+  data?: Array<OutboundMessagePayload>;
 }
 
 export interface MessageScheduleResponse {
-  data?: MessagingOutboundMessagePayload;
+  data?: OutboundMessagePayload;
 }
 
 export interface MessageSendResponse {
-  data?: MessagingOutboundMessagePayload;
+  data?: OutboundMessagePayload;
 }
 
 export interface MessageSendGroupMmsResponse {
-  data?: MessagingOutboundMessagePayload;
+  data?: OutboundMessagePayload;
 }
 
 export interface MessageSendLongCodeResponse {
-  data?: MessagingOutboundMessagePayload;
+  data?: OutboundMessagePayload;
 }
 
 export interface MessageSendNumberPoolResponse {
-  data?: MessagingOutboundMessagePayload;
+  data?: OutboundMessagePayload;
 }
 
 export interface MessageSendShortCodeResponse {
-  data?: MessagingOutboundMessagePayload;
+  data?: OutboundMessagePayload;
 }
 
 export interface MessageSendWithAlphanumericSenderResponse {

package/src/resources/noise-suppression-engines.ts

@@ -0,0 +1,51 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Noise suppression engines that can be selected when configuring noise suppression on voice connections.
+ */
+export class NoiseSuppressionEngines extends APIResource {
+  /**
+   * Returns all noise suppression engines available to the authenticated user.
+   * Engines gated behind a feature flag are included only when the flag is enabled
+   * for the user's account. Results are not paginated; the number of engines is
+   * expected to remain small.
+   */
+  list(options?: RequestOptions): APIPromise<NoiseSuppressionEngineListResponse> {
+    return this._client.get('/noise_suppression_engines', options);
+  }
+}
+
+export interface NoiseSuppressionEngineListResponse {
+  data: Array<NoiseSuppressionEngineListResponse.Data>;
+}
+
+export namespace NoiseSuppressionEngineListResponse {
+  /**
+   * A noise suppression engine available to the authenticated user.
+   */
+  export interface Data {
+    /**
+     * Default attenuation level of the engine (0-100, in multiples of ten).
+     */
+    default_attenuation_level: number;
+
+    /**
+     * Human-readable name of the engine.
+     */
+    label: string;
+
+    /**
+     * Machine-readable identifier of the engine, used when configuring noise
+     * suppression.
+     */
+    value: string;
+  }
+}
+
+export declare namespace NoiseSuppressionEngines {
+  export { type NoiseSuppressionEngineListResponse as NoiseSuppressionEngineListResponse };
+}

package/src/resources/speech-to-text/speech-to-text.ts

@@ -314,6 +314,7 @@ export interface SpeechToTextRetrieveTranscriptionParams {
     | 'speechmatics/standard'
     | 'soniox/stt-rt-v4'
     | 'nvidia/parakeet-v3'
+    | 'omi-health/omi-med-stt-v1'
     | 'humain/realtime'
     | 'reson8/turns'
     | 'cohere/ar-stt';

package/src/resources/texml/accounts/calls/calls.ts

@@ -590,6 +590,27 @@ export namespace CallCallsParams {
      */
     MachineDetection?: 'Enable' | 'Disable' | 'DetectMessageEnd';
 
+    /**
+     * Highest frequency, in Hz, that a tone can reach and still be treated as a beep.
+     * Only used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepMaxFrequency?: number;
+
+    /**
+     * Lowest frequency, in Hz, that a tone must reach to be treated as a beep. Raising
+     * it above 480 excludes North American ringback (440 + 480 Hz), which can
+     * otherwise be reported as a beep when the `freq_only` profile is in use. Only
+     * used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepMinFrequency?: number;
+
+    /**
+     * Shortest tone, in milliseconds, that can be treated as a beep. Raising it
+     * rejects brief tones such as call-progress blips. Only used when MachineDetection
+     * is enabled.
+     */
+    MachineDetectionBeepMinToneDuration?: number;
+
     /**
      * Selects which detectors must validate a beep. `both` requires the amplitude and
      * frequency detectors to agree. `freq_only` uses the frequency detector alone, for
@@ -598,6 +619,31 @@ export namespace CallCallsParams {
      */
     MachineDetectionBeepProfile?: 'both' | 'freq_only';
 
+    /**
+     * When enabled, a candidate beep must pass an additional spectral check before it
+     * is reported. Only used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralConfirmation?: boolean;
+
+    /**
+     * Minimum spectral purity, from 0 to 1, for a tone to be treated as a beep.
+     * Raising it rejects mixed tones such as ringback, which combines two frequencies.
+     * Only used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralMinPurity?: number;
+
+    /**
+     * When enabled, the fax CNG tone is rejected rather than reported as a beep. Only
+     * used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralRejectFaxCng?: boolean;
+
+    /**
+     * Length of the spectral confirmation window, in milliseconds. Only used when
+     * MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralWindow?: number;
+
     /**
      * Silence duration threshold after a call screening prompt before ending prompt
      * detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
@@ -874,6 +920,27 @@ export namespace CallCallsParams {
      */
     MachineDetection?: 'Enable' | 'Disable' | 'DetectMessageEnd';
 
+    /**
+     * Highest frequency, in Hz, that a tone can reach and still be treated as a beep.
+     * Only used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepMaxFrequency?: number;
+
+    /**
+     * Lowest frequency, in Hz, that a tone must reach to be treated as a beep. Raising
+     * it above 480 excludes North American ringback (440 + 480 Hz), which can
+     * otherwise be reported as a beep when the `freq_only` profile is in use. Only
+     * used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepMinFrequency?: number;
+
+    /**
+     * Shortest tone, in milliseconds, that can be treated as a beep. Raising it
+     * rejects brief tones such as call-progress blips. Only used when MachineDetection
+     * is enabled.
+     */
+    MachineDetectionBeepMinToneDuration?: number;
+
     /**
      * Selects which detectors must validate a beep. `both` requires the amplitude and
      * frequency detectors to agree. `freq_only` uses the frequency detector alone, for
@@ -882,6 +949,31 @@ export namespace CallCallsParams {
      */
     MachineDetectionBeepProfile?: 'both' | 'freq_only';
 
+    /**
+     * When enabled, a candidate beep must pass an additional spectral check before it
+     * is reported. Only used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralConfirmation?: boolean;
+
+    /**
+     * Minimum spectral purity, from 0 to 1, for a tone to be treated as a beep.
+     * Raising it rejects mixed tones such as ringback, which combines two frequencies.
+     * Only used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralMinPurity?: number;
+
+    /**
+     * When enabled, the fax CNG tone is rejected rather than reported as a beep. Only
+     * used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralRejectFaxCng?: boolean;
+
+    /**
+     * Length of the spectral confirmation window, in milliseconds. Only used when
+     * MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralWindow?: number;
+
     /**
      * Silence duration threshold after a call screening prompt before ending prompt
      * detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
@@ -1152,6 +1244,27 @@ export namespace CallCallsParams {
      */
     MachineDetection?: 'Enable' | 'Disable' | 'DetectMessageEnd';
 
+    /**
+     * Highest frequency, in Hz, that a tone can reach and still be treated as a beep.
+     * Only used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepMaxFrequency?: number;
+
+    /**
+     * Lowest frequency, in Hz, that a tone must reach to be treated as a beep. Raising
+     * it above 480 excludes North American ringback (440 + 480 Hz), which can
+     * otherwise be reported as a beep when the `freq_only` profile is in use. Only
+     * used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepMinFrequency?: number;
+
+    /**
+     * Shortest tone, in milliseconds, that can be treated as a beep. Raising it
+     * rejects brief tones such as call-progress blips. Only used when MachineDetection
+     * is enabled.
+     */
+    MachineDetectionBeepMinToneDuration?: number;
+
     /**
      * Selects which detectors must validate a beep. `both` requires the amplitude and
      * frequency detectors to agree. `freq_only` uses the frequency detector alone, for
@@ -1160,6 +1273,31 @@ export namespace CallCallsParams {
      */
     MachineDetectionBeepProfile?: 'both' | 'freq_only';
 
+    /**
+     * When enabled, a candidate beep must pass an additional spectral check before it
+     * is reported. Only used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralConfirmation?: boolean;
+
+    /**
+     * Minimum spectral purity, from 0 to 1, for a tone to be treated as a beep.
+     * Raising it rejects mixed tones such as ringback, which combines two frequencies.
+     * Only used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralMinPurity?: number;
+
+    /**
+     * When enabled, the fax CNG tone is rejected rather than reported as a beep. Only
+     * used when MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralRejectFaxCng?: boolean;
+
+    /**
+     * Length of the spectral confirmation window, in milliseconds. Only used when
+     * MachineDetection is enabled.
+     */
+    MachineDetectionBeepSpectralWindow?: number;
+
     /**
      * Silence duration threshold after a call screening prompt before ending prompt
      * detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.

package/src/resources/texml/accounts/conferences/participants.ts

@@ -484,6 +484,27 @@ export interface ParticipantParticipantsParams {
    */
   MachineDetection?: 'Enable' | 'DetectMessageEnd';
 
+  /**
+   * Body param: Highest frequency, in Hz, that a tone can reach and still be treated
+   * as a beep. Only used when MachineDetection is enabled.
+   */
+  MachineDetectionBeepMaxFrequency?: number;
+
+  /**
+   * Body param: Lowest frequency, in Hz, that a tone must reach to be treated as a
+   * beep. Raising it above 480 excludes North American ringback (440 + 480 Hz),
+   * which can otherwise be reported as a beep when the `freq_only` profile is in
+   * use. Only used when MachineDetection is enabled.
+   */
+  MachineDetectionBeepMinFrequency?: number;
+
+  /**
+   * Body param: Shortest tone, in milliseconds, that can be treated as a beep.
+   * Raising it rejects brief tones such as call-progress blips. Only used when
+   * MachineDetection is enabled.
+   */
+  MachineDetectionBeepMinToneDuration?: number;
+
   /**
    * Body param: Selects which detectors must validate a beep. `both` requires the
    * amplitude and frequency detectors to agree. `freq_only` uses the frequency
@@ -492,6 +513,31 @@ export interface ParticipantParticipantsParams {
    */
   MachineDetectionBeepProfile?: 'both' | 'freq_only';
 
+  /**
+   * Body param: When enabled, a candidate beep must pass an additional spectral
+   * check before it is reported. Only used when MachineDetection is enabled.
+   */
+  MachineDetectionBeepSpectralConfirmation?: boolean;
+
+  /**
+   * Body param: Minimum spectral purity, from 0 to 1, for a tone to be treated as a
+   * beep. Raising it rejects mixed tones such as ringback, which combines two
+   * frequencies. Only used when MachineDetection is enabled.
+   */
+  MachineDetectionBeepSpectralMinPurity?: number;
+
+  /**
+   * Body param: When enabled, the fax CNG tone is rejected rather than reported as a
+   * beep. Only used when MachineDetection is enabled.
+   */
+  MachineDetectionBeepSpectralRejectFaxCng?: boolean;
+
+  /**
+   * Body param: Length of the spectral confirmation window, in milliseconds. Only
+   * used when MachineDetection is enabled.
+   */
+  MachineDetectionBeepSpectralWindow?: number;
+
   /**
    * Body param: If initial silence duration is greater than this value, consider it
    * a machine. Ignored when `premium` detection is used.