Changelog

3 minutes reading time

This document is the record of all the changes in the Agent Chat API, Web and RTM references, starting from version 3.0.

[v3.2] - Developer Preview

Added

  • There's a new method List Agents For Transfer (Web & RTM).
  • There's a new method Get Customer (Web & RTM) that returns info about a given Customer.
  • There's a new push chat_unfollowed complementary to the Unfollow Chat method.
  • There's a new include_chats_without_threads filter in the List Chats (Web & RTM) method.
  • There's a new agents filter in the List Archives (Web & RTM) method. It replaces the agents_ids filter.
  • There's a new events.types filter in the List Archives (Web & RTM) method.
  • There's a new method List Threads (Web & RTM).

Changed

  • The Update Agent method was replaced with Set Routing Status (Web & RTM).
  • The agent_updated push was replaced with routing_status_set.
  • The method Update Customer (Web & RTM), which used to return the Customer data structure, now has no response payload.
  • The method Get Chat Threads (Web & RTM) now requires thread_ids. Also, it no longer returns threads_summary in the response.
  • The Property data structure now has the same format in requests as in responses and pushes.
  • There's a new parameter id in the Form field data structure (fields.answer.id for the group_chooser field type). It's an identifier for each option Customers can choose.
  • The Add User to Chat method (Web & RTM) accepts an optional parameter require_active_thread.
  • There's a new parameter away in the Login method. It was introduced to prevent chat assignments after unexpected reconnects.
  • Each method, response, and push that deals with a variation of customer fields had this field renamed to session_fields and its format changed. It's now an array that respects the item order.
  • The Chat access (Web & RTM) methods, grant_access, revoke_access, and set_access were renamed, respectively, to grant_chat_access, revoke_chat_access, and set_chat_access along with the corresponding pushes. These methods no longer accept the resource parameter.
  • Many methods and pushes have been renamed:
    • method: Get Customers -> List Customers
    • method: Get Archives -> List Archives
    • method: Get Chats Summary -> List Chats
    • method: Update Chat Thread Properties -> Update Thread Properties and push: Chat Thread Properties Updated -> Thread Properties Updated
    • method: Delete Chat Thread Properties -> Delete Thread Properties and push: Chat Thread Properties Deleted -> Thread Properties Deleted
    • method: Tag Chat Thread -> Tag Thread and push: Chat Thread Tagged -> Thread Tagged
    • method: Untag Chat Thread -> Untag Thread and push: Chat Thread Untagged -> Thread Untagged
    • method: Close Thread -> Deactivate Chat and push: Thread Closed -> Chat Deactivated
    • push: Incoming Chat Thread -> Incoming Chat
  • order has been renamed to sort_order in List Chats, Get Chat Threads Summary and List Customers.
  • scopes in Multicast has been renamed to recipients.
  • There're new fields previous_thread_id and next_thread_id in the Thread data structure.
  • Fields order and timestamp in the Thread data structure were replaced with the new field, created_at (date & time in microseconds in UTC).

Removed

  • The Update Agent method was removed.
  • The agent_updated push was removed.

[v3.1] - 2019-09-17

Added

  • Web API: The Send File method was replaced with Upload File (Web). The new method should be used along with Send Event (Web & RTM), Start Chat (Web & RTM), or Activate Chat (Web & RTM).

Changed

  • Web API: From now on, sending payloads explicitly in the request body is allowed. You no longer have to wrap it up in the payload object.
  • Web API: When using Bot Agents, you need to include the X-Author-Id header in requests instead of sending author_id in the request body.
  • Method Update Last Seen Timestamp was transformed into Mark Events as Seen (Web & RTM). Now, it accepts the seen_up_to parameter (date & time in microseconds in UTC) instead of timestamp. Also, it no longer returns timestamp in the response.
  • Push last_seen_timestamp_updated was transformed into events_marked_as_seen with seen_up_to parameter instead of timestamp.
  • Fields order and timestamp in events were replaced with the new field, created_at (date & time in microseconds in UTC).
  • Method Create Customer (Web & RTM) now returns only customer_id instead of the whole Customer data structure.
  • Method Send Event (Web & RTM) no longer accepts the require_active_thread parameter. Thread is always required to be active unless attach_to_last_thread is enabled.
  • Method Send Event now returns only event_id instead of the whole Event data structure.
  • Method Start Chat (Web & RTM) now returns only chat_id, thread_id and optionally event_ids if requested. It used to return the whole Chat data structure.
  • Method Activate Chat (Web & RTM) now returns only thread_id and optionally event_ids if requested. It used to return the whole Chat data structure.

Removed

  • The Send File method was removed.