RingCentral Digital
API integration

get_single_ring_central_digital_topology_by_id

Get a RingCX Digital topology by id. Returns: name, created_at, updated_at, id, config, active. Required: id.

update_a_ring_central_digital_topology_by_id

Update an existing RingCX Digital topology by id with given attributes. Returns: name, created_at, updated_at, id, config, active. The topology must be inactive or the request will return an error. Required: id.

delete_a_ring_central_digital_topology_by_id

Delete a RingCentral Digital topology by id. Returns the deleted topology object including its id and name. A 404 is returned if the id is invalid. Required: id.

list_all_ring_central_digital_topologies

List all RingCentral Digital topologies ordered alphabetically by name. Returns: count, limit, offset, records.

create_a_ring_central_digital_topology

Create a topology in RingCentral RingCX Digital. Returns the created topology object including its id, name, and topology-specific attributes. A 422 error is returned on validation failure.

ring_central_digital_topologies_activate

Activate an existing topology in RingCentral Digital, rendering it in case of success. Returns the activated topology object including its id, name, and active status. Required: topology_id.

list_all_ring_central_digital_attachments

List RingCentral Digital attachments ordered by creation date (descending). Returns: count, limit, offset, records. Filter by extension, created_before, or created_after. Max 150 records per page.

create_a_ring_central_digital_attachment

Create a new RingCentral Digital attachment by uploading a file via multipart form data. Returns: content_type, created_at, embed, filename, foreign_id, id, public?, size, updated_at, url, video_metadata.

get_single_ring_central_digital_attachment_by_id

Get a single RingCentral Digital attachment by id. Returns: content_type, created_at, embed, filename, foreign_id, id, public?, size, updated_at, url, video_metadata. Required: id.

create_a_ring_central_digital_bots_engage

Engage a thread from a bot in RingCentral Digital, opening an intervention as the virtual agent user. Returns the intervention object including id, source_id, thread_id, user_id, identity_id, and category_ids. Required: content_id.

create_a_ring_central_digital_bots_complete

Complete a bot intervention in RingCentral Digital, closing the intervention and completing the associated task. Returns a 200 success response on completion; renders a 422 error on failure. Required: intervention_id.

create_a_ring_central_digital_bots_handover

Handover a conversation between a bot and an agent in RingCentral Digital, supporting both source-specific handovers (e.g. Messenger) and Virtual Agent to human agent transfers, with optional thread recategorization. Returns an opaque success response confirming the handover was processed. Required: from, to, type, identity_foreign_id.

list_all_ring_central_digital_categories

List RingCentral Digital categories ordered by creation date ascending. Returns: count, limit, offset, records. Max 150 per page.

create_a_ring_central_digital_category

Create a new RingCentral Digital category. Returns the created category object including id, name, color, parent_id, and created_at. The fields mandatory, multiple, post_qualification, source_ids, and unselectable are accounted for only if the category has no parent.

get_single_ring_central_digital_category_by_id

Get a single RingCentral Digital category by id. Returns: color, created_at, id, mandatory, multiple, name, parent_id, post_qualification, source_ids, unselectable, updated_at. Required: id.

update_a_ring_central_digital_category_by_id

Update an existing RingCentral Digital category by id. Returns the updated category object including id, name, color, parent_id, and created_at. The fields mandatory, multiple, post_qualification, source_ids, and unselectable are accounted for only if the category has no parent. Required: id.

delete_a_ring_central_digital_category_by_id

Delete a RingCentral Digital category by id. Returns the deleted category object including id, name, color, parent_id, and created_at. Optionally pass take_over_category_id to recategorize existing items to another category. Required: id.

list_all_ring_central_digital_channels

List all RingCentral Digital channels ordered by date of creation. Returns: count, limit, offset, records, name. Max 150 records per page.

get_single_ring_central_digital_channel_by_id

Get a single RingCentral Digital channel by id. Returns: created_at, hard_capability, id, label, name, soft_capability, source_ids, task_timeout_seconds, agent_sla, agent_sla_threshold, updated_at, auto_complete_category_ids, task_auto_complete_seconds, status, busyness, custom_status. Required: id.

update_a_ring_central_digital_channel_by_id

