SentTextMessageData

An outbound text message sent by an Augment agent.

  • attachmentCount
    Type: integer
    required

    Number of attachments sent with the message.

  • contact
    Type: object · AgentContact
    required

    The person the message was sent to.

    • email
      Type: string | null
      required

      Contact's email address

    • externalId
      Type: string | null
      required

      Your system's identifier for this contact, as supplied to Augment. null when Augment has no matching contact record.

    • name
      Type: string | null
      required

      Contact's name

    • phone
      Type: string | null
      required

      Contact's phone number in E.164 format

    • phoneExtension
      Type: string | null
      required

      Contact's phone extension

    • role
      Type: string

      The contact's role, on call events where Augment has one. Treat as an open set.

  • contactType
    enum
    const:  
    CarrierContact
    required

    The kind of contact the message was addressed to.

    values
    • CarrierContact
  • direction
    Type: string · CommunicationDirectionenum
    required

    Direction of the communication from Augment's point of view. OUTBOUND means Augment initiated it; INBOUND means Augment received it.

    values
    • INBOUND
    • OUTBOUND
  • message
    Type: string
    required

    The message text that was sent.