conversationMessageAdd

Add a new message to a conversation — a reply, an internal note, or a templated/interactive message.

Set visibility: "internal" for team-only notes invisible to the customer. Provide interactive for WhatsApp/Instagram/Facebook buttons, lists, or carousels.

Side effects: dispatches the message to the underlying channel (e.g. WhatsApp, Messenger) when visibility is "public", and fires conversation automation triggers.

Auth · x-app-token · required permission conversationMessageAdd

MUTATION

conversationMessageAdd(conversationId: String, type: String, text: MessageTextInput, media: MessageMediaInput, sender: MessageSenderInput, visibility: String, context: MessageContextInput, template: JSON, metadata: JSON, interactive: JSON): ConversationMessage

Arguments

conversationId

String

The conversation id to add the message to.

type

String

Message type discriminator, e.g. "text", "media", "template".

text

MessageTextInput

Text content, when type is "text".

media

MessageMediaInput

Media/attachment content, when type is "media".

sender

MessageSenderInput

Who is sending this message.

visibility

String

"public" (default), "internal" (team-only note), or "hidden".

context

MessageContextInput

Threading, forwarding, and mention context.

template

JSON

Template payload, when type is "template".

metadata

JSON

Additional free-form metadata as JSON.

interactive

JSON

Interactive message payload (buttons, lists, carousels) for WhatsApp/Instagram/Facebook.

Returns

ConversationMessage

_id

String!

type

String

Message type discriminator.

sender

MessageSender

Who sent this message.

visibility

String

Visibility level: 'public', 'internal', or 'hidden'.

text

MessageText

Text content (when type='text').

media

MessageMedia

Media content (image, audio, video, document — single or multiple).

template

MessageTemplate

Template content (when type='template').

interactive

MessageInteractive

Interactive content (when type='interactive').

toolCalls

JSON

Tool call data (when type='tool_call').

MessageEmail

Email envelope and body (when type='email').

context

MessageContext

Threading, forwarding, mention context.

delivery

MessageDelivery

Delivery status and error info.

reactions

[MessageReaction]

Reactions on this message.

origin

MessageOrigin

External origin tracking.

editHistory

[MessageEditEntry]

Message edit history.

metadata

JSON

Extensible metadata bucket.

replyForMsg

JSON

The resolved original message being replied to.

customer

Customer

The resolved customer who sent this message.

user

User

The resolved agent who sent this message.

conversation

Conversation

The parent conversation.

conversationId

String

The conversation this message belongs to.

createdAt

Date

When this message was created.

sticker

WASticker

Sticker attachment (when type='sticker').

location

WALocation

Location data (when type='location').

contacts

[WAContact]

Contact cards (when type='contacts').

referral

WAReferral

CTWA ad referral attached to the message.

system

MessageSystem

System event content (populated when type is "system").

form

MessageForm

Form submission content (populated when type is "form").

engage

MessageEngage

Engage/campaign content (populated when type is "engage").

videoCall

MessageVideoCall

Video call content (populated when type is "videoCall").

order

MessageOrder

Order/commerce content (populated when type is "order").

updatedAt

Date

When this message was last updated (e.g. reaction or visibility change via conversationMessageUpdate).

whatsappCall

MessageWhatsappCall

Live WhatsApp call card (when type='whatsapp_call').

Mutation

mutation ConversationMessageAdd {
  conversationMessageAdd {
    _id
    type
    sender {
      kind
      id
    }
    visibility
    text {
      body
      preview
    }
    media {
      attachments {
        url
        name
        type
        size
        duration
        locationData {
          __typename
        }
      }
      caption
    }
  }
}

Response

{
  "data": {
    "conversationMessageAdd": {
      "_id": "string",
      "type": "string",
      "sender": {
        "kind": "string",
        "id": "string"
      },
      "visibility": "string",
      "text": {
        "body": "string",
        "preview": "string"
      },
      "media": {
        "attachments": [
          {
            "url": "string",
            "name": "string",
            "type": "string",
            "size": 1.5,
            "duration": 1.5,
            "locationData": {
              "__typename": "LocationData"
            }
          }
        ],
        "caption": "string"
      }
    }
  }
}

آخر تعديل في ١١ أغسطس ٢٠٢٦

Mutation

mutation ConversationMessageAdd {
  conversationMessageAdd {
    _id
    type
    sender {
      kind
      id
    }
    visibility
    text {
      body
      preview
    }
    media {
      attachments {
        url
        name
        type
        size
        duration
        locationData {
          __typename
        }
      }
      caption
    }
  }
}

Response

{
  "data": {
    "conversationMessageAdd": {
      "_id": "string",
      "type": "string",
      "sender": {
        "kind": "string",
        "id": "string"
      },
      "visibility": "string",
      "text": {
        "body": "string",
        "preview": "string"
      },
      "media": {
        "attachments": [
          {
            "url": "string",
            "name": "string",
            "type": "string",
            "size": 1.5,
            "duration": 1.5,
            "locationData": {
              "__typename": "LocationData"
            }
          }
        ],
        "caption": "string"
      }
    }
  }
}

البداية

أدلة

جرّب

Queries

Mutations

Types

conversationMessageAdd

Arguments

Returns