Update an existing RingCentral Digital channel by id with attributes such as name, source assignments, capability limits, and SLA settings. Returns: created_at, hard_capability, id, label, name, soft_capability, source_ids, task_timeout_seconds, agent_sla, agent_sla_threshold, updated_at, auto_complete_category_ids, task_auto_complete_seconds, status, busyness, custom_status. Required: id.

list_all_ring_central_digital_communities

List all RingCentral Engage Digital communities ordered by creation date in ascending order. Returns: count, limit, offset, records, name. Max 150 records per page.

get_single_ring_central_digital_community_by_id

Get a single RingCentral Engage Digital community by id. Returns: active, created_at, id, name, type, updated_at, title, available, comments_count. Required: id.

list_all_ring_central_digital_content_sources

List content sources in RingCentral Digital ordered by creation date (ascending). Returns: count, limit, offset, records. Max 150 records per page.

get_single_ring_central_digital_content_source_by_id

Get a single RingCentral Engage Digital content source by id. Returns: active, auto_detect_content_language, channel_id, color, color_hex, community_id, content_archiving, content_archiving_period, content_languages, created_at, default_category_ids, default_content_language, enable_android, enable_ios, enable_web, auto_response_triggers, auto_response_trigger_enabled,…. Required: id.

update_a_ring_central_digital_content_source_by_id

Update an existing RingCentral Engage Digital content source with attributes such as name, active state, channel, SLA settings, content language, auto-response triggers, and email (IMAP/SMTP) configuration. Returns the updated source object including id, name, active, channel_id, color, and SLA configuration. Required: id.

content_source_email_credentials_bulk_update

Update IMAP and SMTP email credentials for an email content source in RingCentral Digital. Returns the updated content source object including its id, type, and metadata. Only applies to email sources; a 422 error is returned on failure. Required: source_id.

list_all_ring_central_digital_content_threads

List RingCentral Digital content threads ordered by last content date (descending). Returns: count, limit, offset, records. Only threads in sources where the token's user has read permission are returned.

get_single_ring_central_digital_content_thread_by_id

Get a single RingCentral Digital content thread by id. Returns: category_ids, closed, contents_count, created_at, extra_data, foreign_id, id, interventions_count, source_id, thread_category_ids, title, updated_at, status, closed_at, deferred_at, custom_field_values. Required: id.

ring_central_digital_content_thread_closes_bulk_update

Close a RingCentral Engage Digital content thread by starting an asynchronous close job. Returns the thread object including id, close, and thread_category_ids. Only supported for Emails, Answers, Ideas, Facebook Messenger, Google+, Lithium, and Mobile Messaging sources; the close attribute may not reflect the updated state immediately. Required: thread_id.

ring_central_digital_content_thread_ignores_bulk_update

Archive (ignore) a content thread in RingCentral Digital. Returns the thread object including id, status, source_id, close, and thread_category_ids. Returns 409 if the thread is already being archived. Required: thread_id.

get_single_ring_central_digital_content_thread_open_by_id

Open a closed content thread in RingCentral Engage Digital by starting an asynchronous job. Returns the thread object including id, type, and close; the close attribute reflects the state when the job started, not after completion. Only available for Emails, Answers, Ideas, Facebook Messenger, Google+, Lithium, and Mobile Messaging sources. Required: id.

content_thread_update_categories_bulk_update

Update the categories of a RingCentral Engage Digital content thread. Returns the updated Thread object including id, close, status, source_id, and category_ids. Returns 404 if the user lacks read permission on the thread's channel, or 409 if the thread is already being categorized. Required: thread_id.

content_thread_disable_text_inputs_bulk_update

Disable text input on a RingCentral Digital messaging thread. Returns the updated messaging thread object including its id. Only applicable to messaging threads; returns 404 if the thread is not a messaging thread or the user lacks read permission on the channel. Required: thread_id.

content_thread_enable_text_inputs_bulk_update

Enabling text input on a thread. Returns: category_ids, closed, contents_count, created_at, extra_data, foreign_id, id, interventions_count. Required: thread_id.

list_all_ring_central_digital_contents

