MessengerVideoRequest.ts

import { MessengerType } from '../Channels';

/**
 * Represents a request for sending a video message via the Messenger channel.
 *
 * @group Messenger
 * @category Requests
 *
 * @remarks
 * Vonage API's will return information using `snake_case`. This represents the
 * pure response before the client will transform the keys into `camelCase`.
 */
export type MessengerVideoRequest = {
  /**
   * A client-defined reference string for the message.
   */
  client_ref: string;

  /**
   * The type of the message, which is 'video' for a video message.
   */
  message_type: 'video';

  /**
   * The video content of the message.
   */
  video: {
    /**
     * The URL of the video to be sent in the message.
     */
    url: string;
  };

  /**
   * The recipient's phone number or identifier.
   */
  to: string;

  /**
   * The sender's phone number or identifier.
   */
  from: string;

  /**
   * The channel through which the message will be sent, which is 'messenger' for Messenger.
   */
  channel: 'messenger';

  /**
   * Additional information specific to the Messenger channel.
   */
  messenger: MessengerType;
}