Release Notes
Version 14
- LOGIN POST Some response data has been removed that can be fetched with single requests. Here is a list of the removed properties and their corresponding endpoints:
- agents: /agent?open_tickets=1
- available_languages: /internal/translation
- customer_info: /accounting/info
- news: /internal/news
- stats: /stats/ticket
- MESSENGER WhatsApp Setup POST/GET New parameter "setup_contact_type" and "setup_contact" to get informed about the setup process
- ACCOUNTING Info GET Added all the info you previouslygot in the "customer_info" property from the login request
- TRANSLATION GET Added a list of our available languages to the response of the translations request
- TICKET Removed ticket stats property from all responses
- USER Removed ticket stats property from all responses
- CHANNEL Removed categories_auto_subscribe. Category subscription can be set as default value of the custom variable
- CONTENT POST/PUT Added Buttons to Content
- STATISTICS/LABELS GET Added label (tag) statistics
- STATISTICS GET Added new parameter output_format csv
- STATISTICS Tickets GET Removed KPIs average_chats_when_ticket_closed and average_duration_until_followup_agent_reactions
- CHANNEL new property mandatory_label_on_ticket_close
- STATISTICS KPI_Translations GET added
- USER GET Added new parameter output_format csv
- CONTENT/TARGETING GET new endpoint replacing NEWSLETTER/TARGETING
- TARGETING/COUNT GET new endpoint replacing NEWSLETTER/TARGETING with count
Version 13
- TICKET PUT Details/Close: New parameter "batch_ids" perform action on multiple tickets in one call
- Agent PUT/GET Data: Removed field settings allows to store any agent specific settings.
notification_endpoints
- TICKET GET: Corrected full text search for tickets including now ticket notes
- USER GET: New filter parameter to filter users by custom fields or change date of custoenm fields
- BOT Manual Answers GET Substituted parameter "filter" with "status" and "personal"
- BOT Manual Answers PUT/POST New parameter "status"
- BOT Manual Answers PUT All parameters except "id" are optional now
- CHAT POST New parameter "user_filter" to perform sending a chat to multiple users by filter instead of user ids
- CHAT (NOTIFICATION) POST New parameter "user_filter" to perform sending a notification to multiple users by filter instead of user ids
- CHANNEL GET/PUT: New channel setting ticket_auto_close_time
- TICKET GET: New parameter customfields for adding the users customfields to tickets
- ACCOUNTING Info PUT/GET: Configuration of two factor authentication
- ACCOUNTING Two_Factor_Email PUT: Send email to agents for registering messenger for two factor authentication
- AGENT PUT/GET: Configuration of two factor authentication
- LOGIN POST: New error code if two factor authentication is active
- CONTENT POST: New parameter notification_button_variable
- CHAT NOTIFICATION POST: New parameter notification_button_variable
- CHANNEL Webhook GET: Added info on last failure and pausing
- CHANNEL Webhook GET/PUT: Added webhook fields settings
- CHANNEL GET/PUT: New field delete_chat specifying whether agents can delete single chats
- CHANNEL GET: New field use_dynamic_chatblocks specifying whether dynamic chat blocks are shown in the user interface
- TEMPLATES New endpoints for managing WhatsApp Business message templates
Version 12
- TARGETING GET: List settings for a specific targeting list (identified by id) or every targeting list of the current channel
- TARGETING PUT: Update a specific targeting list
- TARGETING POST: Create a new targeting list
- TARGETING DELETE: Remove a targeting list
- CHANNEL GET/PUT: New channel settings welcomemessage_mia, welcomemessage_mia_notify, goodbye_message. Removed content_pull_hint, facebook_stop_timeout, notify_stop_timeout, mia_wb_notification, use_menu
- USER GET: New field for customfields "time" providing the timestamp of the last value change for the custom field
- TICKET GET: New sorting parameter "agents"
- TICKET PUT Details: New parameter "agent_email" to assign ticket to an agent by its email address
- CONTENT POST/PUT: Parameter "published" now accepts UNIX timestamp format and date strings in the format "YYYY-mm-dd HH:ii"
- CONTENT POST/PUT: New parameter "pull_keyword" to set the command that is prefilled in WhatsApp after redirection from Notify
- CONTENT POST/PUT: New parameter "wb_notification", "wb_notification_parameters" and "wb_notification_language" for sending a WhatsApp notification as content
- CONTENT GET: New field "pull_keyword" providing the ID of the pull command from the command menu
- LOGIN POST: New field "next_invoice" under "customer_info", List available roles under "customer_info", removed Whatsapp migration info, data of non-active channel reduced
- ACCOUNTING GET: New field "contract_start" giving the unix timestamp of the contract beginning
- CHANNEL AGENT GET: List available roles
- CHANNEL GET: Removed parameter wa_numbers
- CHAT (NOTIFICATION) POST: New parameter batch_ids for sending too many users with improved performance, shorten links if configured for the channel
- CHAT (NOTIFICATION) POST: New parameter language. The language is not taken from the users device anymore. If not provided, it defaults to the template's default language. If no default language set, it defaults to the channel language.
- CHAT POST: Removed obsolete parameters push and linkpreview. Placeholder syntax like in the bot builer, e.g. $profile_name$
- USER GET: The placeholder syntax is adapted to the syntax used in the bot builder
- CUSTOM GET/POST/PUT: The default_value ist displayed and can be set
Version 11
- CHANNEL GET/PUT: New channel settings. New ticket message for sending an alternative message to a returning customer after he opend a new ticket.
- CHANNEL GET/PUT: New channel setting notify_chat. Replaces notify_whatsapp_only.
- CHANNEL CONTENT GET New attribute "teaser_to" and "teaser_to_by_messenger" (if detailedReachStats = 1) that tells how many users have received the notification message.
- CHANNEL CONTENT POST/PUT/GET New parameter "media_filename" for the original filename of the media file.
- CHANNEL GET/PUT: New channel settings. Promo - will save a default promo message
- CHANNEL GET: New channel setting: hidden_phone
- CONTENT GET/PUT: New content field. Promo - will save a promo message to content and override the promo message in channel
- TICKET HISTORY GET New endpoint "get_ticket_history" to get all closed tickets for a given user ID.
- TICKET STATISTICS GET New endpoint "get_ticket_statistics" to get detailed statistical information on one or more tickets
Version 10
- NOTIFICATIONS: New format for notifications (GET/PUT/POST), due to changes and implementation of Facebook API. Always returns full set of notifications.
- BOT Manual Answers: Add ability to store original filename as attachment_filename.
- CHANNEL GET/PUT: New channel settings. Channelname is replaced by name. The welcome message for newsletetr channels is stored as bot chat.
- NEWSLETTER TARGETING GET: New option for listing ids cor content sending.
- NEWSLETTER CATEGORY GET/POST/PUT/DELETE: New endpoint for managing categories.
- CHANNEL CONTENT GET: New option for detailed reach stats for each messenger separately.
Version 9
- LOGIN POST: Output ticket_reopen_period in minutes instead of seconds.
- USER POST csv: Bulk update users via CSV file upload.
Version 8
- STATS GET Ticket: The current hour/day/week is included.
- BOT MENU/MENUITEM: New endpoints for managing bot messenger menus.
- LOGIN POST/CHANNEL GET: Information on booked bot modules is included based on associate role.
- LOGIN GET: Information for administrators on wa_policies_accepted.
- CONTENT INTERACTION GET: New endpoint for getting interaction information.
- CUSTOM: The position of custom fields can be modified.
- CUSTOM GET: Filter for showing hidden fields.
- CHANNEL GET/PUT : New channel configuration ticket_max_per_agent, applepay_settings.
- ACCOUNTING INFO: New endpoints for getting and updating additional account info.
- USER GET: Provide type of custom fields.
- CUSTOM: New attribute "limited_access" to show custom field only to dispatchers and admins.
Version 7
- LOGIN POST: The agent ticket IDs and statistics is included.
- AGENT GET: A new parameter open_tickets permits listing the IDs of the open tickets and ticket statistics for an agent. The name is set as well.
- TICKET GET: A new parameter for avoiding listing ticket notes. And waiting_since allows filtering open tickets.
- TICKET PUT: A new parameter waiting_since for marking an open ticket as answered.
- BOT TOPICS GET: A new parameter with_fields allows to check user properties used in api call, condition or chat and list them.
- CHANNEL GET: The channel id is listed.
- CHAT BOT POST : Customfields can be passed as parameters and will be stored as user properties. Additionally the bot interprets the chat so all conditions, multiple answers etc are evaluated
- CHAT POST : A filename can be passed as parameter. It can be displayed in messengers that don't support inline view of the attachment.
- CHAT GET/CHANNEL CHAT GET/TICKET GET: Outgoing chats have additional/changed format: email_created is changed to agent_id and agent_email for customer service channels and send_status is added. notification is set for sent WhatsApp notifications. unread is only set for incoming chats for the newsletter platform.
- WIDGETINFO GET: The channel id is listed.
- STATS GET Ticketdetails: New ticket statistics
- CHANNEL GET/PUT : New channel configuration ui_settings, bot_parser_modules.