List RingCX Digital contents ordered by creation date descending. Returns: count, limit, offset, records. Optional q parameter supports filtering by keywords including intervention, identity, identity_group, source, status_in, thread, or text.

create_a_ring_central_digital_content

Create new content in RingCX Digital as a reply or to initiate a discussion. Returns the created content object including id, body, author_id, source_id, thread_id, and status. Source-specific parameters like source_id or in_reply_to_id may also be required depending on the channel. Required: body.

get_single_ring_central_digital_content_by_id

Get a single RingCX Digital content by id. Returns the full content object including id, body, author_id, source_id, thread_id, intervention_id, status, and date. Required: id.

ring_central_digital_content_ignores_bulk_update

Ignore a RingCentral Digital content by its content id. Returns the full content object including id, body, status, thread_id, author_id, and source_id. A 404 is returned if the token's user lacks read permission on the content's source. Required: content_id.

ring_central_digital_content_update_categories_bulk_update

Update the categories of a RingCentral Digital content item. Returns the updated Content object including id, body, source_id, thread_id, and category_ids. A 404 is returned if the token's user lacks read permission on the content's source. Required: content_id, category_ids[].

ring_central_digital_content_update_custom_scores_bulk_update

Update the custom score of a content in RingCentral Digital. Returns the updated content object including id, source_id, thread_id, identity_id, custom_score, category_ids, and created_at. Only available for contents from channels specified in the Sentiment Analysis configuration with custom sentiment analysis enabled. Required: content_id, custom_score.

list_all_ring_central_digital_custom_fields

List all RingCentral Digital custom fields ordered by position (ascending). Returns each record including id, associated_type_name, label, key, type, choices, multiple, position, and read_only.

create_a_ring_central_digital_custom_field

Create a new RingCentral Digital custom field. Returns the created custom field including id, associated_type_name, label, key, type, choices, multiple, position, and read_only. Required: associated_type_name, label.

get_single_ring_central_digital_custom_field_by_id

Get a single RingCentral Digital custom field by id. Returns: associated_type_name, created_at, id, key, label, multiple, position, type, updated_at, choices, read_only. Required: id.

update_a_ring_central_digital_custom_field_by_id

Update an existing RingCentral Digital custom field by id. Returns the updated custom field including id, associated_type_name, label, key, type, choices, multiple, position, and read_only. Required: id.

delete_a_ring_central_digital_custom_field_by_id

Delete a RingCentral Digital custom field by id. The API renders the deleted custom field object on success. Returns: associated_type_name, created_at, id, key, label, multiple, position, type, updated_at, choices, read_only. Required: id.

list_all_ring_central_digital_events

List RingCentral Digital events ordered by creation date (descending). Returns each event with id, type, resource, issued_at, and user_id. Filter via the q parameter using keywords such as content, content_thread, name_in, created_before, created_after, and user.

get_single_ring_central_digital_event_by_id

Get a single RingCentral Digital event by id. Returns: created_at, extra_infos, id, name, updated_at, user_id, type, resource, issued_at, action. Required: id.

list_all_ring_central_digital_folders

List RingCentral Digital folders (shared folders and search folders belonging to the current user). Returns: count, limit, offset, records. Max 150 records per page.

create_a_ring_central_digital_folder

Create a new RingCentral Digital folder. Returns: id, created_at, updated_at, label, parent_id, position, query, render_threads_count, role_restriction, team_restriction, user_restriction, user_id, attributes. Label is mandatory per the API.

get_single_ring_central_digital_folder_by_id

Get a RingCentral Digital folder by id. Returns: id, created_at, updated_at, label, parent_id, position, query, render_threads_count, role_restriction, team_restriction, user_restriction, user_id, attributes. Required: id.

update_a_ring_central_digital_folder_by_id

Update an existing RingCentral Digital folder by id. Returns: id, created_at, updated_at, label, parent_id, position, query, render_threads_count, role_restriction, team_restriction, user_restriction, user_id, attributes. Required: id.

delete_a_ring_central_digital_folder_by_id

Delete a RingCentral Digital folder by id. Returns the deleted folder object including its id and attributes. Required: id.

list_all_ring_central_digital_identities

