Documentation

Support

Vivox Unreal SDK

Vivox Unreal SDK

Retrieve account-wide chat history

Learn how to retrieve chat history across all accounts.
Read time 1 minuteLast updated 2 days ago

To retrieve account-wide chat history, you need to sign in and use vx_req_account_chat_history_query to make a request. vx_req_account_chat_history_query will return 10 messages by default. You can increase the number of messages returned by increasing the max value in the request. The maximum number of messages stored per channel is 5000, with a maximum age of 7 days. You will receive a vx_evt_account_archive_message event for every message. The following code is an example of how to retrieve 20 messages for a particular user across all of their channels:
vx_req_account_chat_history_query *req;vx_req_account_chat_history_query_create(&req);req->account_handle = vx_strdup("sip:.issuer.playerName@mt1s.vivox.com");req->max = 20;vx_issue_request2(&req->base);
After you get these messages, the game must then process two types of event messages:
  • vx_evt_account_archive_message
  • vx_evt_account_archive_query_end_t
void HandleAccountChatHistoryMessage(vx_evt_session_archive_message *evt){ // Use information in events to display messages} void HandleAccountChatHistoryEnd(vx_evt_session_archive_query_end_t *resp){ if (resp != nullptr && resp->return_code == 0) { // Ended abnormally } else { // Ended properly }}