Type Alias CreateMessageData

Type declaration

• app: string

• Optionalattachments?:
      | {
          _id: string;
          contentLength: number;
          contentType: string;
          name: string;
          sourceId?: string;
      }[]
      | string[]

• Optionalauto?: boolean

  If true, message was automatically generated from a Kustomer workflow or auto-response feature. If set to true, this message will be excluded from reporting metrics. If false, message was created by a manual method.

• channel:
      | "email"
      | "sms"
      | "chat"
      | "facebook"
      | "twitter-dm"
      | "twitter-tweet"
      | "voice"
      | "instagram"
      | "whatsapp"

  The communication channel of the message: email, SMS, chat, facebook, twitter-dm, twitter-tweet, voice, instagram, whatsapp

• Optionalconversation?: string

  The conversation ID of the conversation message is to be added to.

• OptionalcreatedAt?: string

• OptionalcreatedBy?: string

• Optionalcustom?: { [key: string]: never }

• Optionalcustomer?: string

  The customer's name

• direction: "in" | "out"

  Indicates if the message is coming in from a customer or sent out by an agent.

• Optionalerror?: {
      code?: string;
      detail?: string;
      links?: { [key: string]: unknown };
      meta?: { [key: string]: unknown };
      source?: { [key: string]: unknown };
      status?: number;
      title?: string;
  }

• OptionalerrorAt?: string

  The timestamp for when the message errored out.

• OptionalexternalId?: string

  The unique identifier from the channel the message. For example, a message ID from Instagram for a specific DM.

• Optionalid?: string

• OptionalimportedAt?: string

• OptionalkbArticles?: string[]

• Optionallang?: string | null

  The language the message is in.

• Optionallocation?: {
      address?: string;
      address2?: string;
      address3?: string;
      areaCode?: string;
      cityName?: string;
      countryCode?: string;
      countryName?: string;
      latitude?: number;
      longitude?: number;
      name?: string;
      regionCode?: string;
      regionName?: string;
      zipCode?: string;
  }

• Optionalmeta?: { [key: string]: unknown }

• OptionalmodifiedAt?: string

• OptionalmodifiedBy?: string

• Optionalpreview?: string

• Optionalqueue?: unknown & { external?: "amazon-connect"; id?: string }

• Optionalreference?: { message: string; type: "reply" | "replyAll" | "forward" }

  • message: string

    For email channel only. The unique message ID for an email that is a reply, reply-all, or forward.

  • type: "reply" | "replyAll" | "forward"

    Indicate if the message is a reply, reply-all, or forward.

• Optionalrelated?: string

• OptionalsentAt?: string

  The timestamp for when the message was sent.

• Optionalsentiment?: { confidence: number; polarity: -1 | 0 | 1 }

• Optionalshortcuts?: string[]

• Optionalsize?: number

• Optionalsource?: "bulk" | "satisfaction"

  Indicate if the message is part of a bulk message (bulk) or CSAT (Customer Satisfaction Survey) (satisfaction) message.

• Optionalstatus?: "sent" | "received" | "error"

• Optionalsubject?: string