List RingCentral Digital identities ordered by creation date (descending). Returns each identity with id, uuid, identifier, firstname, lastname, gender, company, source_id, community_id, created_at, and updated_at. Max 150 per page.

get_single_ring_central_digital_identity_by_id

Get a single RingCentral Digital identity by id. Returns the identity object including id, uuid, identifier, firstname, lastname, gender, company, source_id, created_at, and updated_at. Required: id.

create_a_ring_central_digital_identities_import

Import an identity in RingCentral Engage Digital for Email or Phone communities, creating a new identity or matching an existing one by identifier. Returns: avatar_url, community_id, community_url, company, created_at, display_name, email, extra_values, firstname, foreign_id, gender, home_phone, id, identity_group_id, lastname, mobile_phone, screenname, type, updated_at, user_ids, uuid,…. Required: community_id, identifier.

list_all_ring_central_digital_identity_groups

List RingCentral Engage Digital identity groups ordered by creation date descending. Returns each identity group with id, firstname, lastname, emails, company, gender, created_at, updated_at. Identity groups are created lazily and may not cover all identities. Max 150 records per page.

get_single_ring_central_digital_identity_group_by_id

Get a single RingCentral Engage Digital identity group by id. Returns the identity group including id, firstname, lastname, emails, company, gender, home_phones, mobile_phones, notes, tag_ids, custom_field_values, uuid, created_at, updated_at. Required: id.

update_a_ring_central_digital_identity_group_by_id

Update a RingCentral Engage Digital identity group's attributes by id. Returns the updated identity group including id, firstname, lastname, emails, gender, created_at, updated_at. Returns 409 if the group is already being updated. Required: id.

ring_central_digital_identity_group_merges_bulk_update

Merge an identity into an identity group in RingCentral RingCX. In case of conflicts, the identity group's existing attributes are kept. Returns the merged identity group including its id, firstname, lastname, emails, and created_at. Required: identity_group_id, associated_identity_id.

list_all_ring_central_digital_interface_locales

List all available user interface locales in RingCentral Digital. Returns an array of UI locale objects, each with an id.

list_all_ring_central_digital_intervention_comments

List intervention comments in RingCentral Engage Digital ordered by creation date descending. Returns each comment's id, body, intervention_id, user_id, thread_id, and created_at. Filter optionally by intervention_id, thread_id, user_id, or identity_id. Max 150 records per page.

create_a_ring_central_digital_intervention_comment

Create a new intervention comment in RingCentral Engage Digital. Returns the created comment including id, body, intervention_id, user_id, and created_at. Required: body, intervention_id, user_id.

get_single_ring_central_digital_intervention_comment_by_id

Get a single intervention comment by id in RingCentral Engage Digital. Returns: body, created_at, id, intervention_id, thread_id, updated_at, user_id, videntity_id. Required: id.

delete_a_ring_central_digital_intervention_comment_by_id

Delete an intervention comment by id in RingCentral Engage Digital. Returns the deleted comment including id, body, intervention_id, user_id, and created_at. Required: id.

list_all_ring_central_digital_interventions

List RingCX Digital interventions ordered by creation date descending. Returns each intervention with id, source_id, thread_id, user_id, status, created_at, and custom_field_values. Max 150 per page.

create_a_ring_central_digital_intervention

Create a new intervention or reopen an existing one in RingCX Digital. Returns the intervention including id, content_id, source_id, thread_id, and custom_field_values. Returns 422 if the intervention can't be created or reopened. Required: content_id.

get_single_ring_central_digital_intervention_by_id

Get a single RingCX Digital intervention by id. Returns the intervention including id, content_id, source_id, thread_id, status, created_at, and custom_field_values. Required: id.

update_a_ring_central_digital_intervention_by_id

Update a RingCX Digital intervention by id, setting custom field values. Returns the updated intervention including id, source_id, thread_id, user_id, and custom_field_values. Required: id.

ring_central_digital_interventions_cancel

Cancel (destroy) a RingCX Digital intervention. Returns the cancelled intervention including id, source_id, thread_id, user_id, and custom_field_values. Returns 403 if already closed or has agent replies; 409 if already being canceled. Required: intervention_id.

