/genesys-social | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
genesys_social_delete_escalationrule | Delete an escalation rule. |
genesys_social_delete_topic | Delete a social topic. |
genesys_social_get_analytics_aggregates_job | Get status for async query for social media aggregates |
genesys_social_get_analytics_aggregates_job_results | Fetch a page of results for an async social media query |
genesys_social_get_analytics_messages_job | Get status for async query for social media messages job |
genesys_social_get_analytics_messages_job_results | Fetch a page of results for an async social media messages query |
genesys_social_get_escalationrule | Get a single escalation rule. |
genesys_social_get_escalationrules | Retrieve all escalation rules for a division. |
genesys_social_get_topic | Get a single social topic. |
genesys_social_get_topic_dataingestionrules | Retrieve all social topic data ingestion rules with pagination. |
genesys_social_get_topics | Retrieve all social topics. |
genesys_social_patch_topic | Update a social topic. |
genesys_social_post_analytics_aggregates_jobs | Query for social media aggregates asynchronously |
genesys_social_post_analytics_messages_jobs | Query for social media messages asynchronously |
genesys_social_post_escalationrules | Create an escalation rule. |
genesys_social_post_escalations_messages | Escalate message to a conversation manually |
genesys_social_post_topics | Create a social topic. |
genesys_social_put_escalationrule | Update the escalation rule. |
genesys_social_delete_escalationrule
Delete an escalation rule. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
escalationRuleId | string | Yes | — | escalationRuleId |
genesys_social_delete_topic
Delete a social topic. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
topicId | string | Yes | — | topicId |
hardDelete | boolean | No | — | Determines whether a Social topic should be soft-deleted or hard-deleted (permanently removed). Set to false (soft-delete) by default. |
genesys_social_get_analytics_aggregates_job
Get status for async query for social media aggregates Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
jobId | string | Yes | — | jobId |
genesys_social_get_analytics_aggregates_job_results
Fetch a page of results for an async social media query Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
jobId | string | Yes | — | jobId |
cursor | string | No | — | Cursor token to retrieve next page |
genesys_social_get_analytics_messages_job
Get status for async query for social media messages job Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
jobId | string | Yes | — | jobId |
genesys_social_get_analytics_messages_job_results
Fetch a page of results for an async social media messages query Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
jobId | string | Yes | — | jobId |
cursor | string | No | — | Cursor token to retrieve next page |
genesys_social_get_escalationrule
Get a single escalation rule. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
escalationRuleId | string | Yes | — | escalationRuleId |
expand | string | No | — | which fields, if any, to expand |
genesys_social_get_escalationrules
Retrieve all escalation rules for a division. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageNumber | integer | No | — | Page number |
pageSize | integer | No | — | Page size |
divisionId | string | Yes | — | One division ID |
genesys_social_get_topic
Get a single social topic. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
topicId | string | Yes | — | topicId |
includeDeleted | boolean | No | — | Determines whether to include soft-deleted items in the result. |
genesys_social_get_topic_dataingestionrules
Retrieve all social topic data ingestion rules with pagination. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
topicId | string | Yes | — | topicId |
pageNumber | integer | No | — | Page number |
pageSize | integer | No | — | Page size |
includeDeleted | boolean | No | — | Determines whether to include soft-deleted items in the result. |
genesys_social_get_topics
Retrieve all social topics. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageNumber | integer | No | — | Page number |
pageSize | integer | No | — | Page size |
divisionIds | any[] | No | — | One or more division IDs. If nothing is provided, the social topics associated withthe list of divisions that the user has access to will be returned. |
includeDeleted | boolean | No | — | Determines whether to include soft-deleted items in the result. |
name | string | No | — | Search for topic by name that contains the given search string, search is case insensitive |
ids | any[] | No | — | One or more topic IDs to search through the topics. |
genesys_social_patch_topic
Update a social topic. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
topicId | string | Yes | — | topicId |
description | string | No | — | A description of the social topic. |
divisionId | string | No | — | The ID of the division the social topic currently belongs to OR which it should be moved to. |
name | string | No | — | Name of the social topic. |
genesys_social_post_analytics_aggregates_jobs
Query for social media aggregates asynchronously Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter | object | No | — | filter |
granularity | string | No | — | Granularity metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H |
groupBy | any[] | No | — | Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting computations into distinct named subgroups rather than across the entire result set as if it were one group. |
interval | string | Yes | — | Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss |
metrics | any[] | Yes | — | Behaves like a SQL SELECT clause. Only named metrics will be retrieved. |
pageSize | integer | No | — | The number of results per page |
timeZone | string | No | — | Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London |
genesys_social_post_analytics_messages_jobs
Query for social media messages asynchronously Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter | object | No | — | filter |
interval | string | Yes | — | Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss |
order | string | No | — | Sorting of results based on time |
pageSize | integer | No | — | The number of results per page |
timeZone | string | No | — | Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London |
topicIds | any[] | No | — | List of topicIds to query in |
genesys_social_post_escalationrules
Create an escalation rule. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | A description of the social escalation rule. |
divisionId | string | No | — | The ID of the division the social escalation rule belongs to. |
facebookEscalation | object | No | — | facebookEscalation |
googleBusinessProfileEscalation | object | No | — | googleBusinessProfileEscalation |
instagramEscalation | object | No | — | instagramEscalation |
matchCriteria | string | No | — | The criteria that defines when a social media message should be escalated. |
name | string | No | — | The name of the escalation rule. |
openEscalation | object | No | — | openEscalation |
priority | integer | No | — | The priority of the escalation rule. The lower the number the higer the priority. Once a rule is matched others are skipped. |
status | string | No | — | The status of the escalation rule. |
twitterEscalation | object | No | — | twitterEscalation |
genesys_social_post_escalations_messages
Escalate message to a conversation manually Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
divisionId | string | Yes | — | One division ID |
escalationTarget | object | No | — | escalationTarget |
socialMediaNormalizedMessageId | string | No | — | The social media normalized message ID to be escalated. |
genesys_social_post_topics
Create a social topic. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | A description of the social topic. |
divisionId | string | No | — | The ID of the division the social topic belongs to. |
name | string | No | — | Name of the social topic. |
genesys_social_put_escalationrule
Update the escalation rule. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
escalationRuleId | string | Yes | — | escalationRuleId |
description | string | No | — | A description of the social escalation rule. |
divisionId | string | No | — | The ID of the division the social escalation rule belongs to. |
facebookEscalation | object | No | — | facebookEscalation |
googleBusinessProfileEscalation | object | No | — | googleBusinessProfileEscalation |
instagramEscalation | object | No | — | instagramEscalation |
matchCriteria | string | No | — | The criteria that defines when a social media message should be escalated. |
name | string | No | — | The name of the escalation rule. |
openEscalation | object | No | — | openEscalation |
priority | integer | No | — | The priority of the escalation rule. The lower the number the higer the priority. Once a rule is matched others are skipped. |
status | string | No | — | The status of the escalation rule. |
twitterEscalation | object | No | — | twitterEscalation |

