Hi Platform

Integração com a API Hi Platform (Direct Talk) para consultar contatos de atendimento (HiChat, HiMail, HiPhone, HiBot, HiInbox) e relatórios de HiBot, HiChat e eventos de agentes.

Authentication

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use

Using the Smart Chat

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions

This connector provides 11 actions:

Action	Purpose	Parameters
get_info_contacts	Retrieves customer service interactions across channels. Rate limit: 100 requests/minute. Paginated: response carries X-Pagination-TotalResults, X-Pagination-TotalPages and a Link header with First/Previous/Next/Last URLs. Results are ordered by the date type selected via dateInfo. The maximum allowed range between startDate and endDate is 31 days. Invalid parameters return HTTP 400.	startDate (integer) required endDate (integer) required channel (string) pageNumber (integer) pageSize (integer) dateInfo (string) identifications (string) departmentId (string)
get_info_contacts_by_id_detail	Returns contact details including customer info, properties, messages, attachments and classifications. IMPORTANT: not available for HiInbox contacts. The messages property is only present for HiChat, HiBot and HiMail. The classifications property is only present for HiChat and HiMail. Rate limit: 100 requests/minute.	id (string)
get_info_contacts_by_id_attachments_by_attachment_id	Downloads a single attachment file from a contact interaction. Returns binary content; the file name is exposed via Content-Disposition. Rate limit: 100 requests/minute.	id (string) attachmentId (string)
get_info_reports_dtbot_articlehits	Analytics on which knowledge base articles were accessed by users. Rate limit: 100 requests/minute. Paginated see X-Pagination- and Link response headers.	startDate (integer) required endDate (integer) required departmentId (string) required pageNumber (integer) pageSize (integer)
get_info_reports_dtbot_volumetry	Bot conversation metrics: dialog counts, transfer rates, user statistics and satisfaction indicators. Rate limit: 100 requests/minute. Paginated see X-Pagination- and Link response headers.	startDate (integer) required endDate (integer) required departmentId (string) required pageNumber (integer) pageSize (integer) groupBy (string)
get_info_reports_dtbot_evaluation	Customer satisfaction ratings for bot interactions grouped by form and period. Rate limit: 100 requests/minute.	startDate (integer) required endDate (integer) required departmentId (string) required groupBy (string) required formId (string) required viewMode (string) required
get_info_reports_dtbot_volume_retention	Bot traffic volume and customer retention statistics. Rate limit: 100 requests/minute.	startDate (integer) required endDate (integer) required departmentId (string) required groupby (string) required
get_info_reports_dtchat_queue	Real-time chat queue snapshot: customers waiting and wait time by department. Rate limit: 100 requests/minute.	departmentId (string)
get_info_reports_dtchat_volumetry	Chat traffic and performance metrics for a given date/interval. Rate limit: 100 requests/minute.	departmentId (string) date (integer) interval (string)
get_info_reports_platform_agentevents	Operator activity logs: login/logout, pauses, channel changes. Rate limit: 100 requests/minute. Paginated see X-Pagination- and Link response headers.	startDate (integer) required endDate (integer) required pageNumber (integer) pageSize (integer)
custom	Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body.	_url (string) required _method (string) _query (object) _body _headers (object)