ring_central_digital_intervention_closes_bulk_update

Close an intervention in RingCentral Digital. Returns the updated intervention object including id, status, source_id, thread_id, closed_at, and deferred_at. The intervention must not already be closed, must have agent replies, and the agent must own it or have edit permissions with read access on the source; a 409 is returned if already being closed. Required: intervention_id.

ring_central_digital_intervention_reassigns_bulk_update

Reassign a RingCentral Digital intervention to a different user by updating the user in charge. Returns the updated Intervention object including id, user_id, status, source_id, thread_id, created_at, and updated_at. Required: intervention_id, user_id.

ring_central_digital_intervention_update_categories_bulk_update

Update the categories of a RingCentral Digital intervention by providing one or more category ids. Returns the updated intervention object including id, source_id, thread_id, category_ids, and closed_at. Required: intervention_id, category_ids[].

list_all_ring_central_digital_locales

Getting all content locales. Returns: code, interface, name.

list_all_ring_central_digital_presence_status

List all presence statuses in RingCentral Digital, ordered alphabetically by name. Returns: count, limit, offset, records. Max 150 records per page.

create_a_ring_central_digital_presence_status

Create a presence status in RingCentral Digital. Returns: created_at, id, name, updated_at. Required: name.

get_single_ring_central_digital_presence_status_by_id

Get a single presence status by id in RingCentral Digital. Returns: created_at, id, name, updated_at. Required: id.

update_a_ring_central_digital_presence_status_by_id

Update an existing presence status in RingCentral Digital. Returns: created_at, id, name, updated_at. Required: id, name.

delete_a_ring_central_digital_presence_status_by_id

Delete a presence status by id in RingCentral Digital. Returns the deleted presence status including id and name. Required: id.

list_all_ring_central_digital_reply_assistant_entries

List all RingCX Digital reply assistant entries ordered by creation date ascending. Returns each entry with id, label, foreign_id, category_ids, shortcuts, entry_group_id, and source_ids. Max 150 per page.

create_a_ring_central_digital_reply_assistant_entry

Create a RingCX Digital reply assistant entry. Returns the created entry with id, label, foreign_id, category_ids, shortcuts, entry_group_id, and source_ids. Required: label.

get_single_ring_central_digital_reply_assistant_entry_by_id

Get a RingCX Digital reply assistant entry by id. Returns the entry with id, label, foreign_id, category_ids, shortcuts, entry_group_id, and source_ids. Required: id.

update_a_ring_central_digital_reply_assistant_entry_by_id

Update a RingCX Digital reply assistant entry by id. Returns the updated entry with id, label, foreign_id, category_ids, shortcuts, entry_group_id, and source_ids. Required: id.

delete_a_ring_central_digital_reply_assistant_entry_by_id

Delete a RingCX Digital reply assistant entry by id. Returns the deleted entry with id, label, foreign_id, category_ids, shortcuts, entry_group_id, and source_ids. Required: id.

list_all_ring_central_digital_reply_assistant_groups

List all RingCentral Digital reply assistant groups ordered by creation date (ascending). Returns: count, limit, offset, records, name.

create_a_ring_central_digital_reply_assistant_group

Create a new RingCentral Digital reply assistant group. Returns: autocomplete, created_at, entry_ids, id, name, position, updated_at. Required: name.

get_single_ring_central_digital_reply_assistant_group_by_id

Get a single RingCentral Digital reply assistant group by id. Returns: autocomplete, created_at, entry_ids, id, name, position, updated_at. Required: id.

update_a_ring_central_digital_reply_assistant_group_by_id

Update an existing RingCentral Digital reply assistant group by id. Returns: autocomplete, created_at, entry_ids, id, name, position, updated_at. Required: id.

delete_a_ring_central_digital_reply_assistant_group_by_id

Delete a RingCentral Digital reply assistant group by id. Returns: autocomplete, created_at, entry_ids, id, name, position, updated_at. Required: id.

list_all_ring_central_digital_reply_assistant_versions

List all RingCentral Digital reply assistant versions ordered by creation date ascending. Returns records with id, body, entry_id, format, language, and created_at. Max 150 records per page.

create_a_ring_central_digital_reply_assistant_version

