Message

Message

{
    "id": "<string>",
    "conversation_id": "<string>",
    "direction": "<string>",
    "status": "<string>",
    "reference_type": "<string>",
    "reference_id": "<string>",
    "source": {
        ...
    },
    "text": "<string>",
    "medias": [],
    "tm_create": "<string>",
    "tm_update": "<string>",
    "tm_delete": "<string>"
}
  • id (UUID): The message’s unique identifier within the conversation.

  • conversation_id (UUID): The parent conversation’s ID. Obtained from GET /conversations or from the URL path when sending messages.

  • direction (enum string): Whether the message is incoming or outgoing. See Direction.

  • status (enum string): The message’s delivery status (e.g., sent, received, failed).

  • reference_type (enum string): The channel used for this message. See Reference type.

  • reference_id (String): An identifier associated with the channel (e.g., a Line user ID or phone number).

  • source (Object): The sender’s address for this message. See Address.

  • text (String): The message body text content.

  • medias (Array of Object): List of media attachments (images, videos, etc.) included with the message.

  • tm_create (string, ISO 8601): Timestamp when the message was created.

  • tm_update (string, ISO 8601): Timestamp of the last status update.

  • tm_delete (string, ISO 8601): Timestamp of deletion (soft delete).

Note

AI Implementation Hint

Timestamps set to 9999-01-01 00:00:00.000000 indicate the event has not yet occurred. For example, tm_delete with this value means the message has not been deleted.

Example

{
    "id": "cc46341b-f00a-452f-b527-19c85d030eaf",
    "conversation_id": "64558b45-40a8-43db-b814-9c0dbf6d47b5",
    "direction": "incoming",
    "status": "received",
    "reference_type": "line",
    "reference_id": "Ud871bcaf7c3ad13d2a0b0d78a42a287f",
    "source": {
        "type": "line",
        "target": "Ud871bcaf7c3ad13d2a0b0d78a42a287f",
        "target_name": "",
        "name": "",
        "detail": ""
    },
    "text": "안녕",
    "medias": [],
    "tm_create": "2022-06-24 04:28:51.558082",
    "tm_update": "2022-06-24 04:28:51.558090",
    "tm_delete": "9999-01-01 00:00:00.000000"
}

Direction

Message’s direction.

Direction

Description

incoming

Incoming message from a participant towards VoIPBIN. Delivered to your application via webhook.

outgoing

Outgoing message sent from your application via VoIPBIN to a conversation participant.