# Authenticx Documentation > Use the Authenticx API to deliver call recordings, manage users, and retrieve important insights from your customer conversations. ## Guides - [Getting Started with Authenticx](https://authenticx.readme.io/docs/getting-started.md): This page will help you get started with Authenticx. You'll be up and running in a jiffy! - [How Authenticx Works](https://authenticx.readme.io/docs/how-authenticx-works.md): This diagram shows how customer interaction data moves through Authenticx, from source systems, through ingestion and secure storage, into AI processing, and then into the web application and optional outbound emissions. - [Navigating our Resources](https://authenticx.readme.io/docs/navigating-resources.md) - [Authenticx Terminology](https://authenticx.readme.io/docs/authenticx-terminology.md) - [AcxAPI](https://authenticx.readme.io/docs/acxapi.md): AcxAPI is Authenticxโ€™s REST API for integrating directly with the platform. Use it when you want to upload interactions, automate user/agent administration, or build workflows that trigger processing in Authenticx. - [Audio Interaction Metadata](https://authenticx.readme.io/docs/metadata-1.md) - [Chat Upload](https://authenticx.readme.io/docs/chat-metadata-api.md) - [Media Upload Format & Limitations](https://authenticx.readme.io/docs/media-upload-format-limitations.md) - [Media Upload Response Codes and Error Handling](https://authenticx.readme.io/docs/media-upload-error-handling-and-response-codes.md) - [Customer Automation Samples ](https://authenticx.readme.io/docs/customer-automation-samples.md): Customer Automation Samples is your integration launchpad, providing a hands-on collection of code to help you automate processes using the Authenticx API. - [Cloud Telephony](https://authenticx.readme.io/docs/cloud.md) - [Amazon Connect](https://authenticx.readme.io/docs/amazon-connect.md): Authenticx **out of the box connector** with **Amazon Connect**. Conversations can be seamlessly pulled directly from Amazon Connect into Authenticx via AWS public APIs. This simple, pre-configured integration minimizes setup efforts and enables quick adoption. - [Overview - Granular Permissions](https://authenticx.readme.io/docs/amazon-connect-granular-permissions.md): By leveraging AWS Identity and Access Management (IAM), we restrict API permissions to only essential actions and specific resources. This minimizes risk while ensuring compliance with industry-leading security standards. - [Authenticx Integration Configuration](https://authenticx.readme.io/docs/authenticx-integration-configuration.md): The essential information and steps required to configure Amazon Connect for integration with the Authenticx platform. The integration process involves retrieving specific details from your AWS account to enable seamless data sharing and functionality. - [Walkthrough - AWS Permissions & User Creation](https://authenticx.readme.io/docs/authenticx-amazon-connect-permissions-user-creation.md): This document provides a comprehensive step-by-step guide for creating the required AWS permission policy and user configuration for integrating Authenticx with Amazon Connect. By following these instructions, you can ensure the seamless setup of permissions for accessing and managing resources within your AWS environment. - [Five9](https://authenticx.readme.io/docs/five9.md) - [Advanced Recording Upload Configuration](https://authenticx.readme.io/docs/advanced-recording-upload-configuration.md) - [Genesys Cloud](https://authenticx.readme.io/docs/genesys.md): Authenticx offers an **out-of-the-box** connector with **Genesys**. Calls can be uploaded from Genesys, directly to Authenticx, via API. This is a simple, out-of-the-box configuration that can be completed with minimal technical lift. - [App Foundry - Authenticx Install Wizard](https://authenticx.readme.io/docs/genesys-cloud-install-wizard.md): Our install wizard simplifies the integration owith Genesys Cloud by guiding users through setup, queue selection, and configuration for seamless data transfer and conversation processing. - [Secure Account Creation](https://authenticx.readme.io/docs/secure-account-creation.md): The Genesys Cloud API allows for the creation of tenant accounts with fine-grained permissions and roles. This feature ensures that **Authenticx** has access only to the data explicitly permitted by you, enhancing security and minimizing data exposure. - [Granular Permissions Guide](https://authenticx.readme.io/docs/overview-granular-permissions.md): Genesys Cloud API allows the creation of tenant accounts with finely tuned permissions and roles. This feature enables Authenticx to access only the data explicitly permitted by you. - [Nice CXone](https://authenticx.readme.io/docs/nicecx-one.md): Authenticx offers an **out-of-the-box** connector with **NiceCXone**, enabling seamless integration of call and agent data directly into the Authenticx platform via NiceCX APIs. This pre-configured integration minimizes setup efforts and allows for quick adoption. - [CXone Configuration Requirements](https://authenticx.readme.io/docs/devone-application-process.md): Authenticx integrates with **NiceCX** to pull call and agent data into our systems using APIs. We act as a **Back-end** application on the DEVone platform. - [Set Up Vonage Contact Center Integration](https://authenticx.readme.io/docs/set-up-vonage-contact-center-integration.md): This guide walks you through connecting your Vonage Contact Center (VCC) account to Authenticx so we can ingest your recorded call conversations. - [Vonage Contact Center Integration Permissions](https://authenticx.readme.io/docs/vonage-contact-center-integration-permissions.md): This document covers the specific permissions Authenticx requests when connecting to Vonage Contact Center (VCC): what each permission is, which API it enables, and why it is required. It is designed to support security reviews and help customers apply the principle of least privilege when creating API credentials. - [TalkDesk Configuration Requirements](https://authenticx.readme.io/docs/talkdesk-configuration-requirements.md): Authenticx integrates with TalkDesk to pull call recordings and metadata into our systems using APIs. We connect using an OAuth 2.0 Client Credentials application, which allows us to access call data securely without requiring a named user login. - [CRM Integrations](https://authenticx.readme.io/docs/crm-systems.md): Authenticx integrates with leading CRM systems to bring conversation intelligence and patient insights directly into your customer relationship workflows. By connecting to the tools your teams already use, Authenticx helps improve customer experiences and simplify operations. - [Salesforce Data Enrichment](https://authenticx.readme.io/docs/salesforce-data-enrichment.md): Authenticx can automatically enrich every customer conversation with contextual data from your Salesforce instance or MuleSoft integration layer, pulling records in real time as each call, chat, or conversation is processed. - [Source Connector - Setup Overview](https://authenticx.readme.io/docs/salesforce-mulesoft-enrichment-setup-requirements.md): This page outlines what Authenticx needs from your team to configure per-conversation data enrichment. Requirements differ depending on whether Authenticx connects to your Salesforce org directly or through a MuleSoft API layer. - [Bidirectional Connector - Setup Guide](https://authenticx.readme.io/docs/bidirectional-connector-setup-guide.md) - [Salesforce Lightning App](https://authenticx.readme.io/docs/salesforce.md) - [Authenticx as an Auth Provider](https://authenticx.readme.io/docs/authenticx-as-an-auth-provider.md): This guide shows you how to configure Salesforce to use Authenticx as an OAuth2.0/OpenID Connect authentication provider. Once set up, your users can sign in via the Authenticx platform. - [Creating External Credentials](https://authenticx.readme.io/docs/creating-external-credentials.md): This guide walks you through setting up an External Credential in Salesforce for integration with Authenticx. This step follows completion of the **Authenticx as an Auth Provider** setup. - [Creating Named Credentials](https://authenticx.readme.io/docs/creating-a-named-credential.md): This guide outlines how to create a **Named Credential** in Salesforce to finalize your connection to Authenticx after configuring your External Credential and Auth Provider. This step follows completion of the **Creating External Credentials** setup. - [Installing Authenticx for Salesforce](https://authenticx.readme.io/docs/installing-authenticx-for-salesforce.md): After purchasing the Authenticx for Salesforce add-on, you can install the managed package from the Salesforce AppExchange. ## API Reference - [AcxAPI Overview](https://authenticx.readme.io/reference/acxapi.md): Authenticx's conversation intelligence API providing programmatic access to Conversation Insights, Evaluations, User Management, and beyond. - [Tips for Traversing the AcxAPI](https://authenticx.readme.io/reference/acxapi-traversal.md) - [Retrieving an Access Token](https://authenticx.readme.io/reference/retrieving-an-access-token.md) - [Authorizing Requests](https://authenticx.readme.io/reference/authorizing-requests.md) - [Conversational Data & Insights](https://authenticx.readme.io/reference/conversation-data-insights.md) - [Conversations](https://authenticx.readme.io/reference/conversations.md) - [Gets a list of classifiers](https://authenticx.readme.io/reference/get_conversations-classifiers.md) - [Get classifier results for conversations based on filter criteria](https://authenticx.readme.io/reference/get_conversations-insights.md): Returns a list of classifier results for conversations with Status of "Sampled" or "ReadyToSample" that match the specified criteria. Requests without any classifier or hierarchy filters may span up to 7 days. Supplying at least one of ClassifierIds, HierarchyIds, HierarchyCodes, ClassifierCategoryNames, or ClassifierTypes extends the maximum date range to 31 days. Use GET /Conversations/Classifiers to discover valid classifier IDs. Use GET /Hierarchy/All to discover valid hierarchy IDs and hierarchy codes. - [Post hierarchyIds, hierarchyCodes, or classifierIds to filter on classifier results.](https://authenticx.readme.io/reference/post_conversations-insights-1.md): Returns a list of classifier results for conversations with Status of "Sampled" or "ReadyToSample" that match the specified criteria. - [Evaluations](https://authenticx.readme.io/reference/evaluations.md) - [Get Evaluations](https://authenticx.readme.io/reference/get_evaluations.md): Gets a list of evaluations - [Get Evaluations with their modules](https://authenticx.readme.io/reference/get_evaluations-modules.md): Gets a list of evaluations with their associated modules - [Get Interaction](https://authenticx.readme.io/reference/get_interactions-amdid.md): Deprecated. Please use `/Conversations/Insights` instead. Returns the interaction's status, and if completed, additional information describing the interaction. - [Get Interactions based on filter criteria](https://authenticx.readme.io/reference/get_interactions.md): Deprecated. Please use `/Conversations/Insights` instead. Returns a list of interactions that have finished processing and match the specified criteria. - [Get Interactions based on filter criteria.](https://authenticx.readme.io/reference/post_interactions.md): Deprecated. Please use `/Conversations/Insights` instead. Returns a list of interactions that have finished processing and match the specified criteria. - [Metadata](https://authenticx.readme.io/reference/metadata.md) - [Get Metadata](https://authenticx.readme.io/reference/get_metadata.md): Gets a list of Metadata objects - [Post Metadata](https://authenticx.readme.io/reference/post_metadata.md): Return a list of Metadata with specified criteria. - [Patch Metadata](https://authenticx.readme.io/reference/patch_metadata-id.md): Updates a target metadata object with the provided values. Performs a patch operation that will overwrite existing values with those provided. - [Pharmacovigilance (PV) Data Reconciliation](https://authenticx.readme.io/reference/receipts.md) - [Get Receipts based on filter criteria](https://authenticx.readme.io/reference/get_receipts.md): Returns a list of receipts for interactions that have finished processing and match the specified criteria. Each result in the response includes the following fields: - ConversationId: Unique identifier for the conversation. Corresponds to the Id field from GET /Metadata and the ConversationId from GET /Conversations/Insights - DateTimeReceived: The date/time the interaction arrived in the system - ClientCallId: Your external telephony reference ID for this conversation - DateTimeTransmitted: The date/time the export attempt was transmitted - ReceiptId: The receipt ID returned from the downstream system - SafetyEvent: Safety event classification result from the export - AdverseEvent: Adverse event classification result from the export - ProductQualityComplaint: Product quality complaint result from the export - uid: The external system UID returned from the export endpoint - [Get Model Results based on filter criteria](https://authenticx.readme.io/reference/get_modelresults-1.md): Returns a list of model results for the specified criteria including ML predictions and human review results. modelIds must contain active model IDs for your organization. Use GET /Conversations/Classifiers to discover valid modelIds for your organization. Use GET /Hierarchy/All to discover valid hierarchyCodes for your organization. This endpoint uses cursor-based pagination. Pass the lastId from the final item in a page to retrieve the next page. When includeUnprocessedMedia=true, the response may include conversations whose mediaStatus is Processed, NotProcessed, or FailedToProcess. Unprocessed conversations return mediaStatus details with modelResults set to null. Requests earlier than 2025-10-01 are automatically clamped to 2025-10-01. - [Get Model Results for one or more specific conversations](https://authenticx.readme.io/reference/get_modelresults-conversation-1.md): Returns all model results for conversations matching the provided Conversation Ids or Client Call Ids. modelIds is required and must contain active model IDs for your organization. At least one of conversationIds or clientCallIds must also be supplied. When both conversationIds and clientCallIds are provided, results for any conversation matching either set of identifiers are returned. Maximum 100 IDs per parameter. Use this endpoint when you already know the Authenticx ConversationId from GET /Metadata or your own source-system ClientCallId and want the latest available model results for those specific conversations. Set includeUnprocessedMedia=true to also return conversations that are still processing or failed to process. - [Transcriptions](https://authenticx.readme.io/reference/transcriptions.md) - [Get Single Conversation Transcriptions](https://authenticx.readme.io/reference/get_conversations-transcriptions-conversationid.md): Returns the transcriptions for a conversation identified by its unique ID. If the conversation has not finished processing, returns 200 with a message. If the conversation failed to process, returns 400 with a message. - [Get Batched Conversation Transcriptions](https://authenticx.readme.io/reference/post_conversations-transcriptions.md): Returns the transcriptions for multiple conversations identified by their unique IDs. Up to 100 conversation IDs are accepted per request. Duplicate IDs are ignored. Response includes: - transcriptions: successful items - errors: failed items, each with a statusCode indicating why it failed * 404 = conversation not found * 400 = failed to process * 200 = not processed or still processing (message included) Example request: { "conversationIds": [ "b1a9e4d6-7c3a-4e91-9342-835ec9d4f7b1", "ad5b1e2f-08b9-4b23-9e0c-d1a1c3eafc2f" ] } Example response: { "transcriptions": [ { "conversationId": "b1a9e4d6-7c3a-4e91-9342-835ec9d4f7b1", "transcriptions": [ { "languageCode": "en", "transcription": [ "00:00 Agent: Hello", "00:03 Customer: Hi" ] } ] } ], "errors": [ { "conversationId": "ad5b1e2f-08b9-4b23-9e0c-d1a1c3eafc2f", "statusCode": 404, "error": "Conversation not found" } ] } - [Workflows](https://authenticx.readme.io/reference/workflows.md) - [Get Workflows](https://authenticx.readme.io/reference/get_workflows.md): Gets a list of Workflow objects in a given date range. - [Conversation Uploads](https://authenticx.readme.io/reference/conversation-uploads.md) - [Upload Text Media](https://authenticx.readme.io/reference/post_textmedia-upload.md): Uploads a text media interaction into storage for processing. *Param name "file"* Text file uploaded from client. Valid File Extensions: - .json - .json_chat *Param name "metadata"* JSON object containing multiple metadata fields for the text media File: > ๐Ÿ“˜ **Note:** Including the ```Id``` field is recommended. If omitted, one is generated for you, but providing your own lets you correlate with your system. - Id: Unique identifier for the text media. example: "4834c9e9-74f2-4bfe-a0c8-ce947a4f30e3" - FilePath: Path containing file name and extension. Subdirectories specifying a more exact path may be prepended to the file. If omitted, the system derives a path from the ```Id```. name. Examples: -- With subdirectories: "topfolder/subfolder/subsubfolder/filename.json" -- Without subdirectories: "filename.json" - TimeStamp: Time stamp of the interaction. Examples: "2022-03-18T21:52:26", "2022-03-18T21:52:26.8816090Z", "2022-03-19", "2022-03-18T17:56:09.8683110-04:00" - CallDirection: Direction of the interaction's call to or from the call center. Examples: -- "Inbound" -- "Outbound" - Name: Name associated with interaction. Example: -- "Alice" - Phone: Phone number associated with interaction. Example: --"800-555-5555" - AgentFirstName: Agent's First Name associated with interaction. Example: --"James" - AgentLastName: Agent's Last Name associated with interaction. Example: --"Bond" - AgentCode: Agent Code for associating agent already in system with interaction. Example: --"007" - ExtendedMetadata: Array of Dictionaries of key values associated with interaction Examples: -- [{ "Data": "Example Data"}, { "Data2": "Example Data 2", "ExampleKey": "Example Value" }] - HierarchyId: Id of hierarchy to associate with this interaction Example: -- "00000000-0000-0000-0000-000000000002" - HierarchyCode: Internal Organization Code for associating hierarchy with this interaction Example: -- "Accounting" - ApplyHierarchyToAgent: If we want the hierarchy that is passed in to also be applied to the agent then true Example: -- true - LocaleId: Specifies the language of the interaction using a locale ID. Defaults to ```1033``` (English) if omitted. - [Upload Media](https://authenticx.readme.io/reference/post_media-upload.md): Uploads an audio file interaction into storage for processing. *Param name "file"* Audio file uploaded from client (required unless signedUrl is provided). Valid Audio File Extensions: - .wav - .mp3 - .mp4 - .ogg - .opus - .m4a Valid Chat File Extensions: - .tar - .zip *Param name "signedUrl"* Optional signed download URL. If provided, the server downloads the file from this URL instead of using multipart upload. Supports signed URLs from AWS S3, Azure Blob Storage, etc. Example: "https://bucket.s3.amazonaws.com/path/to/file.mp3?X-Amz-Algorithm=..." or "https://storage.azure.com/container/blob?sv=..." *Param name "metadata"* JSON dictionary containing multiple metadata fields about the Audio File: Required Fields: - FileName: Path containing file name and extension (extension must match the uploaded file). Subdirectories specifying a more exact path may be prepended to the file name. Examples: -- With subdirectories: "topfolder/subfolder/subsubfolder/filename.mp3" -- Without subdirectories: "filename.mp3" - UploadType: Type indicating if you are uploding a chat or audio file. Examples: -- "Chat" -- "Audio" Optional Fields: - CallDirection: Direction of the interaction's call to or from the call center. Examples: -- "Inbound" -- "Outbound" - Name: Name associated with interaction. Example: -- "Alice" - Phone: Phone number associated with interaction. Example: --"800-555-5555" - Email: Email address associated with interaction. Example: --"example@example.com" - AgentFirstName: Agent's First Name associated with interaction. Example: --"James" - AgentLastName: Agent's Last Name associated with interaction. Example: --"Bond" - AgentCode: Agent Code for associating agent already in system with interaction. Example: --"007" - InteractionDate: Date on which interaction occured. ISO-8601 Examples: --UTC datetime: "2022-03-18T21:52:26" --UTC datetime with milliseconds: "2022-03-18T21:52:26.8816090Z" --UTC date only: "2022-03-19" --datetime with timezone: "2022-03-18T17:56:09.8683110-04:00" - ExtendedMetadata: [Deprecated - ("Use ExtendedMetadataValues")] Array of Dictionaries of key values associated with interaction. Examples: -- [{ "Data": "Example Data"}, { "Data2": "Example Data 2", "ExampleKey": "Example Value" }] - ExtendedMetadataValues: Dictionary of key values associated with interaction. Examples: -- { "Data": "Example Data" }, { "Data2": "Example Data 2" }, { "ExampleKey": "Example Value" } - HierarchyId: Id of hierarchy to associate with this interaction. Example: -- "00000000-0000-0000-0000-000000000002" - HierarchyCode: Internal Organization Code for associating hierarchy with this interaction. Example: -- "Accounting" - ApplyHierarchyToAgent: If ```true``` AND a ```HierarchyId``` / ```HierarchyCode``` are provided, the system assigns that hierarchy to the agent . Example: -- true - LocaleId: Specifies the language of the interaction using a locale ID. Defaults to ```1033``` (English) if omitted. - ClientCallId: Your external telephony reference ID. Example: -- "5CD1S" - [User & Access Management](https://authenticx.readme.io/reference/user-agent-management.md) - [Agent](https://authenticx.readme.io/reference/agent.md) - [Get All Agents](https://authenticx.readme.io/reference/get_agent-all.md): Returns a list of all agents in your organization. - [Get Agent](https://authenticx.readme.io/reference/get_agent-agentid.md): Returns the agent with the id specified in the url. - [Update Agent](https://authenticx.readme.io/reference/put_agent-agentid.md): Updates information about an existing agent in your organization. - [Create Agent](https://authenticx.readme.io/reference/post_agent.md): Adds an agent to your organization. - [Hierarchy](https://authenticx.readme.io/reference/hierarchy.md) - [Get All Hierarchies](https://authenticx.readme.io/reference/get_hierarchy-all.md): Returns a list of all active hierarchies in your organization along with their contacts. - [Create Hierarchy](https://authenticx.readme.io/reference/post_hierarchy.md): Adds a hierarchy to your organization. - [Update Hierarchy](https://authenticx.readme.io/reference/put_hierarchy-hierarchyid.md): Updates information about an existing hierarchy in your organization. - [Roles](https://authenticx.readme.io/reference/roles.md) - [Get All Roles](https://authenticx.readme.io/reference/get_roles-all.md): Returns a list of all roles in your organization along with their permissions and each permission's description. - [User](https://authenticx.readme.io/reference/user.md) - [Get User By UserName](https://authenticx.readme.io/reference/get_user-2.md): Returns the user with the username specified in the query string. - [Get All Users](https://authenticx.readme.io/reference/get_user-all.md): Returns a list of all users in your organization. - [Get User](https://authenticx.readme.io/reference/get_user-userid.md): Returns the user with the id specified in the url. - [Update User](https://authenticx.readme.io/reference/put_user-userid.md): Updates information about an existing user in your organization. - [Create User](https://authenticx.readme.io/reference/post_user.md): Adds a user to your organization. - [UserHierarchy](https://authenticx.readme.io/reference/userhierarchy.md) - [Get All Hierarchy Permissions For User](https://authenticx.readme.io/reference/get_userhierarchy-userid-all.md): Returns a list of all active hierarchies along with the specified user's permissions for each hierarchy - [Get Hierarchy Permissions For User](https://authenticx.readme.io/reference/get_userhierarchy-userid-hierarchyid.md): Returns a list of all permissions within a hierarchy for the specified user. - [Update Hierarchy Permissions For User](https://authenticx.readme.io/reference/put_userhierarchy-userid-hierarchyid.md): Updates a user's permissions within a specified hierarchy. - [Get All Resource Types](https://authenticx.readme.io/reference/get_scim-v2-resourcetypes.md): Returns, in ListResponse format, all the resource types defined by Authenticx - [Get Resource Type](https://authenticx.readme.io/reference/get_scim-v2-resourcetypes-resourcetypeid.md): Returns one resource type specified by the resource type id. - [Get All Schemas](https://authenticx.readme.io/reference/get_scim-v2-schemas.md): Returns, in ListResponse format, all the schemas defined by Authenticx - [Get Schema](https://authenticx.readme.io/reference/get_scim-v2-schemas-schemauri.md): Returns one schema specified by the schema uri. - [Get Service Provider Config](https://authenticx.readme.io/reference/get_scim-v2-serviceproviderconfig.md): Returns the Authenticx service provider config - [Get Users](https://authenticx.readme.io/reference/get_scim-v2-users.md): Returns the list of all users in scim user schema format. Supports, filtering, sorting, pagination, and attribute picking as defined in rfc 7644. - [Create User](https://authenticx.readme.io/reference/post_scim-v2-users.md): Creates a user with the provided information. - [Get User](https://authenticx.readme.io/reference/get_scim-v2-users-userid.md): Gets a specific user by their id. - [Delete User](https://authenticx.readme.io/reference/delete_scim-v2-users-userid.md): This action does not delete the user record from the database, it marks the `disabled` field as `true`. Therefore, any attempts to create a user with the same user name as an existing, deleted user, will fail. - [Update User](https://authenticx.readme.io/reference/put_scim-v2-users-userid.md): Updates a user with specified id with the provided information. - [Patch User](https://authenticx.readme.io/reference/patch_scim-v2-users-userid.md) - [Get All Resource Types](https://authenticx.readme.io/reference/get_scim-v2-resourcetypes-1.md): Returns, in ListResponse format, all the resource types defined by Authenticx - [Get Resource Type](https://authenticx.readme.io/reference/get_scim-v2-resourcetypes-resourcetypeid-1.md): Returns one resource type specified by the resource type id. - [Get All Schemas](https://authenticx.readme.io/reference/get_scim-v2-schemas-1.md): Returns, in ListResponse format, all the schemas defined by Authenticx - [Get Schema](https://authenticx.readme.io/reference/get_scim-v2-schemas-schemauri-1.md): Returns one schema specified by the schema uri. - [Get Service Provider Config](https://authenticx.readme.io/reference/get_scim-v2-serviceproviderconfig-1.md): Returns the Authenticx service provider config - [Get Users](https://authenticx.readme.io/reference/get_scim-v2-users-1.md): Returns the list of all users in scim user schema format. Supports, filtering, sorting, pagination, and attribute picking as defined in rfc 7644. - [Create User](https://authenticx.readme.io/reference/post_scim-v2-users-1.md): Creates a user with the provided information. - [Get User](https://authenticx.readme.io/reference/get_scim-v2-users-userid-1.md): Gets a specific user by their id. - [Delete User](https://authenticx.readme.io/reference/delete_scim-v2-users-userid-1.md): This action does not delete the user record from the database, it marks the `disabled` field as `true`. Therefore, any attempts to create a user with the same user name as an existing, deleted user, will fail. - [Update User](https://authenticx.readme.io/reference/put_scim-v2-users-userid-1.md): Updates a user with specified id with the provided information. - [Patch User](https://authenticx.readme.io/reference/patch_scim-v2-users-userid-1.md) - [Get All Agents](https://authenticx.readme.io/reference/get_agent-all-1.md): Returns a list of all agents in your organization. - [Get Agent](https://authenticx.readme.io/reference/get_agent-agentid-1.md): Returns the agent with the id specified in the url. - [Update Agent](https://authenticx.readme.io/reference/put_agent-agentid-1.md): Updates information about an existing agent in your organization. - [Create Agent](https://authenticx.readme.io/reference/post_agent-1.md): Adds an agent to your organization. - [Gets a list of classifiers](https://authenticx.readme.io/reference/get_conversations-classifiers-1.md) - [Get classifier results for conversations based on filter criteria](https://authenticx.readme.io/reference/get_conversations-insights-1.md): Returns a list of classifier results for conversations with Status of "Sampled" or "ReadyToSample" that match the specified criteria. Requests without any classifier or hierarchy filters may span up to 7 days. Supplying at least one of ClassifierIds, HierarchyIds, HierarchyCodes, ClassifierCategoryNames, or ClassifierTypes extends the maximum date range to 31 days. Use GET /Conversations/Classifiers to discover valid classifier IDs. Use GET /Hierarchy/All to discover valid hierarchy IDs and hierarchy codes. - [Post hierarchyIds, hierarchyCodes, or classifierIds to filter on classifier results.](https://authenticx.readme.io/reference/post_conversations-insights.md): Returns a list of classifier results for conversations with Status of "Sampled" or "ReadyToSample" that match the specified criteria. - [Get Single Conversation Transcriptions](https://authenticx.readme.io/reference/get_conversations-transcriptions-conversationid-1.md): Returns the transcriptions for a conversation identified by its unique ID. If the conversation has not finished processing, returns 200 with a message. If the conversation failed to process, returns 400 with a message. - [Get Batched Conversation Transcriptions](https://authenticx.readme.io/reference/post_conversations-transcriptions-1.md): Returns the transcriptions for multiple conversations identified by their unique IDs. Up to 100 conversation IDs are accepted per request. Duplicate IDs are ignored. Response includes: - transcriptions: successful items - errors: failed items, each with a statusCode indicating why it failed * 404 = conversation not found * 400 = failed to process * 200 = not processed or still processing (message included) Example request: { "conversationIds": [ "b1a9e4d6-7c3a-4e91-9342-835ec9d4f7b1", "ad5b1e2f-08b9-4b23-9e0c-d1a1c3eafc2f" ] } Example response: { "transcriptions": [ { "conversationId": "b1a9e4d6-7c3a-4e91-9342-835ec9d4f7b1", "transcriptions": [ { "languageCode": "en", "transcription": [ "00:00 Agent: Hello", "00:03 Customer: Hi" ] } ] } ], "errors": [ { "conversationId": "ad5b1e2f-08b9-4b23-9e0c-d1a1c3eafc2f", "statusCode": 404, "error": "Conversation not found" } ] } - [Get Evaluations](https://authenticx.readme.io/reference/get_evaluations-1.md): Gets a list of evaluations - [Get Evaluations with their modules](https://authenticx.readme.io/reference/get_evaluations-modules-1.md): Gets a list of evaluations with their associated modules - [Get All Hierarchies](https://authenticx.readme.io/reference/get_hierarchy-all-1.md): Returns a list of all active hierarchies in your organization along with their contacts. - [Create Hierarchy](https://authenticx.readme.io/reference/post_hierarchy-1.md): Adds a hierarchy to your organization. - [Update Hierarchy](https://authenticx.readme.io/reference/put_hierarchy-hierarchyid-1.md): Updates information about an existing hierarchy in your organization. - [Get Interaction](https://authenticx.readme.io/reference/get_interactions-amdid-1.md): Deprecated. Please use `/Conversations/Insights` instead. Returns the interaction's status, and if completed, additional information describing the interaction. - [Get Interactions based on filter criteria](https://authenticx.readme.io/reference/get_interactions-1.md): Deprecated. Please use `/Conversations/Insights` instead. Returns a list of interactions that have finished processing and match the specified criteria. - [Get Interactions based on filter criteria.](https://authenticx.readme.io/reference/post_interactions-1.md): Deprecated. Please use `/Conversations/Insights` instead. Returns a list of interactions that have finished processing and match the specified criteria. - [Upload Text Media](https://authenticx.readme.io/reference/post_textmedia-upload-1.md): Uploads a text media interaction into storage for processing. *Param name "file"* Text file uploaded from client. Valid File Extensions: - .json - .json_chat *Param name "metadata"* JSON object containing multiple metadata fields for the text media File: > ๐Ÿ“˜ **Note:** Including the ```Id``` field is recommended. If omitted, one is generated for you, but providing your own lets you correlate with your system. - Id: Unique identifier for the text media. example: "4834c9e9-74f2-4bfe-a0c8-ce947a4f30e3" - FilePath: Path containing file name and extension. Subdirectories specifying a more exact path may be prepended to the file. If omitted, the system derives a path from the ```Id```. name. Examples: -- With subdirectories: "topfolder/subfolder/subsubfolder/filename.json" -- Without subdirectories: "filename.json" - TimeStamp: Time stamp of the interaction. Examples: "2022-03-18T21:52:26", "2022-03-18T21:52:26.8816090Z", "2022-03-19", "2022-03-18T17:56:09.8683110-04:00" - CallDirection: Direction of the interaction's call to or from the call center. Examples: -- "Inbound" -- "Outbound" - Name: Name associated with interaction. Example: -- "Alice" - Phone: Phone number associated with interaction. Example: --"800-555-5555" - AgentFirstName: Agent's First Name associated with interaction. Example: --"James" - AgentLastName: Agent's Last Name associated with interaction. Example: --"Bond" - AgentCode: Agent Code for associating agent already in system with interaction. Example: --"007" - ExtendedMetadata: Array of Dictionaries of key values associated with interaction Examples: -- [{ "Data": "Example Data"}, { "Data2": "Example Data 2", "ExampleKey": "Example Value" }] - HierarchyId: Id of hierarchy to associate with this interaction Example: -- "00000000-0000-0000-0000-000000000002" - HierarchyCode: Internal Organization Code for associating hierarchy with this interaction Example: -- "Accounting" - ApplyHierarchyToAgent: If we want the hierarchy that is passed in to also be applied to the agent then true Example: -- true - LocaleId: Specifies the language of the interaction using a locale ID. Defaults to ```1033``` (English) if omitted. - [Upload Media](https://authenticx.readme.io/reference/post_media-upload-1.md): Uploads an audio file interaction into storage for processing. *Param name "file"* Audio file uploaded from client (required unless signedUrl is provided). Valid Audio File Extensions: - .wav - .mp3 - .mp4 - .ogg - .opus - .m4a Valid Chat File Extensions: - .tar - .zip *Param name "signedUrl"* Optional signed download URL. If provided, the server downloads the file from this URL instead of using multipart upload. Supports signed URLs from AWS S3, Azure Blob Storage, etc. Example: "https://bucket.s3.amazonaws.com/path/to/file.mp3?X-Amz-Algorithm=..." or "https://storage.azure.com/container/blob?sv=..." *Param name "metadata"* JSON dictionary containing multiple metadata fields about the Audio File: Required Fields: - FileName: Path containing file name and extension (extension must match the uploaded file). Subdirectories specifying a more exact path may be prepended to the file name. Examples: -- With subdirectories: "topfolder/subfolder/subsubfolder/filename.mp3" -- Without subdirectories: "filename.mp3" - UploadType: Type indicating if you are uploding a chat or audio file. Examples: -- "Chat" -- "Audio" Optional Fields: - CallDirection: Direction of the interaction's call to or from the call center. Examples: -- "Inbound" -- "Outbound" - Name: Name associated with interaction. Example: -- "Alice" - Phone: Phone number associated with interaction. Example: --"800-555-5555" - Email: Email address associated with interaction. Example: --"example@example.com" - AgentFirstName: Agent's First Name associated with interaction. Example: --"James" - AgentLastName: Agent's Last Name associated with interaction. Example: --"Bond" - AgentCode: Agent Code for associating agent already in system with interaction. Example: --"007" - InteractionDate: Date on which interaction occured. ISO-8601 Examples: --UTC datetime: "2022-03-18T21:52:26" --UTC datetime with milliseconds: "2022-03-18T21:52:26.8816090Z" --UTC date only: "2022-03-19" --datetime with timezone: "2022-03-18T17:56:09.8683110-04:00" - ExtendedMetadata: [Deprecated - ("Use ExtendedMetadataValues")] Array of Dictionaries of key values associated with interaction. Examples: -- [{ "Data": "Example Data"}, { "Data2": "Example Data 2", "ExampleKey": "Example Value" }] - ExtendedMetadataValues: Dictionary of key values associated with interaction. Examples: -- { "Data": "Example Data" }, { "Data2": "Example Data 2" }, { "ExampleKey": "Example Value" } - HierarchyId: Id of hierarchy to associate with this interaction. Example: -- "00000000-0000-0000-0000-000000000002" - HierarchyCode: Internal Organization Code for associating hierarchy with this interaction. Example: -- "Accounting" - ApplyHierarchyToAgent: If ```true``` AND a ```HierarchyId``` / ```HierarchyCode``` are provided, the system assigns that hierarchy to the agent . Example: -- true - LocaleId: Specifies the language of the interaction using a locale ID. Defaults to ```1033``` (English) if omitted. - ClientCallId: Your external telephony reference ID. Example: -- "5CD1S" - [Get Metadata](https://authenticx.readme.io/reference/get_metadata-1.md): Gets a list of Metadata objects - [Post Metadata](https://authenticx.readme.io/reference/post_metadata-1.md): Return a list of Metadata with specified criteria. - [Patch Metadata](https://authenticx.readme.io/reference/patch_metadata-id-1.md): Updates a target metadata object with the provided values. Performs a patch operation that will overwrite existing values with those provided. - [Get Model Results for one or more specific conversations](https://authenticx.readme.io/reference/get_modelresults-conversation.md): Returns all model results for conversations matching the provided Conversation Ids or Client Call Ids. modelIds is required and must contain active model IDs for your organization. At least one of conversationIds or clientCallIds must also be supplied. When both conversationIds and clientCallIds are provided, results for any conversation matching either set of identifiers are returned. Maximum 100 IDs per parameter. Use this endpoint when you already know the Authenticx ConversationId from GET /Metadata or your own source-system ClientCallId and want the latest available model results for those specific conversations. Set includeUnprocessedMedia=true to also return conversations that are still processing or failed to process. - [Get Model Results based on filter criteria](https://authenticx.readme.io/reference/get_modelresults.md): Returns a list of model results for the specified criteria including ML predictions and human review results. modelIds must contain active model IDs for your organization. Use GET /Conversations/Classifiers to discover valid modelIds for your organization. Use GET /Hierarchy/All to discover valid hierarchyCodes for your organization. This endpoint uses cursor-based pagination. Pass the lastId from the final item in a page to retrieve the next page. When includeUnprocessedMedia=true, the response may include conversations whose mediaStatus is Processed, NotProcessed, or FailedToProcess. Unprocessed conversations return mediaStatus details with modelResults set to null. Requests earlier than 2025-10-01 are automatically clamped to 2025-10-01. - [Get Receipts based on filter criteria](https://authenticx.readme.io/reference/get_receipts-1.md): Returns a list of receipts for interactions that have finished processing and match the specified criteria. Each result in the response includes the following fields: - ConversationId: Unique identifier for the conversation. Corresponds to the Id field from GET /Metadata and the ConversationId from GET /Conversations/Insights - DateTimeReceived: The date/time the interaction arrived in the system - ClientCallId: Your external telephony reference ID for this conversation - DateTimeTransmitted: The date/time the export attempt was transmitted - ReceiptId: The receipt ID returned from the downstream system - SafetyEvent: Safety event classification result from the export - AdverseEvent: Adverse event classification result from the export - ProductQualityComplaint: Product quality complaint result from the export - uid: The external system UID returned from the export endpoint - [Get All Roles](https://authenticx.readme.io/reference/get_roles-all-1.md): Returns a list of all roles in your organization along with their permissions and each permission's description. - [Get User By UserName](https://authenticx.readme.io/reference/get_user.md): Returns the user with the username specified in the query string. - [Get User](https://authenticx.readme.io/reference/get_user-userid-1.md): Returns the user with the id specified in the url. - [Get All Users](https://authenticx.readme.io/reference/get_user-all-1.md): Returns a list of all users in your organization. - [Update User](https://authenticx.readme.io/reference/put_user-userid-1.md): Updates information about an existing user in your organization. - [Create User](https://authenticx.readme.io/reference/post_user-1.md): Adds a user to your organization. - [Get All Hierarchy Permissions For User](https://authenticx.readme.io/reference/get_userhierarchy-userid-all-1.md): Returns a list of all active hierarchies along with the specified user's permissions for each hierarchy - [Get Hierarchy Permissions For User](https://authenticx.readme.io/reference/get_userhierarchy-userid-hierarchyid-1.md): Returns a list of all permissions within a hierarchy for the specified user. - [Update Hierarchy Permissions For User](https://authenticx.readme.io/reference/put_userhierarchy-userid-hierarchyid-1.md): Updates a user's permissions within a specified hierarchy. - [Get Workflows](https://authenticx.readme.io/reference/get_workflows-1.md): Gets a list of Workflow objects in a given date range. - [Create Agent](https://authenticx.readme.io/reference/post_agent-2.md): Adds an agent to your organization. - [Get Agent](https://authenticx.readme.io/reference/get_agent-agentid-2.md): Returns the agent with the id specified in the url. - [Update Agent](https://authenticx.readme.io/reference/put_agent-agentid-2.md): Updates information about an existing agent in your organization. - [Get All Agents](https://authenticx.readme.io/reference/get_agent-all-2.md): Returns a list of all agents in your organization. - [Gets a list of classifiers](https://authenticx.readme.io/reference/get_conversations-classifiers-2.md) - [Get classifier results for conversations based on filter criteria](https://authenticx.readme.io/reference/get_conversations-insights-2.md): Returns a list of classifier results for conversations with Status of "Sampled" or "ReadyToSample" that match the specified criteria. Requests without any classifier or hierarchy filters may span up to 7 days. Supplying at least one of ClassifierIds, HierarchyIds, HierarchyCodes, ClassifierCategoryNames, or ClassifierTypes extends the maximum date range to 31 days. Use GET /Conversations/Classifiers to discover valid classifier IDs. Use GET /Hierarchy/All to discover valid hierarchy IDs and hierarchy codes. - [Post hierarchyIds, hierarchyCodes, or classifierIds to filter on classifier results.](https://authenticx.readme.io/reference/post_conversations-insights-2.md): Returns a list of classifier results for conversations with Status of "Sampled" or "ReadyToSample" that match the specified criteria. - [Get Batched Conversation Transcriptions](https://authenticx.readme.io/reference/post_conversations-transcriptions-2.md): Returns the transcriptions for multiple conversations identified by their unique IDs. Up to 100 conversation IDs are accepted per request. Duplicate IDs are ignored. Response includes: - transcriptions: successful items - errors: failed items, each with a statusCode indicating why it failed * 404 = conversation not found * 400 = failed to process * 200 = not processed or still processing (message included) Example request: { "conversationIds": [ "b1a9e4d6-7c3a-4e91-9342-835ec9d4f7b1", "ad5b1e2f-08b9-4b23-9e0c-d1a1c3eafc2f" ] } Example response: { "transcriptions": [ { "conversationId": "b1a9e4d6-7c3a-4e91-9342-835ec9d4f7b1", "transcriptions": [ { "languageCode": "en", "transcription": [ "00:00 Agent: Hello", "00:03 Customer: Hi" ] } ] } ], "errors": [ { "conversationId": "ad5b1e2f-08b9-4b23-9e0c-d1a1c3eafc2f", "statusCode": 404, "error": "Conversation not found" } ] } - [Get Single Conversation Transcriptions](https://authenticx.readme.io/reference/get_conversations-transcriptions-conversationid-2.md): Returns the transcriptions for a conversation identified by its unique ID. If the conversation has not finished processing, returns 200 with a message. If the conversation failed to process, returns 400 with a message. - [Get Evaluations](https://authenticx.readme.io/reference/get_evaluations-2.md): Gets a list of evaluations - [Get Evaluations with their modules](https://authenticx.readme.io/reference/get_evaluations-modules-2.md): Gets a list of evaluations with their associated modules - [Create Hierarchy](https://authenticx.readme.io/reference/post_hierarchy-2.md): Adds a hierarchy to your organization. - [Update Hierarchy](https://authenticx.readme.io/reference/put_hierarchy-hierarchyid-2.md): Updates information about an existing hierarchy in your organization. - [Get All Hierarchies](https://authenticx.readme.io/reference/get_hierarchy-all-2.md): Returns a list of all active hierarchies in your organization along with their contacts. - [Get Interactions based on filter criteria](https://authenticx.readme.io/reference/get_interactions-2.md): Deprecated. Please use `/Conversations/Insights` instead. Returns a list of interactions that have finished processing and match the specified criteria. - [Get Interactions based on filter criteria.](https://authenticx.readme.io/reference/post_interactions-2.md): Deprecated. Please use `/Conversations/Insights` instead. Returns a list of interactions that have finished processing and match the specified criteria. - [Get Interaction](https://authenticx.readme.io/reference/get_interactions-amdid-2.md): Deprecated. Please use `/Conversations/Insights` instead. Returns the interaction's status, and if completed, additional information describing the interaction. - [Upload Media](https://authenticx.readme.io/reference/post_media-upload-2.md): Uploads an audio file interaction into storage for processing. *Param name "file"* Audio file uploaded from client (required unless signedUrl is provided). Valid Audio File Extensions: - .wav - .mp3 - .mp4 - .ogg - .opus - .m4a Valid Chat File Extensions: - .tar - .zip *Param name "signedUrl"* Optional signed download URL. If provided, the server downloads the file from this URL instead of using multipart upload. Supports signed URLs from AWS S3, Azure Blob Storage, etc. Example: "https://bucket.s3.amazonaws.com/path/to/file.mp3?X-Amz-Algorithm=..." or "https://storage.azure.com/container/blob?sv=..." *Param name "metadata"* JSON dictionary containing multiple metadata fields about the Audio File: Required Fields: - FileName: Path containing file name and extension (extension must match the uploaded file). Subdirectories specifying a more exact path may be prepended to the file name. Examples: -- With subdirectories: "topfolder/subfolder/subsubfolder/filename.mp3" -- Without subdirectories: "filename.mp3" - UploadType: Type indicating if you are uploding a chat or audio file. Examples: -- "Chat" -- "Audio" Optional Fields: - CallDirection: Direction of the interaction's call to or from the call center. Examples: -- "Inbound" -- "Outbound" - Name: Name associated with interaction. Example: -- "Alice" - Phone: Phone number associated with interaction. Example: --"800-555-5555" - Email: Email address associated with interaction. Example: --"example@example.com" - AgentFirstName: Agent's First Name associated with interaction. Example: --"James" - AgentLastName: Agent's Last Name associated with interaction. Example: --"Bond" - AgentCode: Agent Code for associating agent already in system with interaction. Example: --"007" - InteractionDate: Date on which interaction occured. ISO-8601 Examples: --UTC datetime: "2022-03-18T21:52:26" --UTC datetime with milliseconds: "2022-03-18T21:52:26.8816090Z" --UTC date only: "2022-03-19" --datetime with timezone: "2022-03-18T17:56:09.8683110-04:00" - ExtendedMetadata: [Deprecated - ("Use ExtendedMetadataValues")] Array of Dictionaries of key values associated with interaction. Examples: -- [{ "Data": "Example Data"}, { "Data2": "Example Data 2", "ExampleKey": "Example Value" }] - ExtendedMetadataValues: Dictionary of key values associated with interaction. Examples: -- { "Data": "Example Data" }, { "Data2": "Example Data 2" }, { "ExampleKey": "Example Value" } - HierarchyId: Id of hierarchy to associate with this interaction. Example: -- "00000000-0000-0000-0000-000000000002" - HierarchyCode: Internal Organization Code for associating hierarchy with this interaction. Example: -- "Accounting" - ApplyHierarchyToAgent: If ```true``` AND a ```HierarchyId``` / ```HierarchyCode``` are provided, the system assigns that hierarchy to the agent . Example: -- true - LocaleId: Specifies the language of the interaction using a locale ID. Defaults to ```1033``` (English) if omitted. - ClientCallId: Your external telephony reference ID. Example: -- "5CD1S" - [Get Metadata](https://authenticx.readme.io/reference/get_metadata-2.md): Gets a list of Metadata objects - [Post Metadata](https://authenticx.readme.io/reference/post_metadata-2.md): Return a list of Metadata with specified criteria. - [Patch Metadata](https://authenticx.readme.io/reference/patch_metadata-id-2.md): Updates a target metadata object with the provided values. Performs a patch operation that will overwrite existing values with those provided. - [Get Model Results based on filter criteria](https://authenticx.readme.io/reference/get_modelresults-2.md): Returns a list of model results for the specified criteria including ML predictions and human review results. modelIds must contain active model IDs for your organization. Use GET /Conversations/Classifiers to discover valid modelIds for your organization. Use GET /Hierarchy/All to discover valid hierarchyCodes for your organization. This endpoint uses cursor-based pagination. Pass the lastId from the final item in a page to retrieve the next page. When includeUnprocessedMedia=true, the response may include conversations whose mediaStatus is Processed, NotProcessed, or FailedToProcess. Unprocessed conversations return mediaStatus details with modelResults set to null. Requests earlier than 2025-10-01 are automatically clamped to 2025-10-01. - [Get Model Results for one or more specific conversations](https://authenticx.readme.io/reference/get_modelresults-conversation-2.md): Returns all model results for conversations matching the provided Conversation Ids or Client Call Ids. modelIds is required and must contain active model IDs for your organization. At least one of conversationIds or clientCallIds must also be supplied. When both conversationIds and clientCallIds are provided, results for any conversation matching either set of identifiers are returned. Maximum 100 IDs per parameter. Use this endpoint when you already know the Authenticx ConversationId from GET /Metadata or your own source-system ClientCallId and want the latest available model results for those specific conversations. Set includeUnprocessedMedia=true to also return conversations that are still processing or failed to process. - [Get Receipts based on filter criteria](https://authenticx.readme.io/reference/get_receipts-2.md): Returns a list of receipts for interactions that have finished processing and match the specified criteria. Each result in the response includes the following fields: - ConversationId: Unique identifier for the conversation. Corresponds to the Id field from GET /Metadata and the ConversationId from GET /Conversations/Insights - DateTimeReceived: The date/time the interaction arrived in the system - ClientCallId: Your external telephony reference ID for this conversation - DateTimeTransmitted: The date/time the export attempt was transmitted - ReceiptId: The receipt ID returned from the downstream system - SafetyEvent: Safety event classification result from the export - AdverseEvent: Adverse event classification result from the export - ProductQualityComplaint: Product quality complaint result from the export - uid: The external system UID returned from the export endpoint - [Get All Roles](https://authenticx.readme.io/reference/get_roles-all-2.md): Returns a list of all roles in your organization along with their permissions and each permission's description. - [Get All Resource Types](https://authenticx.readme.io/reference/get_scim-v2-resourcetypes-2.md): Returns, in ListResponse format, all the resource types defined by Authenticx - [Get Resource Type](https://authenticx.readme.io/reference/get_scim-v2-resourcetypes-resourcetypeid-2.md): Returns one resource type specified by the resource type id. - [Get All Schemas](https://authenticx.readme.io/reference/get_scim-v2-schemas-2.md): Returns, in ListResponse format, all the schemas defined by Authenticx - [Get Schema](https://authenticx.readme.io/reference/get_scim-v2-schemas-schemauri-2.md): Returns one schema specified by the schema uri. - [Get Service Provider Config](https://authenticx.readme.io/reference/get_scim-v2-serviceproviderconfig-2.md): Returns the Authenticx service provider config - [Get Users](https://authenticx.readme.io/reference/get_scim-v2-users-2.md): Returns the list of all users in scim user schema format. Supports, filtering, sorting, pagination, and attribute picking as defined in rfc 7644. - [Create User](https://authenticx.readme.io/reference/post_scim-v2-users-2.md): Creates a user with the provided information. - [Delete User](https://authenticx.readme.io/reference/delete_scim-v2-users-userid-2.md): This action does not delete the user record from the database, it marks the `disabled` field as `true`. Therefore, any attempts to create a user with the same user name as an existing, deleted user, will fail. - [Get User](https://authenticx.readme.io/reference/get_scim-v2-users-userid-2.md): Gets a specific user by their id. - [Patch User](https://authenticx.readme.io/reference/patch_scim-v2-users-userid-2.md) - [Update User](https://authenticx.readme.io/reference/put_scim-v2-users-userid-2.md): Updates a user with specified id with the provided information. - [Upload Text Media](https://authenticx.readme.io/reference/post_textmedia-upload-2.md): Uploads a text media interaction into storage for processing. *Param name "file"* Text file uploaded from client. Valid File Extensions: - .json - .json_chat *Param name "metadata"* JSON object containing multiple metadata fields for the text media File: > ๐Ÿ“˜ **Note:** Including the ```Id``` field is recommended. If omitted, one is generated for you, but providing your own lets you correlate with your system. - Id: Unique identifier for the text media. example: "4834c9e9-74f2-4bfe-a0c8-ce947a4f30e3" - FilePath: Path containing file name and extension. Subdirectories specifying a more exact path may be prepended to the file. If omitted, the system derives a path from the ```Id```. name. Examples: -- With subdirectories: "topfolder/subfolder/subsubfolder/filename.json" -- Without subdirectories: "filename.json" - TimeStamp: Time stamp of the interaction. Examples: "2022-03-18T21:52:26", "2022-03-18T21:52:26.8816090Z", "2022-03-19", "2022-03-18T17:56:09.8683110-04:00" - CallDirection: Direction of the interaction's call to or from the call center. Examples: -- "Inbound" -- "Outbound" - Name: Name associated with interaction. Example: -- "Alice" - Phone: Phone number associated with interaction. Example: --"800-555-5555" - AgentFirstName: Agent's First Name associated with interaction. Example: --"James" - AgentLastName: Agent's Last Name associated with interaction. Example: --"Bond" - AgentCode: Agent Code for associating agent already in system with interaction. Example: --"007" - ExtendedMetadata: Array of Dictionaries of key values associated with interaction Examples: -- [{ "Data": "Example Data"}, { "Data2": "Example Data 2", "ExampleKey": "Example Value" }] - HierarchyId: Id of hierarchy to associate with this interaction Example: -- "00000000-0000-0000-0000-000000000002" - HierarchyCode: Internal Organization Code for associating hierarchy with this interaction Example: -- "Accounting" - ApplyHierarchyToAgent: If we want the hierarchy that is passed in to also be applied to the agent then true Example: -- true - LocaleId: Specifies the language of the interaction using a locale ID. Defaults to ```1033``` (English) if omitted. - [Get User By UserName](https://authenticx.readme.io/reference/get_user-1.md): Returns the user with the username specified in the query string. - [Create User](https://authenticx.readme.io/reference/post_user-2.md): Adds a user to your organization. - [Get User](https://authenticx.readme.io/reference/get_user-userid-2.md): Returns the user with the id specified in the url. - [Update User](https://authenticx.readme.io/reference/put_user-userid-2.md): Updates information about an existing user in your organization. - [Get All Users](https://authenticx.readme.io/reference/get_user-all-2.md): Returns a list of all users in your organization. - [Get Hierarchy Permissions For User](https://authenticx.readme.io/reference/get_userhierarchy-userid-hierarchyid-2.md): Returns a list of all permissions within a hierarchy for the specified user. - [Update Hierarchy Permissions For User](https://authenticx.readme.io/reference/put_userhierarchy-userid-hierarchyid-2.md): Updates a user's permissions within a specified hierarchy. - [Get All Hierarchy Permissions For User](https://authenticx.readme.io/reference/get_userhierarchy-userid-all-2.md): Returns a list of all active hierarchies along with the specified user's permissions for each hierarchy - [Get Workflows](https://authenticx.readme.io/reference/get_workflows-2.md): Gets a list of Workflow objects in a given date range. - [Create Agent](https://authenticx.readme.io/reference/post_agent-3.md): Adds an agent to your organization. - [Get Agent](https://authenticx.readme.io/reference/get_agent-agentid-3.md): Returns the agent with the id specified in the url. - [Update Agent](https://authenticx.readme.io/reference/put_agent-agentid-3.md): Updates information about an existing agent in your organization. - [Get All Agents](https://authenticx.readme.io/reference/get_agent-all-3.md): Returns a list of all agents in your organization. - [Gets a list of classifiers](https://authenticx.readme.io/reference/get_conversations-classifiers-3.md) - [Get classifier results for conversations based on filter criteria](https://authenticx.readme.io/reference/get_conversations-insights-3.md): Returns a list of classifier results for conversations with Status of "Sampled" or "ReadyToSample" that match the specified criteria. Requests without any classifier or hierarchy filters may span up to 7 days. Supplying at least one of ClassifierIds, HierarchyIds, HierarchyCodes, ClassifierCategoryNames, or ClassifierTypes extends the maximum date range to 31 days. Use GET /Conversations/Classifiers to discover valid classifier IDs. Use GET /Hierarchy/All to discover valid hierarchy IDs and hierarchy codes. - [Post hierarchyIds, hierarchyCodes, or classifierIds to filter on classifier results.](https://authenticx.readme.io/reference/post_conversations-insights-3.md): Returns a list of classifier results for conversations with Status of "Sampled" or "ReadyToSample" that match the specified criteria. - [Get Batched Conversation Transcriptions](https://authenticx.readme.io/reference/post_conversations-transcriptions-3.md): Returns the transcriptions for multiple conversations identified by their unique IDs. Up to 100 conversation IDs are accepted per request. Duplicate IDs are ignored. Response includes: - transcriptions: successful items - errors: failed items, each with a statusCode indicating why it failed * 404 = conversation not found * 400 = failed to process * 200 = not processed or still processing (message included) Example request: { "conversationIds": [ "b1a9e4d6-7c3a-4e91-9342-835ec9d4f7b1", "ad5b1e2f-08b9-4b23-9e0c-d1a1c3eafc2f" ] } Example response: { "transcriptions": [ { "conversationId": "b1a9e4d6-7c3a-4e91-9342-835ec9d4f7b1", "transcriptions": [ { "languageCode": "en", "transcription": [ "00:00 Agent: Hello", "00:03 Customer: Hi" ] } ] } ], "errors": [ { "conversationId": "ad5b1e2f-08b9-4b23-9e0c-d1a1c3eafc2f", "statusCode": 404, "error": "Conversation not found" } ] } - [Get Single Conversation Transcriptions](https://authenticx.readme.io/reference/get_conversations-transcriptions-conversationid-3.md): Returns the transcriptions for a conversation identified by its unique ID. If the conversation has not finished processing, returns 200 with a message. If the conversation failed to process, returns 400 with a message. - [Get Evaluations](https://authenticx.readme.io/reference/get_evaluations-3.md): Gets a list of evaluations - [Get Evaluations with their modules](https://authenticx.readme.io/reference/get_evaluations-modules-3.md): Gets a list of evaluations with their associated modules - [Create Hierarchy](https://authenticx.readme.io/reference/post_hierarchy-3.md): Adds a hierarchy to your organization. - [Update Hierarchy](https://authenticx.readme.io/reference/put_hierarchy-hierarchyid-3.md): Updates information about an existing hierarchy in your organization. - [Get All Hierarchies](https://authenticx.readme.io/reference/get_hierarchy-all-3.md): Returns a list of all active hierarchies in your organization along with their contacts. - [Get Interactions based on filter criteria](https://authenticx.readme.io/reference/get_interactions-3.md): Deprecated. Please use `/Conversations/Insights` instead. Returns a list of interactions that have finished processing and match the specified criteria. - [Get Interactions based on filter criteria.](https://authenticx.readme.io/reference/post_interactions-3.md): Deprecated. Please use `/Conversations/Insights` instead. Returns a list of interactions that have finished processing and match the specified criteria. - [Get Interaction](https://authenticx.readme.io/reference/get_interactions-amdid-3.md): Deprecated. Please use `/Conversations/Insights` instead. Returns the interaction's status, and if completed, additional information describing the interaction. - [Upload Media](https://authenticx.readme.io/reference/post_media-upload-3.md): Uploads an audio file interaction into storage for processing. *Param name "file"* Audio file uploaded from client (required unless signedUrl is provided). Valid Audio File Extensions: - .wav - .mp3 - .mp4 - .ogg - .opus - .m4a Valid Chat File Extensions: - .tar - .zip *Param name "signedUrl"* Optional signed download URL. If provided, the server downloads the file from this URL instead of using multipart upload. Supports signed URLs from AWS S3, Azure Blob Storage, etc. Example: "https://bucket.s3.amazonaws.com/path/to/file.mp3?X-Amz-Algorithm=..." or "https://storage.azure.com/container/blob?sv=..." *Param name "metadata"* JSON dictionary containing multiple metadata fields about the Audio File: Required Fields: - FileName: Path containing file name and extension (extension must match the uploaded file). Subdirectories specifying a more exact path may be prepended to the file name. Examples: -- With subdirectories: "topfolder/subfolder/subsubfolder/filename.mp3" -- Without subdirectories: "filename.mp3" - UploadType: Type indicating if you are uploding a chat or audio file. Examples: -- "Chat" -- "Audio" Optional Fields: - CallDirection: Direction of the interaction's call to or from the call center. Examples: -- "Inbound" -- "Outbound" - Name: Name associated with interaction. Example: -- "Alice" - Phone: Phone number associated with interaction. Example: --"800-555-5555" - Email: Email address associated with interaction. Example: --"example@example.com" - AgentFirstName: Agent's First Name associated with interaction. Example: --"James" - AgentLastName: Agent's Last Name associated with interaction. Example: --"Bond" - AgentCode: Agent Code for associating agent already in system with interaction. Example: --"007" - InteractionDate: Date on which interaction occured. ISO-8601 Examples: --UTC datetime: "2022-03-18T21:52:26" --UTC datetime with milliseconds: "2022-03-18T21:52:26.8816090Z" --UTC date only: "2022-03-19" --datetime with timezone: "2022-03-18T17:56:09.8683110-04:00" - ExtendedMetadata: [Deprecated - ("Use ExtendedMetadataValues")] Array of Dictionaries of key values associated with interaction. Examples: -- [{ "Data": "Example Data"}, { "Data2": "Example Data 2", "ExampleKey": "Example Value" }] - ExtendedMetadataValues: Dictionary of key values associated with interaction. Examples: -- { "Data": "Example Data" }, { "Data2": "Example Data 2" }, { "ExampleKey": "Example Value" } - HierarchyId: Id of hierarchy to associate with this interaction. Example: -- "00000000-0000-0000-0000-000000000002" - HierarchyCode: Internal Organization Code for associating hierarchy with this interaction. Example: -- "Accounting" - ApplyHierarchyToAgent: If ```true``` AND a ```HierarchyId``` / ```HierarchyCode``` are provided, the system assigns that hierarchy to the agent . Example: -- true - LocaleId: Specifies the language of the interaction using a locale ID. Defaults to ```1033``` (English) if omitted. - ClientCallId: Your external telephony reference ID. Example: -- "5CD1S" - [Get Metadata](https://authenticx.readme.io/reference/get_metadata-3.md): Gets a list of Metadata objects - [Post Metadata](https://authenticx.readme.io/reference/post_metadata-3.md): Return a list of Metadata with specified criteria. - [Patch Metadata](https://authenticx.readme.io/reference/patch_metadata-id-3.md): Updates a target metadata object with the provided values. Performs a patch operation that will overwrite existing values with those provided. - [Get Model Results based on filter criteria](https://authenticx.readme.io/reference/get_modelresults-3.md): Returns a list of model results for the specified criteria including ML predictions and human review results. modelIds must contain active model IDs for your organization. Use GET /Conversations/Classifiers to discover valid modelIds for your organization. Use GET /Hierarchy/All to discover valid hierarchyCodes for your organization. This endpoint uses cursor-based pagination. Pass the lastId from the final item in a page to retrieve the next page. When includeUnprocessedMedia=true, the response may include conversations whose mediaStatus is Processed, NotProcessed, or FailedToProcess. Unprocessed conversations return mediaStatus details with modelResults set to null. Requests earlier than 2025-10-01 are automatically clamped to 2025-10-01. - [Get Model Results for one or more specific conversations](https://authenticx.readme.io/reference/get_modelresults-conversation-3.md): Returns all model results for conversations matching the provided Conversation Ids or Client Call Ids. modelIds is required and must contain active model IDs for your organization. At least one of conversationIds or clientCallIds must also be supplied. When both conversationIds and clientCallIds are provided, results for any conversation matching either set of identifiers are returned. Maximum 100 IDs per parameter. Use this endpoint when you already know the Authenticx ConversationId from GET /Metadata or your own source-system ClientCallId and want the latest available model results for those specific conversations. Set includeUnprocessedMedia=true to also return conversations that are still processing or failed to process. - [Get Receipts based on filter criteria](https://authenticx.readme.io/reference/get_receipts-3.md): Returns a list of receipts for interactions that have finished processing and match the specified criteria. Each result in the response includes the following fields: - ConversationId: Unique identifier for the conversation. Corresponds to the Id field from GET /Metadata and the ConversationId from GET /Conversations/Insights - DateTimeReceived: The date/time the interaction arrived in the system - ClientCallId: Your external telephony reference ID for this conversation - DateTimeTransmitted: The date/time the export attempt was transmitted - ReceiptId: The receipt ID returned from the downstream system - SafetyEvent: Safety event classification result from the export - AdverseEvent: Adverse event classification result from the export - ProductQualityComplaint: Product quality complaint result from the export - uid: The external system UID returned from the export endpoint - [Get All Roles](https://authenticx.readme.io/reference/get_roles-all-3.md): Returns a list of all roles in your organization along with their permissions and each permission's description. - [Get All Resource Types](https://authenticx.readme.io/reference/get_scim-v2-resourcetypes-3.md): Returns, in ListResponse format, all the resource types defined by Authenticx - [Get Resource Type](https://authenticx.readme.io/reference/get_scim-v2-resourcetypes-resourcetypeid-3.md): Returns one resource type specified by the resource type id. - [Get All Schemas](https://authenticx.readme.io/reference/get_scim-v2-schemas-3.md): Returns, in ListResponse format, all the schemas defined by Authenticx - [Get Schema](https://authenticx.readme.io/reference/get_scim-v2-schemas-schemauri-3.md): Returns one schema specified by the schema uri. - [Get Service Provider Config](https://authenticx.readme.io/reference/get_scim-v2-serviceproviderconfig-3.md): Returns the Authenticx service provider config - [Get Users](https://authenticx.readme.io/reference/get_scim-v2-users-3.md): Returns the list of all users in scim user schema format. Supports, filtering, sorting, pagination, and attribute picking as defined in rfc 7644. - [Create User](https://authenticx.readme.io/reference/post_scim-v2-users-3.md): Creates a user with the provided information. - [Delete User](https://authenticx.readme.io/reference/delete_scim-v2-users-userid-3.md): This action does not delete the user record from the database, it marks the `disabled` field as `true`. Therefore, any attempts to create a user with the same user name as an existing, deleted user, will fail. - [Get User](https://authenticx.readme.io/reference/get_scim-v2-users-userid-3.md): Gets a specific user by their id. - [Patch User](https://authenticx.readme.io/reference/patch_scim-v2-users-userid-3.md) - [Update User](https://authenticx.readme.io/reference/put_scim-v2-users-userid-3.md): Updates a user with specified id with the provided information. - [Upload Text Media](https://authenticx.readme.io/reference/post_textmedia-upload-3.md): Uploads a text media interaction into storage for processing. *Param name "file"* Text file uploaded from client. Valid File Extensions: - .json - .json_chat *Param name "metadata"* JSON object containing multiple metadata fields for the text media File: > ๐Ÿ“˜ **Note:** Including the ```Id``` field is recommended. If omitted, one is generated for you, but providing your own lets you correlate with your system. - Id: Unique identifier for the text media. example: "4834c9e9-74f2-4bfe-a0c8-ce947a4f30e3" - FilePath: Path containing file name and extension. Subdirectories specifying a more exact path may be prepended to the file. If omitted, the system derives a path from the ```Id```. name. Examples: -- With subdirectories: "topfolder/subfolder/subsubfolder/filename.json" -- Without subdirectories: "filename.json" - TimeStamp: Time stamp of the interaction. Examples: "2022-03-18T21:52:26", "2022-03-18T21:52:26.8816090Z", "2022-03-19", "2022-03-18T17:56:09.8683110-04:00" - CallDirection: Direction of the interaction's call to or from the call center. Examples: -- "Inbound" -- "Outbound" - Name: Name associated with interaction. Example: -- "Alice" - Phone: Phone number associated with interaction. Example: --"800-555-5555" - AgentFirstName: Agent's First Name associated with interaction. Example: --"James" - AgentLastName: Agent's Last Name associated with interaction. Example: --"Bond" - AgentCode: Agent Code for associating agent already in system with interaction. Example: --"007" - ExtendedMetadata: Array of Dictionaries of key values associated with interaction Examples: -- [{ "Data": "Example Data"}, { "Data2": "Example Data 2", "ExampleKey": "Example Value" }] - HierarchyId: Id of hierarchy to associate with this interaction Example: -- "00000000-0000-0000-0000-000000000002" - HierarchyCode: Internal Organization Code for associating hierarchy with this interaction Example: -- "Accounting" - ApplyHierarchyToAgent: If we want the hierarchy that is passed in to also be applied to the agent then true Example: -- true - LocaleId: Specifies the language of the interaction using a locale ID. Defaults to ```1033``` (English) if omitted. - [Get User By UserName](https://authenticx.readme.io/reference/get_user-3.md): Returns the user with the username specified in the query string. - [Create User](https://authenticx.readme.io/reference/post_user-3.md): Adds a user to your organization. - [Get User](https://authenticx.readme.io/reference/get_user-userid-3.md): Returns the user with the id specified in the url. - [Update User](https://authenticx.readme.io/reference/put_user-userid-3.md): Updates information about an existing user in your organization. - [Get All Users](https://authenticx.readme.io/reference/get_user-all-3.md): Returns a list of all users in your organization. - [Get Hierarchy Permissions For User](https://authenticx.readme.io/reference/get_userhierarchy-userid-hierarchyid-3.md): Returns a list of all permissions within a hierarchy for the specified user. - [Update Hierarchy Permissions For User](https://authenticx.readme.io/reference/put_userhierarchy-userid-hierarchyid-3.md): Updates a user's permissions within a specified hierarchy. - [Get All Hierarchy Permissions For User](https://authenticx.readme.io/reference/get_userhierarchy-userid-all-3.md): Returns a list of all active hierarchies along with the specified user's permissions for each hierarchy - [Get Workflows](https://authenticx.readme.io/reference/get_workflows-3.md): Gets a list of Workflow objects in a given date range. ## Recipes - [Access Token Generation (Maven + Java)](https://authenticx.readme.io/recipes/access-token-generation-maven-java.md) - [Access Token Generation (.NET)](https://authenticx.readme.io/recipes/access-token-generation-net.md) - [Access Token Generation (NodeJS)](https://authenticx.readme.io/recipes/access-token-generation-nodejs.md) - [Access Token Generation (Python)](https://authenticx.readme.io/recipes/access-token-generation-python.md) - [Upload File (Maven + Java)](https://authenticx.readme.io/recipes/upload-file-maven-java.md) - [Upload File (.NET)](https://authenticx.readme.io/recipes/upload-file-net.md) - [Upload File (NodeJS)](https://authenticx.readme.io/recipes/upload-file-nodejs.md) - [Upload File (Python)](https://authenticx.readme.io/recipes/upload-file-python.md) - [User Management (Maven + Java)](https://authenticx.readme.io/recipes/user-management-maven-java.md) - [User Management (.NET)](https://authenticx.readme.io/recipes/user-management-net.md) - [User Management (NodeJS)](https://authenticx.readme.io/recipes/user-management-nodejs.md) - [User Management (Python)](https://authenticx.readme.io/recipes/user-management-python.md)