Create a new reply assistant version in RingCentral Digital. Returns the created version including id, body, entry_id, format, language, and created_at. Required: body, entry_id.

get_single_ring_central_digital_reply_assistant_version_by_id

Get a single RingCentral Digital reply assistant version by id. Returns: attachments_count, body, created_at, entry_id, format, id, language, source_ids, updated_at. Required: id.

update_a_ring_central_digital_reply_assistant_version_by_id

Update an existing RingCentral Digital reply assistant version by id. Returns the updated version including id, body, entry_id, format, language, and created_at. Required: id.

delete_a_ring_central_digital_reply_assistant_version_by_id

Delete a RingCentral Digital reply assistant version by id. Returns the deleted version object including id, body, entry_id, format, language, and created_at. Required: id.

list_all_ring_central_digital_roles

List all RingCentral Engage Digital roles ordered by creation date. Returns: count, limit, offset, records. Max 150 per page.

create_a_ring_central_digital_role

Create a new RingCentral Engage Digital role with a label and optional permission flags. Returns: access_help_center, access_previous_messages, access_pull_mode, admin_stamp_answer, anonymize_identity, approve_content, ask_an_expert, assign_intervention, author_block_content, close_content_thread, create_and_destroy_extension, create_community, create_content_source, create_user, created_at,…. Required: label.

get_single_ring_central_digital_role_by_id

Get a single RingCentral Engage Digital role by id. Returns: access_help_center, access_previous_messages, access_pull_mode, admin_stamp_answer, anonymize_identity, approve_content, ask_an_expert, assign_intervention, author_block_content, close_content_thread, create_and_destroy_extension, create_community, create_content_source, create_user, created_at, delay_export_content,…. Required: id.

update_a_ring_central_digital_role_by_id

Update an existing RingCentral Engage Digital role's permissions by id. Returns: access_help_center, access_previous_messages, access_pull_mode, admin_stamp_answer, anonymize_identity, approve_content, ask_an_expert, assign_intervention, author_block_content, close_content_thread, create_and_destroy_extension, create_community, create_content_source, create_user, created_at, delay_export_content,…. Required: id.

list_all_ring_central_digital_settings

Get all RingCentral Digital domain settings. Returns: activity_presence_threshold, activity_tracking, beginning_of_week, browser_notifications_disabled, content_languages[], created_at, deny_iframe_integration, disable_password_autocomplete, display_only_unknown_bbcode, dump_in_preprod, enable_auto_scroll_down, expire_password_after, expire_password_enabled, fte_duration, id, identity_merge,…

ring_central_digital_settings_bulk_update

Update RingCentral Digital domain settings. Returns the updated settings object including activity_tracking, dashboard, locale, name, timezone, type, and session_timeout.

list_all_ring_central_digital_status

List all currently connected agents and their status in RingCentral Digital. Returns each agent's id, channels, and custom_status. Filter by source_ids, category_ids, team_ids, or spoken_languages.

get_single_ring_central_digital_status_by_id

Get a single connected agent's status by id in RingCentral Digital. Returns: agent_id, channels, custom_status, id. Returns 404 if the user does not exist or is not connected. Required: id.

update_a_ring_central_digital_status_by_id

Update an agent's availability status in RingCentral Digital. Returns: agent_id, channels, custom_status, id. The status parameter must be either "away" or "available"; if both status and custom_status_id are provided, custom status is ignored. Required: id.

list_all_ring_central_digital_surveys

List all RingCentral Digital surveys ordered by creation date ascending. Returns: count, limit, offset, records.

get_single_ring_central_digital_survey_by_id

Get a single RingCentral Digital survey by id. Returns: id, created_at, updated_at, name, link, active, from_name, instant_send_threshold, max_time_since_last_reply, send_delay, category_ids, team_ids, source_ids, type, questions. Required: id.

get_single_ring_central_digital_survey_response_by_id

Get a RingCentral Digital survey response by id. Returns the response object including id, submitted_at, main_indicator, main_indicator_scaled, intervention_id, survey_id, source_id, user_id, questions with replies, response_foreign_id, and deprecated answers/foreign_id fields. Required: id.

list_all_ring_central_digital_tags

