Message Archiving by File Transfer

Introduction

This guide explains the available file formats for YakChat Message Archiving and how to configure automated file transfers to Azure or AWS cloud storage.

File Formats

Two file formats are available for message archiving via file transfer:

Message Log: Contains a record for each message sent or received, including segments and pricing information.
Text and Media: Includes all Message Log data plus message text and media attachments.

Message Log (CDR)

The Message Log CSV includes the following fields:

Header	Type	Description	Possible Values
TimeStamp	DateTime	UTC timestamp of when the message was sent or received	YYYYDDTHH:MM:SSSSSSSSZ
To	string	Recipient phone number (E.164 format)
From	string	Sender phone number (E.164 format)
Direction	string	Message direction	In, Out
Segments	integer	Number of text segments
Price	decimal	Total cost of the message
Status	string	Current delivery status	Sent, Delivered
RoomId	integer	Unique conversation identifier
RoomCreator	string	Deprecated field (retained for compatibility)
InboxId	integer	Unique inbox identifier
SubscriptionId	integer	YakChat subscription identifier
CompanyId	integer	Company identifier
MessageId	integer	Unique message identifier

Text and Media Format

This format includes all Message Log fields, plus additional fields for message content:

Header	Type	Description	Possible Values
Text	string	Message body text
Media	string	Relative file location of attached media

Configuration Notes

The archiving service runs daily and generates a CSV file when messages are present.
File naming format: companyName_companyId_yyyy-MM-dd_HH-mm-ss.csv
Example: YakChat_2_2025-12-11_00-00-00.csv
Partner accounts support only the Message Log format and include messages from all child companies.
Customer accounts can use both Message Log and Text and Media formats.

File Transfer Setup

Archiving to Microsoft Azure Storage

Configure YakChat to automatically upload archive files to Azure Blob Storage by following the official setup guide:

Archiving to Microsoft Azure Storage – Using Service Principal

Archiving to Amazon Web Services (AWS) S3

To upload archive files to AWS S3, follow this guide:

Archiving to AWS S3 Using Access Credentials