> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # genesys-speech-analytics > Genesys Speech & Text Analytics - conversation transcripts, sentiments, topics, categories, and programs **Server path:** `/genesys-speech-analytics` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | [`genesys_speech_analytics_delete_category`](#genesys_speech_analytics_delete_category) | Delete a Speech & Text Analytics category by ID | | [`genesys_speech_analytics_delete_dictionaryfeedback_dictionary_feedback_id`](#genesys_speech_analytics_delete_dictionaryfeedback_dictionary_feedback_id) | Delete a Speech & Text Analytics DictionaryFeedback by Id | | [`genesys_speech_analytics_delete_program`](#genesys_speech_analytics_delete_program) | Delete a Speech & Text Analytics program by id | | [`genesys_speech_analytics_delete_sentimentfeedback`](#genesys_speech_analytics_delete_sentimentfeedback) | Delete All Speech & Text Analytics SentimentFeedback | | [`genesys_speech_analytics_delete_sentimentfeedback_sentiment_feedback_id`](#genesys_speech_analytics_delete_sentimentfeedback_sentiment_feedback_id) | Delete a Speech & Text Analytics SentimentFeedback by Id | | [`genesys_speech_analytics_delete_topic`](#genesys_speech_analytics_delete_topic) | Delete a Speech & Text Analytics topic by id | | [`genesys_speech_analytics_get_categories`](#genesys_speech_analytics_get_categories) | Get the list of Speech and Text Analytics categories | | [`genesys_speech_analytics_get_category`](#genesys_speech_analytics_get_category) | Get a Speech & Text Analytics Category by ID | | [`genesys_speech_analytics_get_conversation`](#genesys_speech_analytics_get_conversation) | Get Speech and Text Analytics for a specific conversation | | [`genesys_speech_analytics_get_conversation_categories`](#genesys_speech_analytics_get_conversation_categories) | Get the list of detected Speech and Text Analytics categories of conversation | | [`genesys_speech_analytics_get_conversation_communication_transcripturl`](#genesys_speech_analytics_get_conversation_communication_transcripturl) | Get the pre-signed S3 URL for the transcript of a specific communication of a conversation | | [`genesys_speech_analytics_get_conversation_communication_transcripturls`](#genesys_speech_analytics_get_conversation_communication_transcripturls) | Get the list of pre-signed S3 URL for the transcripts of a specific communication of a conversation | | [`genesys_speech_analytics_get_conversation_sentiments`](#genesys_speech_analytics_get_conversation_sentiments) | Get sentiment data | | [`genesys_speech_analytics_get_conversation_summaries`](#genesys_speech_analytics_get_conversation_summaries) | Get conversation summaries by conversation id. | | [`genesys_speech_analytics_get_dictionaryfeedback`](#genesys_speech_analytics_get_dictionaryfeedback) | Get the list of Speech & Text Analytics dictionary feedbacks | | [`genesys_speech_analytics_get_dictionaryfeedback_dictionary_feedback_id`](#genesys_speech_analytics_get_dictionaryfeedback_dictionary_feedback_id) | Get a Speech & Text Analytics dictionary feedback by id | | [`genesys_speech_analytics_get_program`](#genesys_speech_analytics_get_program) | Get a Speech & Text Analytics program by id | | [`genesys_speech_analytics_get_program_mappings`](#genesys_speech_analytics_get_program_mappings) | Get Speech & Text Analytics program mappings to queues and flows by id | | [`genesys_speech_analytics_get_program_settings_insights`](#genesys_speech_analytics_get_program_settings_insights) | Get AI Insights settings of a program | | [`genesys_speech_analytics_get_program_transcriptionengines`](#genesys_speech_analytics_get_program_transcriptionengines) | Get transcription engine settings of a program | | [`genesys_speech_analytics_get_programs`](#genesys_speech_analytics_get_programs) | Get the list of Speech & Text Analytics programs | | [`genesys_speech_analytics_get_programs_general_job`](#genesys_speech_analytics_get_programs_general_job) | Get a Speech & Text Analytics general program job by id | | [`genesys_speech_analytics_get_programs_mappings`](#genesys_speech_analytics_get_programs_mappings) | Get the list of Speech & Text Analytics programs mappings to queues and flows | | [`genesys_speech_analytics_get_programs_publishjob`](#genesys_speech_analytics_get_programs_publishjob) | Get a Speech & Text Analytics publish programs job by id | | [`genesys_speech_analytics_get_programs_settings_insights`](#genesys_speech_analytics_get_programs_settings_insights) | Get the list of program AI Insights settings for the organization | | [`genesys_speech_analytics_get_programs_topiclinks_job`](#genesys_speech_analytics_get_programs_topiclinks_job) | Get a Speech & Text Analytics program-topic links job by id | | [`genesys_speech_analytics_get_programs_transcriptionengines_dialects`](#genesys_speech_analytics_get_programs_transcriptionengines_dialects) | Get supported dialects for each transcription engine | | [`genesys_speech_analytics_get_programs_unpublished`](#genesys_speech_analytics_get_programs_unpublished) | Get the list of Speech & Text Analytics unpublished programs | | [`genesys_speech_analytics_get_sentiment_dialects`](#genesys_speech_analytics_get_sentiment_dialects) | Get the list of Speech & Text Analytics sentiment supported dialects | | [`genesys_speech_analytics_get_sentimentfeedback`](#genesys_speech_analytics_get_sentimentfeedback) | Get the list of Speech & Text Analytics SentimentFeedback | | [`genesys_speech_analytics_get_settings`](#genesys_speech_analytics_get_settings) | Get Speech And Text Analytics Settings | | [`genesys_speech_analytics_get_topic`](#genesys_speech_analytics_get_topic) | Get a Speech & Text Analytics topic by id | | [`genesys_speech_analytics_get_topics`](#genesys_speech_analytics_get_topics) | Get the list of Speech & Text Analytics topics | | [`genesys_speech_analytics_get_topics_dialects`](#genesys_speech_analytics_get_topics_dialects) | Get list of supported Speech & Text Analytics topics dialects | | [`genesys_speech_analytics_get_topics_general`](#genesys_speech_analytics_get_topics_general) | Get the Speech & Text Analytics general topics for a given dialect | | [`genesys_speech_analytics_get_topics_general_status`](#genesys_speech_analytics_get_topics_general_status) | Get the list of general topics from the org and the system with their current status | | [`genesys_speech_analytics_get_topics_publishjob`](#genesys_speech_analytics_get_topics_publishjob) | Get a Speech & Text Analytics publish topics job by id | | [`genesys_speech_analytics_get_topics_testphrase_job`](#genesys_speech_analytics_get_topics_testphrase_job) | Get a Speech & Text Analytics test topics phrase job by id | | [`genesys_speech_analytics_get_translations_language_conversation`](#genesys_speech_analytics_get_translations_language_conversation) | Translate a single interaction recording (or an email conversation) | | [`genesys_speech_analytics_get_translations_languages`](#genesys_speech_analytics_get_translations_languages) | Get supported translation languages | | [`genesys_speech_analytics_patch_settings`](#genesys_speech_analytics_patch_settings) | Patch Speech And Text Analytics Settings | | [`genesys_speech_analytics_post_categories`](#genesys_speech_analytics_post_categories) | Create new Speech & Text Analytics category | | [`genesys_speech_analytics_post_dictionaryfeedback`](#genesys_speech_analytics_post_dictionaryfeedback) | Create a Speech & Text Analytics DictionaryFeedback | | [`genesys_speech_analytics_post_programs`](#genesys_speech_analytics_post_programs) | Create new Speech & Text Analytics program | | [`genesys_speech_analytics_post_programs_general_jobs`](#genesys_speech_analytics_post_programs_general_jobs) | Create new Speech & Text Analytics general program job | | [`genesys_speech_analytics_post_programs_publishjobs`](#genesys_speech_analytics_post_programs_publishjobs) | Create new Speech & Text Analytics publish programs job | | [`genesys_speech_analytics_post_sentimentfeedback`](#genesys_speech_analytics_post_sentimentfeedback) | Create a Speech & Text Analytics SentimentFeedback | | [`genesys_speech_analytics_post_topics`](#genesys_speech_analytics_post_topics) | Create new Speech & Text Analytics topic | | [`genesys_speech_analytics_post_topics_publishjobs`](#genesys_speech_analytics_post_topics_publishjobs) | Create new Speech & Text Analytics publish topics job | | [`genesys_speech_analytics_post_topics_testphrase_jobs`](#genesys_speech_analytics_post_topics_testphrase_jobs) | Create new Speech & Text Analytics publish topics job | | [`genesys_speech_analytics_put_category`](#genesys_speech_analytics_put_category) | Update a Speech & Text Analytics category by ID | | [`genesys_speech_analytics_put_dictionaryfeedback_dictionary_feedback_id`](#genesys_speech_analytics_put_dictionaryfeedback_dictionary_feedback_id) | Update existing Speech & Text Analytics dictionary feedback by id | | [`genesys_speech_analytics_put_program`](#genesys_speech_analytics_put_program) | Update existing Speech & Text Analytics program | | [`genesys_speech_analytics_put_program_mappings`](#genesys_speech_analytics_put_program_mappings) | Set Speech & Text Analytics program mappings to queues and flows | | [`genesys_speech_analytics_put_program_settings_insights`](#genesys_speech_analytics_put_program_settings_insights) | Update AI Insights settings of a program | | [`genesys_speech_analytics_put_program_transcriptionengines`](#genesys_speech_analytics_put_program_transcriptionengines) | Update transcription engine settings of a program | | [`genesys_speech_analytics_put_settings`](#genesys_speech_analytics_put_settings) | Update Speech And Text Analytics Settings | | [`genesys_speech_analytics_put_topic`](#genesys_speech_analytics_put_topic) | Update existing Speech & Text Analytics topic | *** ## genesys\_speech\_analytics\_delete\_category Delete a Speech & Text Analytics category by ID **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------- | | `categoryId` | string | Yes | — | The id of the category | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "categoryId": { "type": "string", "description": "The id of the category" } }, "required": [ "PCID", "categoryId" ] } ``` *** ## genesys\_speech\_analytics\_delete\_dictionaryfeedback\_dictionary\_feedback\_id Delete a Speech & Text Analytics DictionaryFeedback by Id **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------ | -------- | ------- | --------------------------------- | | `dictionaryFeedbackId` | string | Yes | — | The Id of the Dictionary Feedback | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dictionaryFeedbackId": { "type": "string", "description": "The Id of the Dictionary Feedback" } }, "required": [ "PCID", "dictionaryFeedbackId" ] } ``` *** ## genesys\_speech\_analytics\_delete\_program Delete a Speech & Text Analytics program by id **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------- | | `programId` | string | Yes | — | The id of the program | | `forceDelete` | boolean | No | — | Indicates whether the program is forced to be deleted or not. Required when the program to delete is the default program. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "programId": { "type": "string", "description": "The id of the program" }, "forceDelete": { "type": "boolean", "description": "Indicates whether the program is forced to be deleted or not. Required when the program to delete is the default program.", "enum": [ true, false ] } }, "required": [ "PCID", "programId" ] } ``` *** ## genesys\_speech\_analytics\_delete\_sentimentfeedback Delete All Speech & Text Analytics SentimentFeedback ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## genesys\_speech\_analytics\_delete\_sentimentfeedback\_sentiment\_feedback\_id Delete a Speech & Text Analytics SentimentFeedback by Id **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | ------------------------------- | | `sentimentFeedbackId` | string | Yes | — | The Id of the SentimentFeedback | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sentimentFeedbackId": { "type": "string", "description": "The Id of the SentimentFeedback" } }, "required": [ "PCID", "sentimentFeedbackId" ] } ``` *** ## genesys\_speech\_analytics\_delete\_topic Delete a Speech & Text Analytics topic by id **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------- | | `topicId` | string | Yes | — | The id of the topic | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "topicId": { "type": "string", "description": "The id of the topic" } }, "required": [ "PCID", "topicId" ] } ``` *** ## genesys\_speech\_analytics\_get\_categories Get the list of Speech and Text Analytics categories **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------- | | `pageSize` | integer | No | — | The page size for the listing. The max that will be returned is 25. | | `pageNumber` | integer | No | — | The page number for the listing | | `name` | string | No | — | The category name filter applied to the listing | | `sortOrder` | string | No | — | The sort order for the listing | | `sortBy` | string | No | — | The field to sort by for the listing | | `ids` | string\[] | No | — | Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 25 IDs allowed. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pageSize": { "type": "integer", "description": "The page size for the listing. The max that will be returned is 25." }, "pageNumber": { "type": "integer", "description": "The page number for the listing" }, "name": { "type": "string", "description": "The category name filter applied to the listing" }, "sortOrder": { "type": "string", "description": "The sort order for the listing", "enum": [ "asc", "desc" ] }, "sortBy": { "type": "string", "description": "The field to sort by for the listing", "enum": [ "name", "description" ] }, "ids": { "type": "array", "items": { "type": "string" }, "description": "Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 25 IDs allowed." } }, "required": [ "PCID" ] } ``` *** ## genesys\_speech\_analytics\_get\_category Get a Speech & Text Analytics Category by ID **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------- | | `categoryId` | string | Yes | — | The id of the category | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "categoryId": { "type": "string", "description": "The id of the category" } }, "required": [ "PCID", "categoryId" ] } ``` *** ## genesys\_speech\_analytics\_get\_conversation Get Speech and Text Analytics for a specific conversation **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | --------------- | | `conversationId` | string | Yes | — | Conversation Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "conversationId": { "type": "string", "description": "Conversation Id" } }, "required": [ "PCID", "conversationId" ] } ``` *** ## genesys\_speech\_analytics\_get\_conversation\_categories Get the list of detected Speech and Text Analytics categories of conversation **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------- | -------- | ------- | ------------------------------------------------------------------- | | `conversationId` | string | Yes | — | The id of the conversation | | `pageSize` | integer | No | — | The page size for the listing. The max that will be returned is 50. | | `pageNumber` | integer | No | — | The page number for the listing | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "conversationId": { "type": "string", "description": "The id of the conversation" }, "pageSize": { "type": "integer", "description": "The page size for the listing. The max that will be returned is 50." }, "pageNumber": { "type": "integer", "description": "The page number for the listing" } }, "required": [ "PCID", "conversationId" ] } ``` *** ## genesys\_speech\_analytics\_get\_conversation\_communication\_transcripturl Get the pre-signed S3 URL for the transcript of a specific communication of a conversation **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ---------------- | | `conversationId` | string | Yes | — | Conversation ID | | `communicationId` | string | Yes | — | Communication ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "conversationId": { "type": "string", "description": "Conversation ID" }, "communicationId": { "type": "string", "description": "Communication ID" } }, "required": [ "PCID", "conversationId", "communicationId" ] } ``` *** ## genesys\_speech\_analytics\_get\_conversation\_communication\_transcripturls Get the list of pre-signed S3 URL for the transcripts of a specific communication of a conversation **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ---------------- | | `conversationId` | string | Yes | — | Conversation ID | | `communicationId` | string | Yes | — | Communication ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "conversationId": { "type": "string", "description": "Conversation ID" }, "communicationId": { "type": "string", "description": "Communication ID" } }, "required": [ "PCID", "conversationId", "communicationId" ] } ``` *** ## genesys\_speech\_analytics\_get\_conversation\_sentiments Get sentiment data **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | ----------------------------------------- | | `conversationId` | string | Yes | — | The conversation ID of the sentiment data | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "conversationId": { "type": "string", "description": "The conversation ID of the sentiment data" } }, "required": [ "PCID", "conversationId" ] } ``` *** ## genesys\_speech\_analytics\_get\_conversation\_summaries Get conversation summaries by conversation id. **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | ------------------------------------ | | `conversationId` | string | Yes | — | The conversation ID of the summaries | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "conversationId": { "type": "string", "description": "The conversation ID of the summaries" } }, "required": [ "PCID", "conversationId" ] } ``` *** ## genesys\_speech\_analytics\_get\_dictionaryfeedback Get the list of Speech & Text Analytics dictionary feedbacks **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `dialect` | string | No | — | The key for filter the listing by dialect, dialect format is \{language}-\{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard | | `transcriptionEngine` | string | No | — | Filter by transcription engine, If not provided, all transcription engines will be considered | | `nextPage` | string | No | — | The key for listing the next page | | `pageSize` | integer | No | — | The page size for the listing. Default is 500 per page. Note: organizations may store up to 1000 dictionary terms per dialect; use nextPage to paginate beyond the first page when listing a full dialect vocabulary. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dialect": { "type": "string", "description": "The key for filter the listing by dialect, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard" }, "transcriptionEngine": { "type": "string", "description": "Filter by transcription engine, If not provided, all transcription engines will be considered", "enum": [ "Genesys", "GenesysExtended" ] }, "nextPage": { "type": "string", "description": "The key for listing the next page" }, "pageSize": { "type": "integer", "description": "The page size for the listing. Default is 500 per page. Note: organizations may store up to 1000 dictionary terms per dialect; use nextPage to paginate beyond the first page when listing a full dialect vocabulary." } }, "required": [ "PCID" ] } ``` *** ## genesys\_speech\_analytics\_get\_dictionaryfeedback\_dictionary\_feedback\_id Get a Speech & Text Analytics dictionary feedback by id **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------ | -------- | ------- | --------------------------------- | | `dictionaryFeedbackId` | string | Yes | — | The Id of the Dictionary Feedback | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dictionaryFeedbackId": { "type": "string", "description": "The Id of the Dictionary Feedback" } }, "required": [ "PCID", "dictionaryFeedbackId" ] } ``` *** ## genesys\_speech\_analytics\_get\_program Get a Speech & Text Analytics program by id **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------- | | `programId` | string | Yes | — | The id of the program | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "programId": { "type": "string", "description": "The id of the program" } }, "required": [ "PCID", "programId" ] } ``` *** ## genesys\_speech\_analytics\_get\_program\_mappings Get Speech & Text Analytics program mappings to queues and flows by id **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------- | | `programId` | string | Yes | — | The id of the program | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "programId": { "type": "string", "description": "The id of the program" } }, "required": [ "PCID", "programId" ] } ``` *** ## genesys\_speech\_analytics\_get\_program\_settings\_insights Get AI Insights settings of a program **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------- | | `programId` | string | Yes | — | The id of the program | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "programId": { "type": "string", "description": "The id of the program" } }, "required": [ "PCID", "programId" ] } ``` *** ## genesys\_speech\_analytics\_get\_program\_transcriptionengines Get transcription engine settings of a program **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------- | | `programId` | string | Yes | — | The id of the program | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "programId": { "type": "string", "description": "The id of the program" } }, "required": [ "PCID", "programId" ] } ``` *** ## genesys\_speech\_analytics\_get\_programs Get the list of Speech & Text Analytics programs **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------- | | `nextPage` | string | No | — | The key for listing the next page | | `pageSize` | integer | No | — | The page size for the listing | | `state` | string | No | — | Program state. Defaults to Latest | | `name` | string | No | — | Case insensitive partial name to filter by | | `ids` | string\[] | No | — | Comma separated Program IDs to filter by. Cannot be used with pagination params. Maximum of 50 IDs allowed. | | `sortBy` | string | No | — | Sort results by. Defaults to name | | `sortOrder` | string | No | — | Sort order. Defaults to asc | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "nextPage": { "type": "string", "description": "The key for listing the next page" }, "pageSize": { "type": "integer", "description": "The page size for the listing" }, "state": { "type": "string", "description": "Program state. Defaults to Latest", "enum": [ "Latest", "Published" ] }, "name": { "type": "string", "description": "Case insensitive partial name to filter by" }, "ids": { "type": "array", "items": { "type": "string" }, "description": "Comma separated Program IDs to filter by. Cannot be used with pagination params. Maximum of 50 IDs allowed." }, "sortBy": { "type": "string", "description": "Sort results by. Defaults to name", "enum": [ "name" ] }, "sortOrder": { "type": "string", "description": "Sort order. Defaults to asc", "enum": [ "asc", "desc" ] } }, "required": [ "PCID" ] } ``` *** ## genesys\_speech\_analytics\_get\_programs\_general\_job Get a Speech & Text Analytics general program job by id **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ---------------------------------- | | `jobId` | string | Yes | — | The id of the publish programs job | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "The id of the publish programs job" } }, "required": [ "PCID", "jobId" ] } ``` *** ## genesys\_speech\_analytics\_get\_programs\_mappings Get the list of Speech & Text Analytics programs mappings to queues and flows **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | --------------------------------- | | `nextPage` | string | No | — | The key for listing the next page | | `pageSize` | integer | No | — | The page size for the listing | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "nextPage": { "type": "string", "description": "The key for listing the next page" }, "pageSize": { "type": "integer", "description": "The page size for the listing" } }, "required": [ "PCID" ] } ``` *** ## genesys\_speech\_analytics\_get\_programs\_publishjob Get a Speech & Text Analytics publish programs job by id **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ---------------------------------- | | `jobId` | string | Yes | — | The id of the publish programs job | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "The id of the publish programs job" } }, "required": [ "PCID", "jobId" ] } ``` *** ## genesys\_speech\_analytics\_get\_programs\_settings\_insights Get the list of program AI Insights settings for the organization **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | -------------------------------------------------------------------- | | `pageSize` | integer | No | — | The page size for the listing. The max that will be returned is 100. | | `pageNumber` | integer | No | — | The page number for the listing | | `programIds` | string\[] | No | — | Comma separated Program IDs to filter by. Maximum of 50 IDs allowed. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pageSize": { "type": "integer", "description": "The page size for the listing. The max that will be returned is 100." }, "pageNumber": { "type": "integer", "description": "The page number for the listing" }, "programIds": { "type": "array", "items": { "type": "string" }, "description": "Comma separated Program IDs to filter by. Maximum of 50 IDs allowed." } }, "required": [ "PCID" ] } ``` *** ## genesys\_speech\_analytics\_get\_programs\_topiclinks\_job Get a Speech & Text Analytics program-topic links job by id **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------- | | `jobId` | string | Yes | — | The id of the program-topic links job | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "The id of the program-topic links job" } }, "required": [ "PCID", "jobId" ] } ``` *** ## genesys\_speech\_analytics\_get\_programs\_transcriptionengines\_dialects Get supported dialects for each transcription engine ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## genesys\_speech\_analytics\_get\_programs\_unpublished Get the list of Speech & Text Analytics unpublished programs **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | --------------------------------- | | `nextPage` | string | No | — | The key for listing the next page | | `pageSize` | integer | No | — | The page size for the listing | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "nextPage": { "type": "string", "description": "The key for listing the next page" }, "pageSize": { "type": "integer", "description": "The page size for the listing" } }, "required": [ "PCID" ] } ``` *** ## genesys\_speech\_analytics\_get\_sentiment\_dialects Get the list of Speech & Text Analytics sentiment supported dialects ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## genesys\_speech\_analytics\_get\_sentimentfeedback Get the list of Speech & Text Analytics SentimentFeedback **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `dialect` | string | No | — | The key for filter the listing by dialect, dialect format is \{language}-\{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dialect": { "type": "string", "description": "The key for filter the listing by dialect, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard" } }, "required": [ "PCID" ] } ``` *** ## genesys\_speech\_analytics\_get\_settings Get Speech And Text Analytics Settings ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## genesys\_speech\_analytics\_get\_topic Get a Speech & Text Analytics topic by id **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------- | | `topicId` | string | Yes | — | The id of the topic | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "topicId": { "type": "string", "description": "The id of the topic" } }, "required": [ "PCID", "topicId" ] } ``` *** ## genesys\_speech\_analytics\_get\_topics Get the list of Speech & Text Analytics topics **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------- | | `nextPage` | string | No | — | The key for listing the next page | | `pageSize` | integer | No | — | The page size for the listing. The max that will be returned is 500. | | `pageNumber` | integer | No | — | The page number for the listing | | `state` | string | No | — | Topic state. Defaults to latest | | `name` | string | No | — | Case insensitive partial name to filter by | | `ids` | string\[] | No | — | Comma separated Topic IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed. | | `dialects` | string\[] | No | — | Comma separated dialect strings to filter by. Maximum of 15 dialects allowed. | | `sortBy` | string | No | — | Sort results by. Defaults to name | | `sortOrder` | string | No | — | Sort order. Defaults to asc | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "nextPage": { "type": "string", "description": "The key for listing the next page" }, "pageSize": { "type": "integer", "description": "The page size for the listing. The max that will be returned is 500." }, "pageNumber": { "type": "integer", "description": "The page number for the listing" }, "state": { "type": "string", "description": "Topic state. Defaults to latest", "enum": [ "latest", "published" ] }, "name": { "type": "string", "description": "Case insensitive partial name to filter by" }, "ids": { "type": "array", "items": { "type": "string" }, "description": "Comma separated Topic IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed." }, "dialects": { "type": "array", "items": { "type": "string", "enum": [ "en-US", "es-US", "en-AU", "en-GB", "en-ZA", "es-ES", "en-IN", "fr-FR", "fr-CA", "it-IT", "de-DE", "pt-BR", "pl-PL", "pt-PT", "nl-NL", "ko-KR" ] }, "description": "Comma separated dialect strings to filter by. Maximum of 15 dialects allowed." }, "sortBy": { "type": "string", "description": "Sort results by. Defaults to name", "enum": [ "name", "matchingType" ] }, "sortOrder": { "type": "string", "description": "Sort order. Defaults to asc", "enum": [ "asc", "desc" ] } }, "required": [ "PCID" ] } ``` *** ## genesys\_speech\_analytics\_get\_topics\_dialects Get list of supported Speech & Text Analytics topics dialects ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## genesys\_speech\_analytics\_get\_topics\_general Get the Speech & Text Analytics general topics for a given dialect **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `dialect` | string | No | — | The dialect of the general topics, dialect format is \{language}-\{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dialect": { "type": "string", "description": "The dialect of the general topics, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard", "enum": [ "ar-001", "ar-AE", "ar-BH", "ar-EG", "ar-IL", "ar-SA", "ar-TN", "da-DK", "de-CH", "de-DE", "en-AU", "en-GB", "en-HK", "en-IE", "en-IN", "en-NZ", "en-SG", "en-US", "en-ZA", "es-ES", "es-US", "fi-FI", "fr-CA", "fr-FR", "he-IL", "hi-IN", "it-IT", "ja-JP", "ko-KR", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "sv-SE", "tr-TR", "zh-CN", "zh-HK", "zh-TW", "zu-ZA" ] } }, "required": [ "PCID" ] } ``` *** ## genesys\_speech\_analytics\_get\_topics\_general\_status Get the list of general topics from the org and the system with their current status **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `dialect` | string | No | — | The dialect of the general topics, dialect format is \{language}-\{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dialect": { "type": "string", "description": "The dialect of the general topics, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard", "enum": [ "ar-001", "ar-AE", "ar-BH", "ar-EG", "ar-IL", "ar-SA", "ar-TN", "da-DK", "de-CH", "de-DE", "en-AU", "en-GB", "en-HK", "en-IE", "en-IN", "en-NZ", "en-SG", "en-US", "en-ZA", "es-ES", "es-US", "fi-FI", "fr-CA", "fr-FR", "he-IL", "hi-IN", "it-IT", "ja-JP", "ko-KR", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "sv-SE", "tr-TR", "zh-CN", "zh-HK", "zh-TW", "zu-ZA" ] } }, "required": [ "PCID" ] } ``` *** ## genesys\_speech\_analytics\_get\_topics\_publishjob Get a Speech & Text Analytics publish topics job by id **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | -------------------------------- | | `jobId` | string | Yes | — | The id of the publish topics job | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "The id of the publish topics job" } }, "required": [ "PCID", "jobId" ] } ``` *** ## genesys\_speech\_analytics\_get\_topics\_testphrase\_job Get a Speech & Text Analytics test topics phrase job by id **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------------------------------- | | `jobId` | string | Yes | — | the id of the test topic phrase job | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "the id of the test topic phrase job" } }, "required": [ "PCID", "jobId" ] } ``` *** ## genesys\_speech\_analytics\_get\_translations\_language\_conversation Translate a single interaction recording (or an email conversation) **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------- | | `languageId` | string | Yes | — | Target translation language | | `conversationId` | string | Yes | — | Conversation id | | `communicationId` | string | No | — | Communication id associated with the conversation. Please provide a valid communicationId when requesting non-email interactions. | | `recordingId` | string | No | — | Recording id associated with the communication. Please provide a valid recordingId when requesting voice interactions. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "languageId": { "type": "string", "description": "Target translation language" }, "conversationId": { "type": "string", "description": "Conversation id" }, "communicationId": { "type": "string", "description": "Communication id associated with the conversation. Please provide a valid communicationId when requesting non-email interactions." }, "recordingId": { "type": "string", "description": "Recording id associated with the communication. Please provide a valid recordingId when requesting voice interactions." } }, "required": [ "PCID", "languageId", "conversationId" ] } ``` *** ## genesys\_speech\_analytics\_get\_translations\_languages Get supported translation languages ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## genesys\_speech\_analytics\_patch\_settings Patch Speech And Text Analytics Settings **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | --------- | -------- | ------- | ------------------------------------------------------------------ | | `agentEmpathyEnabled` | boolean | No | — | Setting to enable/disable Agent Empathy setting | | `defaultProgramId` | string | No | — | Setting to choose name for the default program for topic detection | | `expectedDialects` | string\[] | No | — | Setting to choose expected dialects | | `textAnalyticsEnabled` | boolean | No | — | Setting to enable/disable text analytics | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agentEmpathyEnabled": { "type": "boolean", "description": "Setting to enable/disable Agent Empathy setting" }, "defaultProgramId": { "type": "string", "description": "Setting to choose name for the default program for topic detection" }, "expectedDialects": { "type": "array", "items": { "type": "string" }, "description": "Setting to choose expected dialects" }, "textAnalyticsEnabled": { "type": "boolean", "description": "Setting to enable/disable text analytics" } }, "required": [ "PCID" ] } ``` *** ## genesys\_speech\_analytics\_post\_categories Create new Speech & Text Analytics category **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | -------------------------------------------------- | | `criteria` | object | Yes | — | The criteria value | | `description` | string | No | — | The description of the category | | `interactionType` | string | Yes | — | The type of interaction the category will apply to | | `name` | string | Yes | — | The name of the category | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "criteria": { "type": "object", "description": "The criteria value", "properties": { "type": { "type": "string", "description": "The Operand type of the category", "enum": [ "Term", "Topic", "OperandGroup" ] }, "occurrence": { "type": "integer", "description": "The minimum number of occurrences of the defined operand type" }, "inverted": { "type": "boolean", "description": "Applies a NOT modifier to the operand group" }, "term": { "type": "object", "description": "The term value" }, "topicId": { "type": "string", "description": "Filter interaction by topic ID" }, "voiceSecondsPosition": { "type": "object", "description": "Voice Seconds Position" }, "digitalWordsPosition": { "type": "object", "description": "Digital Words Position" }, "infixOperator": { "type": "object", "description": "Infix Operator" }, "operands": { "type": "array", "items": { "type": "object" }, "description": "Contains a new level of operands" } }, "required": [ "type" ] }, "description": { "type": "string", "description": "The description of the category" }, "interactionType": { "type": "string", "description": "The type of interaction the category will apply to", "enum": [ "Voice", "Digital", "All" ] }, "name": { "type": "string", "description": "The name of the category" } }, "required": [ "PCID", "criteria", "interactionType", "name" ] } ``` *** ## genesys\_speech\_analytics\_post\_dictionaryfeedback Create a Speech & Text Analytics DictionaryFeedback **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `boostValue` | number | No | — | A weighted value assigned to a phrase. The higher the value, the higher the likelihood that the system will choose the word or phrase from the possible alternatives. Boost range is from 1.0 to 10.0. Default is 2.0 | | `createdBy` | object | No | — | Created By | | `dateCreated` | string | No | — | The Timestamp when dictionary feedback created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `dateModified` | string | No | — | The Timestamp when dictionary feedback modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `dialect` | string | Yes | — | The dialect for the given term, dialect format is \{language}-\{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard | | `displayAs` | string | No | — | The display name for the dictionary feedback. | | `examplePhrases` | object\[] | No | — | A list of at least 3 and up to 20 unique phrases that are example usage of the term. This field is only valid for Genesys transcription engine. Not applicable for English and Spanish dialects | | `id` | string | No | — | The globally unique identifier for the object. | | `invalidReason` | string | No | — | The reason the dictionary feedback is invalid | | `modifiedBy` | object | No | — | Modified By | | `selfUri` | string | No | — | The URI for this object | | `soundsLike` | string\[] | No | — | A list of up to 10 terms that give examples of how the term sounds. This field is only valid for Genesys transcription engine. | | `source` | string | No | — | The source of the given dictionary feedback | | `status` | string | No | — | The status of the dictionary feedback | | `term` | string | Yes | — | The dictionary term which needs to be added to dictionary feedback system | | `transcriptionEngine` | string | No | — | The transcription engine for the dictionary feedback. Only returned when GenesysExtended feature is enabled. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "boostValue": { "type": "number", "description": "A weighted value assigned to a phrase. The higher the value, the higher the likelihood that the system will choose the word or phrase from the possible alternatives. Boost range is from 1.0 to 10.0. Default is 2.0" }, "createdBy": { "type": "object", "description": "Created By", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "selfUri": { "type": "string", "description": "The URI for this object" } } }, "dateCreated": { "type": "string", "description": "The Timestamp when dictionary feedback created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "dateModified": { "type": "string", "description": "The Timestamp when dictionary feedback modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "dialect": { "type": "string", "description": "The dialect for the given term, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard" }, "displayAs": { "type": "string", "description": "The display name for the dictionary feedback." }, "examplePhrases": { "type": "array", "items": { "type": "object", "properties": { "phrase": { "type": "string", "description": "The Example Phrase text. At least 3 words and up to 20 words" }, "source": { "type": "string", "enum": [ "Manual" ], "description": "The source of the given Example Phrase" } }, "required": [ "phrase" ] }, "description": "A list of at least 3 and up to 20 unique phrases that are example usage of the term. This field is only valid for Genesys transcription engine. Not applicable for English and Spanish dialects" }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "invalidReason": { "type": "string", "description": "The reason the dictionary feedback is invalid" }, "modifiedBy": { "type": "object", "description": "Modified By", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "selfUri": { "type": "string", "description": "The URI for this object" } } }, "selfUri": { "type": "string", "description": "The URI for this object" }, "soundsLike": { "type": "array", "items": { "type": "string" }, "description": "A list of up to 10 terms that give examples of how the term sounds. This field is only valid for Genesys transcription engine." }, "source": { "type": "string", "description": "The source of the given dictionary feedback", "enum": [ "Manual" ] }, "status": { "type": "string", "description": "The status of the dictionary feedback", "enum": [ "Active", "Pending", "Failed", "Saved", "Invalid" ] }, "term": { "type": "string", "description": "The dictionary term which needs to be added to dictionary feedback system" }, "transcriptionEngine": { "type": "string", "description": "The transcription engine for the dictionary feedback. Only returned when GenesysExtended feature is enabled.", "enum": [ "Genesys", "GenesysExtended" ] } }, "required": [ "PCID", "dialect", "term" ] } ``` *** ## genesys\_speech\_analytics\_post\_programs Create new Speech & Text Analytics program **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | ------------------------------------------- | | `description` | string | No | — | The program description | | `name` | string | Yes | — | The program name | | `tags` | string\[] | No | — | The program tags | | `topicIds` | string\[] | No | — | The ids of topics associated to the program | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "description": { "type": "string", "description": "The program description" }, "name": { "type": "string", "description": "The program name" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "The program tags" }, "topicIds": { "type": "array", "items": { "type": "string" }, "description": "The ids of topics associated to the program" } }, "required": [ "PCID", "name" ] } ``` *** ## genesys\_speech\_analytics\_post\_programs\_general\_jobs Create new Speech & Text Analytics general program job **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `dialect` | string | Yes | — | The dialect of the topics to link with the general program, dialect format is \{language}-\{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard | | `mode` | string | No | — | The mode to use for the general program job, default value is Skip | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dialect": { "type": "string", "description": "The dialect of the topics to link with the general program, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard", "enum": [ "ar-001", "ar-AE", "ar-BH", "ar-EG", "ar-IL", "ar-SA", "ar-TN", "da-DK", "de-CH", "de-DE", "en-AU", "en-GB", "en-HK", "en-IE", "en-IN", "en-NZ", "en-SG", "en-US", "en-ZA", "es-ES", "es-US", "fi-FI", "fr-CA", "fr-FR", "he-IL", "hi-IN", "it-IT", "ja-JP", "ko-KR", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "sv-SE", "tr-TR", "zh-CN", "zh-HK", "zh-TW", "zu-ZA" ] }, "mode": { "type": "string", "description": "The mode to use for the general program job, default value is Skip", "enum": [ "Skip", "Merge", "ReplaceMerge" ] } }, "required": [ "PCID", "dialect" ] } ``` *** ## genesys\_speech\_analytics\_post\_programs\_publishjobs Create new Speech & Text Analytics publish programs job **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | ----------------------------------------- | | `programIds` | string\[] | Yes | — | The ids of the programs used for this job | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "programIds": { "type": "array", "items": { "type": "string" }, "description": "The ids of the programs used for this job" } }, "required": [ "PCID", "programIds" ] } ``` *** ## genesys\_speech\_analytics\_post\_sentimentfeedback Create a Speech & Text Analytics SentimentFeedback **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `createdBy` | object | No | — | Created By | | `dateCreated` | string | No | — | The Timestamp when sentiment feedback created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `dialect` | string | Yes | — | The dialect for the given phrase, dialect format is \{language}-\{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard | | `feedbackValue` | string | Yes | — | The sentiment feedback value for the given phrase | | `id` | string | No | — | The globally unique identifier for the object. | | `phrase` | string | Yes | — | The phrase for which sentiment feedback is provided | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "createdBy": { "type": "object", "description": "Created By", "properties": { "id": { "type": "string", "description": "The id value" }, "selfUri": { "type": "string", "description": "Self Uri" } } }, "dateCreated": { "type": "string", "description": "The Timestamp when sentiment feedback created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "dialect": { "type": "string", "description": "The dialect for the given phrase, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard" }, "feedbackValue": { "type": "string", "description": "The sentiment feedback value for the given phrase", "enum": [ "Neutral", "Positive", "Negative" ] }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "phrase": { "type": "string", "description": "The phrase for which sentiment feedback is provided" } }, "required": [ "PCID", "dialect", "feedbackValue", "phrase" ] } ``` *** ## genesys\_speech\_analytics\_post\_topics Create new Speech & Text Analytics topic **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | --------- | -------- | ------- | -------------------------------------------- | | `description` | string | No | — | The topic description | | `dialect` | string | Yes | — | The topic dialect | | `name` | string | Yes | — | The topic name | | `participants` | string | No | — | The topic participants, default value is All | | `phrases` | object\[] | No | — | The topic phrases | | `programIds` | string\[] | No | — | The ids of programs associated to the topic | | `strictness` | string | No | — | The topic strictness, default value is 72 | | `tags` | string\[] | No | — | The topic tags | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "description": { "type": "string", "description": "The topic description" }, "dialect": { "type": "string", "description": "The topic dialect" }, "name": { "type": "string", "description": "The topic name" }, "participants": { "type": "string", "description": "The topic participants, default value is All", "enum": [ "External", "Internal", "All" ] }, "phrases": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "The phrase text" }, "strictness": { "type": "string", "enum": [ "1", "55", "65", "72", "85", "90" ], "description": "The phrase strictness, default value is null" }, "sentiment": { "type": "string", "enum": [ "Unspecified", "Positive", "Neutral", "Negative" ], "description": "The phrase sentiment, default value is Unspecified. Note: Sentiment value for phrases is currently not in use and has no impact to the system." }, "isAIGenerated": { "type": "boolean", "description": "Indicates whether the phrase is AI generated" } }, "required": [ "text" ] }, "description": "The topic phrases" }, "programIds": { "type": "array", "items": { "type": "string" }, "description": "The ids of programs associated to the topic" }, "strictness": { "type": "string", "description": "The topic strictness, default value is 72", "enum": [ "1", "55", "65", "72", "85", "90" ] }, "tags": { "type": "array", "items": { "type": "string" }, "description": "The topic tags" } }, "required": [ "PCID", "dialect", "name" ] } ``` *** ## genesys\_speech\_analytics\_post\_topics\_publishjobs Create new Speech & Text Analytics publish topics job **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | --------------------------------------- | | `topicIds` | string\[] | Yes | — | The ids of the topics used for this job | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "topicIds": { "type": "array", "items": { "type": "string" }, "description": "The ids of the topics used for this job" } }, "required": [ "PCID", "topicIds" ] } ``` *** ## genesys\_speech\_analytics\_post\_topics\_testphrase\_jobs Create new Speech & Text Analytics publish topics job **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ------------------- | | `topic` | object | Yes | — | The topic value | | `transcriptsFilters` | object | No | — | Transcripts Filters | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "topic": { "type": "object", "description": "The topic value", "properties": { "phrase": { "type": "object", "description": "The phrase value" }, "strictness": { "type": "string", "description": "The topic strictness, default value is 72", "enum": [ "1", "55", "65", "72", "85", "90" ] }, "dialect": { "type": "string", "description": "The topic dialect, default value is en-US" }, "participants": { "type": "string", "description": "The topic participants, default value is both", "enum": [ "External", "Internal", "All" ] } }, "required": [ "dialect", "phrase" ] }, "transcriptsFilters": { "type": "object", "description": "Transcripts Filters", "properties": { "mediaType": { "type": "string", "description": "The media type of the transcripts, default value is all", "enum": [ "call", "message", "email", "chat", "callback", "all" ] }, "startTimeMs": { "type": "integer", "description": "start time to filter by, default value is 7 days into the past" }, "endTimeMs": { "type": "integer", "description": "end time to filter by, default value is current time" }, "programs": { "type": "array", "items": { "type": "string" }, "description": "list of programs ids to filter by" }, "queues": { "type": "array", "items": { "type": "string" }, "description": "list of queues ids to filter by" }, "flows": { "type": "array", "items": { "type": "string" }, "description": "list of flows ids to filter by" } } } }, "required": [ "PCID", "topic" ] } ``` *** ## genesys\_speech\_analytics\_put\_category Update a Speech & Text Analytics category by ID **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | -------------------------------------------------- | | `categoryId` | string | Yes | — | The id of the category | | `criteria` | object | Yes | — | The criteria value | | `description` | string | No | — | The description of the category | | `interactionType` | string | Yes | — | The type of interaction the category will apply to | | `name` | string | Yes | — | The name of the category | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "categoryId": { "type": "string", "description": "The id of the category" }, "criteria": { "type": "object", "description": "The criteria value", "properties": { "type": { "type": "string", "description": "The Operand type of the category", "enum": [ "Term", "Topic", "OperandGroup" ] }, "occurrence": { "type": "integer", "description": "The minimum number of occurrences of the defined operand type" }, "inverted": { "type": "boolean", "description": "Applies a NOT modifier to the operand group" }, "term": { "type": "object", "description": "The term value" }, "topicId": { "type": "string", "description": "Filter interaction by topic ID" }, "voiceSecondsPosition": { "type": "object", "description": "Voice Seconds Position" }, "digitalWordsPosition": { "type": "object", "description": "Digital Words Position" }, "infixOperator": { "type": "object", "description": "Infix Operator" }, "operands": { "type": "array", "items": { "type": "object" }, "description": "Contains a new level of operands" } }, "required": [ "type" ] }, "description": { "type": "string", "description": "The description of the category" }, "interactionType": { "type": "string", "description": "The type of interaction the category will apply to", "enum": [ "Voice", "Digital", "All" ] }, "name": { "type": "string", "description": "The name of the category" } }, "required": [ "PCID", "categoryId", "criteria", "interactionType", "name" ] } ``` *** ## genesys\_speech\_analytics\_put\_dictionaryfeedback\_dictionary\_feedback\_id Update existing Speech & Text Analytics dictionary feedback by id **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `dictionaryFeedbackId` | string | Yes | — | The Id of the Dictionary Feedback | | `boostValue` | number | No | — | A weighted value assigned to a phrase. The higher the value, the higher the likelihood that the system will choose the word or phrase from the possible alternatives. Boost range is from 1.0 to 10.0. Default is 2.0 | | `createdBy` | object | No | — | Created By | | `dateCreated` | string | No | — | The Timestamp when dictionary feedback created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `dateModified` | string | No | — | The Timestamp when dictionary feedback modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `dialect` | string | Yes | — | The dialect for the given term, dialect format is \{language}-\{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard | | `displayAs` | string | No | — | The display name for the dictionary feedback. | | `examplePhrases` | object\[] | No | — | A list of at least 3 and up to 20 unique phrases that are example usage of the term. This field is only valid for Genesys transcription engine. Not applicable for English and Spanish dialects | | `id` | string | No | — | The globally unique identifier for the object. | | `invalidReason` | string | No | — | The reason the dictionary feedback is invalid | | `modifiedBy` | object | No | — | Modified By | | `selfUri` | string | No | — | The URI for this object | | `soundsLike` | string\[] | No | — | A list of up to 10 terms that give examples of how the term sounds. This field is only valid for Genesys transcription engine. | | `source` | string | No | — | The source of the given dictionary feedback | | `status` | string | No | — | The status of the dictionary feedback | | `term` | string | Yes | — | The dictionary term which needs to be added to dictionary feedback system | | `transcriptionEngine` | string | No | — | The transcription engine for the dictionary feedback. Only returned when GenesysExtended feature is enabled. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "dictionaryFeedbackId": { "type": "string", "description": "The Id of the Dictionary Feedback" }, "boostValue": { "type": "number", "description": "A weighted value assigned to a phrase. The higher the value, the higher the likelihood that the system will choose the word or phrase from the possible alternatives. Boost range is from 1.0 to 10.0. Default is 2.0" }, "createdBy": { "type": "object", "description": "Created By", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "selfUri": { "type": "string", "description": "The URI for this object" } } }, "dateCreated": { "type": "string", "description": "The Timestamp when dictionary feedback created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "dateModified": { "type": "string", "description": "The Timestamp when dictionary feedback modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "dialect": { "type": "string", "description": "The dialect for the given term, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard" }, "displayAs": { "type": "string", "description": "The display name for the dictionary feedback." }, "examplePhrases": { "type": "array", "items": { "type": "object", "properties": { "phrase": { "type": "string", "description": "The Example Phrase text. At least 3 words and up to 20 words" }, "source": { "type": "string", "enum": [ "Manual" ], "description": "The source of the given Example Phrase" } }, "required": [ "phrase" ] }, "description": "A list of at least 3 and up to 20 unique phrases that are example usage of the term. This field is only valid for Genesys transcription engine. Not applicable for English and Spanish dialects" }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "invalidReason": { "type": "string", "description": "The reason the dictionary feedback is invalid" }, "modifiedBy": { "type": "object", "description": "Modified By", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "selfUri": { "type": "string", "description": "The URI for this object" } } }, "selfUri": { "type": "string", "description": "The URI for this object" }, "soundsLike": { "type": "array", "items": { "type": "string" }, "description": "A list of up to 10 terms that give examples of how the term sounds. This field is only valid for Genesys transcription engine." }, "source": { "type": "string", "description": "The source of the given dictionary feedback", "enum": [ "Manual" ] }, "status": { "type": "string", "description": "The status of the dictionary feedback", "enum": [ "Active", "Pending", "Failed", "Saved", "Invalid" ] }, "term": { "type": "string", "description": "The dictionary term which needs to be added to dictionary feedback system" }, "transcriptionEngine": { "type": "string", "description": "The transcription engine for the dictionary feedback. Only returned when GenesysExtended feature is enabled.", "enum": [ "Genesys", "GenesysExtended" ] } }, "required": [ "PCID", "dictionaryFeedbackId", "dialect", "term" ] } ``` *** ## genesys\_speech\_analytics\_put\_program Update existing Speech & Text Analytics program **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | ------------------------------------------- | | `programId` | string | Yes | — | The id of the program | | `description` | string | No | — | The program description | | `name` | string | Yes | — | The program name | | `tags` | string\[] | No | — | The program tags | | `topicIds` | string\[] | No | — | The ids of topics associated to the program | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "programId": { "type": "string", "description": "The id of the program" }, "description": { "type": "string", "description": "The program description" }, "name": { "type": "string", "description": "The program name" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "The program tags" }, "topicIds": { "type": "array", "items": { "type": "string" }, "description": "The ids of topics associated to the program" } }, "required": [ "PCID", "programId", "name" ] } ``` *** ## genesys\_speech\_analytics\_put\_program\_mappings Set Speech & Text Analytics program mappings to queues and flows **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | --------- | -------- | ------- | --------------------- | | `programId` | string | Yes | — | The id of the program | | `flowIds` | string\[] | Yes | — | The program flows | | `queueIds` | string\[] | Yes | — | The program queues | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "programId": { "type": "string", "description": "The id of the program" }, "flowIds": { "type": "array", "items": { "type": "string" }, "description": "The program flows" }, "queueIds": { "type": "array", "items": { "type": "string" }, "description": "The program queues" } }, "required": [ "PCID", "programId", "flowIds", "queueIds" ] } ``` *** ## genesys\_speech\_analytics\_put\_program\_settings\_insights Update AI Insights settings of a program **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------- | -------- | ------- | ----------------------- | | `programId` | string | Yes | — | The id of the program | | `enabled` | boolean | Yes | — | The AI Insights setting | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "programId": { "type": "string", "description": "The id of the program" }, "enabled": { "type": "boolean", "description": "The AI Insights setting" } }, "required": [ "PCID", "programId", "enabled" ] } ``` *** ## genesys\_speech\_analytics\_put\_program\_transcriptionengines Update transcription engine settings of a program **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | --------- | -------- | ------- | -------------------------------- | | `programId` | string | Yes | — | The id of the program | | `transcriptionEngines` | object\[] | Yes | — | The transcription engine setting | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "programId": { "type": "string", "description": "The id of the program" }, "transcriptionEngines": { "type": "array", "items": { "type": "object", "properties": { "engine": { "type": "string", "enum": [ "Genesys", "GenesysExtended", "TranscriptionConnector" ], "description": "The engine value" }, "dialects": { "type": "array", "items": { "type": "string" }, "description": "The dialects value" }, "engineIntegration": { "type": "object", "description": "Engine Integration" } } }, "description": "The transcription engine setting" } }, "required": [ "PCID", "programId", "transcriptionEngines" ] } ``` *** ## genesys\_speech\_analytics\_put\_settings Update Speech And Text Analytics Settings **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | --------- | -------- | ------- | ------------------------------------------------------------------ | | `agentEmpathyEnabled` | boolean | No | — | Setting to enable/disable Agent Empathy setting | | `defaultProgramId` | string | No | — | Setting to choose name for the default program for topic detection | | `expectedDialects` | string\[] | No | — | Setting to choose expected dialects | | `textAnalyticsEnabled` | boolean | No | — | Setting to enable/disable text analytics | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agentEmpathyEnabled": { "type": "boolean", "description": "Setting to enable/disable Agent Empathy setting" }, "defaultProgramId": { "type": "string", "description": "Setting to choose name for the default program for topic detection" }, "expectedDialects": { "type": "array", "items": { "type": "string" }, "description": "Setting to choose expected dialects" }, "textAnalyticsEnabled": { "type": "boolean", "description": "Setting to enable/disable text analytics" } }, "required": [ "PCID" ] } ``` *** ## genesys\_speech\_analytics\_put\_topic Update existing Speech & Text Analytics topic **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | --------- | -------- | ------- | -------------------------------------------- | | `topicId` | string | Yes | — | The id of the topic | | `description` | string | No | — | The topic description | | `dialect` | string | Yes | — | The topic dialect | | `name` | string | Yes | — | The topic name | | `participants` | string | No | — | The topic participants, default value is All | | `phrases` | object\[] | No | — | The topic phrases | | `programIds` | string\[] | No | — | The ids of programs associated to the topic | | `strictness` | string | No | — | The topic strictness, default value is 72 | | `tags` | string\[] | No | — | The topic tags | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "topicId": { "type": "string", "description": "The id of the topic" }, "description": { "type": "string", "description": "The topic description" }, "dialect": { "type": "string", "description": "The topic dialect" }, "name": { "type": "string", "description": "The topic name" }, "participants": { "type": "string", "description": "The topic participants, default value is All", "enum": [ "External", "Internal", "All" ] }, "phrases": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "The phrase text" }, "strictness": { "type": "string", "enum": [ "1", "55", "65", "72", "85", "90" ], "description": "The phrase strictness, default value is null" }, "sentiment": { "type": "string", "enum": [ "Unspecified", "Positive", "Neutral", "Negative" ], "description": "The phrase sentiment, default value is Unspecified. Note: Sentiment value for phrases is currently not in use and has no impact to the system." }, "isAIGenerated": { "type": "boolean", "description": "Indicates whether the phrase is AI generated" } }, "required": [ "text" ] }, "description": "The topic phrases" }, "programIds": { "type": "array", "items": { "type": "string" }, "description": "The ids of programs associated to the topic" }, "strictness": { "type": "string", "description": "The topic strictness, default value is 72", "enum": [ "1", "55", "65", "72", "85", "90" ] }, "tags": { "type": "array", "items": { "type": "string" }, "description": "The topic tags" } }, "required": [ "PCID", "topicId", "dialect", "name" ] } ```