List all RingCentral Engage Digital tags ordered by name (ascending). Returns: count, limit, offset, records. Max 150 per page.

create_a_ring_central_digital_tag

Create a new tag in RingCentral Engage Digital. Returns the created tag including its id and name. Required: name.

get_single_ring_central_digital_tag_by_id

Get a RingCentral Digital tag by id. Returns: created_at, id, name, updated_at. Required: id.

update_a_ring_central_digital_tag_by_id

Update an existing RingCentral Digital tag's label. Returns the updated tag object including its id and name. Required: id, name.

delete_a_ring_central_digital_tag_by_id

Delete an existing RingCentral Digital tag by id. Returns the deleted tag object including its id and name. Required: id.

list_all_ring_central_digital_tasks

List RingCentral Engage Digital tasks ordered by priority (highest first) then by creation date (latest first). Returns task records including id, created_at, channel_id, priority, agent_ids, queue, and step. Max 150 per page.

get_single_ring_central_digital_task_by_id

Get a single RingCentral Engage Digital task by id. Returns the task object including id, created_at, channel_id, priority, agent_ids, action, queue, and step. Required: id.

ring_central_digital_tasks_complete

Complete a RingCentral Engage Digital task by moving it to a specified queue. Returns the task object including id, created_at, channel_id, priority, agent_ids, action, queue, and step. The task must be in an agent's workbin and the caller must own or monitor the task. Required: task_id, queue.

create_a_ring_central_digital_task_move

Move a RingCentral Digital task to another queue. Returns the task object including id, created_at, queue, priority, channel_id, content_id, and agent_ids. Only accepts "undelivered" and special queues defined in topology (e.g. triage). Required: task_id, queue.

create_a_ring_central_digital_task_transfer

Transfer an existing RingCentral Digital task to specified agents, optionally filtering recipients by category, language, or team. Returns the transferred task object including id, queue, agent_ids, priority, and created_at. Required: task_id.

list_all_ring_central_digital_teams

List RingCentral Engage Digital teams ordered by creation date (ascending). Returns: count, limit, offset, records, name.

create_a_ring_central_digital_team

Create a new RingCentral Engage Digital team. Returns: created_at, id, leader_ids, name, updated_at, user_ids.

get_single_ring_central_digital_team_by_id

Get a RingCentral Engage Digital team by id. Returns: created_at, id, leader_ids, name, updated_at, user_ids. Required: id.

update_a_ring_central_digital_team_by_id

Update an existing RingCentral Engage Digital team by id. Returns: created_at, id, leader_ids, name, updated_at, user_ids. Required: id.

delete_a_ring_central_digital_team_by_id

Delete a RingCentral Engage Digital team by id. Returns the deleted team object including id, name, created_at. Required: id.

list_all_ring_central_digital_time_sheets

List RingCentral Digital time sheets ordered by active and label. Returns an array of time sheet objects.

create_a_ring_central_digital_time_sheet

Create a new time sheet in RingCentral Digital with a label, optional active status, source associations, holidays, and daily business hours. Returns the created time sheet object. Required: label.

get_single_ring_central_digital_time_sheet_by_id

Get a single RingCentral Digital time sheet by id. Returns the time sheet object. Required: id.

update_a_ring_central_digital_time_sheet_by_id

Update an existing RingCentral Digital time sheet by id, modifying attributes such as label, active status, source associations, holidays, and daily business hours. Returns the updated time sheet object. Required: id.

delete_a_ring_central_digital_time_sheet_by_id

Delete a RingCentral Digital time sheet by id. Returns the deleted time sheet object. Required: id.

list_all_ring_central_digital_timezones

Getting all timezones. Returns: name, utc_offset.

list_all_ring_central_digital_user_capacities

List all user capacities in RingCentral Engage Digital ordered by creation date ascending. Returns: count, limit, offset, records, name. Max 150 per page.

create_a_ring_central_digital_user_capacity

Create a new user capacity in RingCentral Engage Digital. Returns: channels, created_at, id, name, updated_at. The order of channel parameters matters — default_capacity and max_capacity apply to the immediately preceding channel_id. Required: name.

get_single_ring_central_digital_user_capacity_by_id

Get a single user capacity by id in RingCentral Engage Digital. Returns: channels, created_at, id, name, updated_at. Required: id.

update_a_ring_central_digital_user_capacity_by_id

Update an existing user capacity in RingCentral Engage Digital. Returns: channels, created_at, id, name, updated_at. The order of channel parameters matters — default_capacity and max_capacity apply to the immediately preceding channel_id. Required: id.

delete_a_ring_central_digital_user_capacity_by_id

Delete a user capacity by id in RingCentral Engage Digital. Returns: channels, created_at, id, name, updated_at. Required: id.

list_all_ring_central_digital_users

List RingCentral Engage Digital users ordered by creation date (descending). Returns: count, limit, offset, records. Filter by email, category_id, identity_id, external_id, role_id, or team_id.

create_a_ring_central_digital_user

Create a new user in RingCentral Engage Digital. Returns the created user including id, email, firstname, lastname, role_id, and created_at. Required: email, firstname, lastname, password, role_id.

get_single_ring_central_digital_user_by_id

Get a single RingCentral Engage Digital user by id. Returns the user object including id, email, firstname, lastname, role_id, and created_at. Required: id.

update_a_ring_central_digital_user_by_id

Update a RingCentral Engage Digital user by id with the given attributes. Returns the updated user including id, email, firstname, lastname, role_id, and created_at. Required: id.

delete_a_ring_central_digital_user_by_id

Delete a RingCentral Engage Digital user by id. Returns the deleted user object including id, email, firstname, lastname, role_id, and created_at. Required: id.

create_a_ring_central_digital_users_invite

Invite a new user in RingCentral Digital by sending an invitation. Returns the created user object including id, email, firstname, lastname, role_id, enabled, gender, created_at, and updated_at. Required: email, firstname, lastname, role_id.

list_all_ring_central_digital_user_sources_permissions

List a user's permissions on each source in RingCentral Engage Digital. Returns a hash mapping each source id to a comma-separated string of the user's permissions on that source. Required: user_id.

ring_central_digital_user_sources_permissions_bulk_update

Update a user's permissions on sources in RingCentral Engage Digital. Pass a source id as the query parameter name with a comma-separated list of permissions as the value. Returns a hash mapping each source id to a comma-separated string of permissions. Required: user_id.

list_all_ring_central_digital_user_signatures

List all RingCentral Engage Digital user signatures ordered by creation date (descending). Returns: count, limit, offset, records. Required: user_id.

create_a_ring_central_digital_user_signature

Create a new RingCentral Engage Digital user signature. Returns: id, body, name, source_ids, language, created_at. Required: user_id, body.

update_a_ring_central_digital_user_signature_by_id

Update a RingCentral Engage Digital user signature by id. Returns: id, body, name, source_ids, language, created_at. Required: id, user_id.

delete_a_ring_central_digital_user_signature_by_id

Delete a RingCentral Engage Digital user signature by id. Returns: id, body, name, source_ids, language, created_at. Required: id, user_id.

get_single_ring_central_digital_user_signature_by_id

Get a single RingCentral Engage Digital user signature by id. Returns the signature including its id, body, name, language, source_ids, and created_at. Required: id, user_id.

list_all_ring_central_digital_webhooks

List all RingCentral Digital webhooks ordered by active and staging_use (descending). Returns: count, limit, offset, records. Required: access_token.

create_a_ring_central_digital_webhook

Create a new webhook in RingCentral Digital. Returns the created webhook object including id, active, name, url, and registered_events. Required: access_token, url, registered_events[].

get_single_ring_central_digital_webhook_by_id

Get a single RingCentral Digital webhook by id. Returns: active, api_access_token, id, registered_events, staging_use, url, verify_token, webhook_status, name, secret. Required: id, access_token.

update_a_ring_central_digital_webhook_by_id

Update an existing RingCentral Digital webhook by id. Returns the updated webhook object including id, active, name, url, and registered_events. Required: id, access_token.

delete_a_ring_central_digital_webhook_by_id

Delete a RingCentral Digital webhook by id. Returns the deleted webhook object including id, active, name, url, and registered_events. Required: id, access_token.