RingCentral Voice
API integration

ring_central_voice_ringcentral_auth_login_with_rc_access_token

Log in a RingCentral user in ringcentralvoice by exchanging a RingCentral access token for an Engage access token and user details. Returns: accessToken, adminId, adminPasswordReset, adminUrl, agentDetails, agentUrl, analyticsUrl, iqUrl, isAdminPasswordReset, loginHashcode, mainAccountId, platformId, port, rcUser, redirectUrl, refreshToken, ssoLogin, tokenType. Required: rcAccessToken,…

ring_central_voice_ringcentral_auth_refresh

Refresh an expired Engage access token in ringcentralvoice using a previously obtained refresh token. Returns: accessToken, refreshToken, tokenType. Required: refresh_token.

ring_central_voice_legacy_auth_create_api_token

Create a new non-expiring API token for the authenticated user in ringcentralvoice. Returns the newly created API token string.

ring_central_voice_legacy_auth_remove_api_token

Remove an API token from the authenticated user in ringcentralvoice by token_id. Returns a boolean indicating success. Required: token_id.

ring_central_voice_legacy_auth_do_login

Authenticate to the ringcentralvoice legacy platform and receive an X-Auth-Token. Returns: accounts, authToken, platformHost, user. Required: username, password.

list_all_ring_central_voice_agents

List agents for a RingCentral RingCX agent group. Returns: active, errorCode, generalMessage, timestamp. Required: account_id, agent_group_id.

create_a_ring_central_voice_agent

Create a single agent in a RingCentral RingCX agent group. Returns the created agent object including agentId, firstName, lastName, email, agentType, and username. Required: account_id, agent_group_id, attributes.

delete_a_ring_central_voice_agent_by_id

Delete a single agent from a RingCentral RingCX agent group by id. Returns a boolean indicating whether the deletion was successful. Required: account_id, agent_group_id, id.

get_single_ring_central_voice_agent_by_id

Get a single agent for a RingCentral RingCX agent group by id. Returns: active, errorCode, generalMessage, timestamp. Required: account_id, agent_group_id, id.

update_a_ring_central_voice_agent_by_id

Update a single agent for an agent group in RingCentral RingCX. Returns the updated agent object including agentId, firstName, lastName, email, agentType, isActive, and permissions. Required: account_id, agent_group_id, id.

ring_central_voice_agents_assign_to_gate

Assign a listing of agents to a queue (AKA gate) in RingCentral Engage Voice. Returns an array of agent objects including agentId, firstName, lastName, email, agentType, and gateAssignments. Required: account_id, gate_group_id, gate_id.

ring_central_voice_agents_get_assigned_for_gate

List agents assigned to a specific queue (AKA gate) in RingCentral RingCX. Returns: active, errorCode, generalMessage, timestamp. Required: account_id, gate_group_id, gate_id.

ring_central_voice_agents_bulk_update

Update a listing of agents for a RingCentral RingCX agent group. Returns an array of updated agent objects including agentId, firstName, lastName, email, and agentType. Required: account_id, agent_group_id, and a request body array of agent configuration objects.

list_all_ring_central_voice_agent_groups

List agent groups for a RingCentral RingCX account. Returns: errorCode, generalMessage, timestamp. Required: account_id.

create_a_ring_central_voice_agent_group

Create a new agent group for a RingCentral RingCX account. Returns the created agent group including account, agentGroupId, agents, groupName, isDefault, and permissions. Required: account_id.

delete_a_ring_central_voice_agent_group_by_id

Delete an agent group from a RingCentral RingCX account by id. Returns a boolean indicating whether the deletion was successful. Required: account_id, id.

get_single_ring_central_voice_agent_group_by_id

Get a single agent group for a RingCentral RingCX account by id. Returns: errorCode, generalMessage, timestamp. Required: account_id, id.

update_a_ring_central_voice_agent_group_by_id

Update an agent group for a RingCentral RingCX account by id. Returns the updated agent group including account, agentGroupId, agents, groupName, isDefault, and permissions. Required: account_id, id.

ring_central_voice_users_assign_account_to_root

Assign an account to a root user in RingCentral RingCX. Returns a boolean indicating whether the assignment succeeded. Required: user_id, accountId.

get_single_ring_central_voice_user_by_id

Get a single RingCX user by id. Returns: errorCode, generalMessage, timestamp. Required: id.

delete_a_ring_central_voice_user_by_id

Delete a RingCX user by id. Returns an empty 200 response on success. Required: id.

update_a_ring_central_voice_user_by_id

Update a RingCX user by id. Returns the updated user object including userId, userName, firstName, lastName, fullName, enabled, phoneNumber, phoneNumberE164, roles, regionalSettings, and rootUser. Required: id.

ring_central_voice_users_assign_account_to_any

Assign an account to any RingCentral RingCX user. Returns a boolean indicating whether the assignment succeeded. Required: user_id, accountId.

ring_central_voice_users_list_children

List a hierarchical listing of all child users that a RingCX user has access to. Returns: errorCode, generalMessage, timestamp. Required: user_id.

ring_central_voice_users_set_is_active

Set whether a RingCX user is active or inactive. Returns a boolean value indicating the result of the operation. Required: user_id, isActive.

list_all_ring_central_voice_user_roles

List roles assigned to a user in RingCentral RingCX. Returns a bare array of role name strings. Required: user_id.

ring_central_voice_rights_docs_assign

Assign a RingCentral Voice rights document to one or more users. Returns a boolean indicating whether the assignment was successful. Required: rights_doc_id, user_ids.

ring_central_voice_rights_docs_create_master

Create a new master rights document for a RingCentral Voice user. Returns the created rights document including its rightsDocId, rightsDocName, accountId, accountPermissions, assigned, cascade, isMaster, ownerId, productPermissions, and resourcePermissions. Required: user_id.

ring_central_voice_rights_docs_delete_master

Delete an existing master rights document for a RingCentral Voice user. Returns an empty 204 response on success. Required: user_id, rights_doc_id.

create_a_ring_central_voice_rights_doc

Create a new rights document for a RingCentral Voice user. Returns the created rights document including its rightsDocId, rightsDocName, accountId, accountPermissions, assigned, cascade, isMaster, ownerId, productPermissions, and resourcePermissions. Required: user_id.

delete_a_ring_central_voice_rights_doc_by_id

Delete an existing rights document for a RingCentral Voice user. Returns an empty 204 response on success. Required: user_id, id.

create_a_ring_central_voice_user_dashboard

Create a new dashboard for a RingCentral Voice user. Returns: id, errorCode, generalMessage, timestamp. Required: user_id.

get_single_ring_central_voice_user_dashboard_by_id

Get a single dashboard for a RingCentral Voice user by id. Returns: id, errorCode, generalMessage, timestamp. Required: user_id, id.

update_a_ring_central_voice_user_dashboard_by_id

Update an existing dashboard for a RingCentral Voice user by id. Returns: id, errorCode, generalMessage, timestamp. Required: user_id, id.

ring_central_voice_user_auth_utils_duplicate_authenticated_user

Duplicate the authenticated user's session in ringcentralvoice and return a new auth token. Returns: id, errorCode, generalMessage, timestamp. No required parameters.

ring_central_voice_user_auth_utils_is_token_valid

Check whether the current auth token is valid in ringcentralvoice. Returns a minimal validity confirmation with no documented fields on success. No required parameters.

ring_central_voice_user_auth_utils_password_reset

Reset a RingCentral RingCX user's password using a reset token and a new password. Returns a boolean indicating whether the reset succeeded. Required: token, password.

ring_central_voice_user_auth_utils_password_reset_request

Request a password reset for a locked-out RingCentral RingCX user; a reset email is sent to the user. Returns a boolean indicating the request was processed.

ring_central_voice_reporting_get_report_criteria_template

Get a report criteria definition template for a specific report type in RingCentral RingCX. Returns: accountId, criteriaType, databaseTimezone, endDate, endDateRange, scheduleTimezoneName, startDate, startDateRange, timezoneName. Required: report_type.

ring_central_voice_reporting_get_agent_summary_by_segment

Get the agent-edited summary for a specific interaction segment in RingCentral RingCX. Returns the summary text as a string. Required: sub_account_id, segment_id.

ring_central_voice_reporting_get_auto_summary_by_segment

Get the AI-generated summary for a specific interaction segment in RingCentral RingCX. Returns the summary text as a string. Required: sub_account_id, segment_id.

list_all_ring_central_voice_queues

List all queues (AKA gates) for a queue group in RingCentral Voice. Returns: abandonCampaign, acceptTime, afterCallBaseState, afterCallState, agentConnSoapService, agentGateAccess, agentPopMessage, agentTermSoapService, appUrl, backupAppUrl, billingCode, blockedAniMessage, callbackCampaign, createdOn, dequeueDelay, dequeueSoapService, dispositionTimeout, enableGlobalPhoneBook, enableIvrTokens,…

create_a_ring_central_voice_queue

Create a new queue (AKA gate) for a queue group in RingCentral Voice. Returns the created gate object including gateId, gateName, gateDesc, gateOpen, isActive, gatePriority, recordingSettings, requeueType, and configuration fields. Required: account_id, gate_group_id.

delete_a_ring_central_voice_queue_by_id

Delete a queue (AKA gate) from a queue group in RingCentral Voice by id. Returns an empty 204 response on success. Required: account_id, gate_group_id, id.

get_single_ring_central_voice_queue_by_id

Get a single queue (AKA gate) for a queue group in RingCentral Voice by id. Returns: abandonCampaign, acceptTime, afterCallBaseState, afterCallState, agentConnSoapService, agentGateAccess, agentPopMessage, agentTermSoapService, appUrl, backupAppUrl, billingCode, blockedAniMessage, callbackCampaign, createdOn, dequeueDelay, dequeueSoapService, dispositionTimeout, enableGlobalPhoneBook,…

update_a_ring_central_voice_queue_by_id

Update a queue (AKA gate) for a queue group in RingCentral Voice by id. Returns the updated gate object including gateId, gateName, gateDesc, gateOpen, isActive, gatePriority, recordingSettings, requeueType, perspectiveRecordingMode, and configuration fields. Required: account_id, gate_group_id, id.

ring_central_voice_queues_assign_to_priority_group

Assign a RingCentral Voice queue (gate) to a queue priority group. Returns the updated queue object including gateId, gateName, isActive, gatePriority, and gatePriorityGroup. Required: account_id, gate_id, gatePriorityGroupId.

ring_central_voice_queues_clone

Create a clone of an existing RingCentral Voice queue (gate) within a queue group. Returns the cloned queue object including gateId, gateName, isActive, gatePriority, and createdOn. Required: account_id, gate_group_id, gate_id.

ring_central_voice_queues_move_to_group

Move an existing RingCentral Voice queue (gate) to a different queue group. Returns the updated queue object including gateId, gateName, gateGroup, and isActive. Required: account_id, gate_group_id, gate_id.

ring_central_voice_queues_set_active

Set the active state of a RingCentral Voice queue (gate). Returns the updated queue object including gateId, gateName, isActive, and gatePriority. Required: account_id, gate_group_id, gate_id, isActive.

ring_central_voice_queue_groups_list_with_children

List queue groups (gate groups) for a RingCentral Voice account with related child data such as gates and group skills. Returns: gateGroupId, groupName, billingKey, createdOn, startDate, endDate, gates, groupSkills, permissions. Required: account_id.

ring_central_voice_queue_groups_list_with_children_additional

List queue groups (gate groups) for a RingCentral Voice account with related and additional data beyond the standard list_with_children response. Returns: gateGroupId, groupName, billingKey, createdOn, startDate, endDate, gates, groupSkills, permissions. Required: account_id.

delete_a_ring_central_voice_queue_group_by_id

Delete a single queue group (gate group) in RingCentral Voice by id. Returns an empty 204 response on success. Required: account_id, id.

get_single_ring_central_voice_queue_group_by_id

Get a single queue group (gate group) for a RingCentral Voice account by id. Returns: gateGroupId, groupName, billingKey, createdOn, startDate, endDate, gates, groupSkills, permissions. Required: account_id, id.

update_a_ring_central_voice_queue_group_by_id

Update a single queue group (gate group) for a RingCentral Voice account by id with modified gate group attributes. Returns: gateGroupId, groupName, billingKey, createdOn, startDate, endDate, gates, groupSkills, permissions. Required: account_id, id.

list_all_ring_central_voice_queue_dispositions

List dispositions for a queue (gate) in RingCentral Voice. Returns: destCampaign, dispSoapService, disposition, dncTagLabel, doNotCall, dtmfMapping, emailDestinations, emailTemplate, gateDispositionId, isComplete, isContact, isDefault, isDisabled, isRequeued, isSuccess, rank, requeueDelay, requireNote, saveSurvey, setAgentFlag, timeout, xfer, xferDest. Required: account_id, gate_group_id, gate_id.

create_a_ring_central_voice_queue_disposition

Create a disposition for a queue (gate) in RingCentral Voice. Returns the created disposition including disposition, gateDispositionId, isComplete, isContact, isSuccess, rank, requeueDelay, doNotCall, xferDest. Required: account_id, gate_group_id, gate_id.

ring_central_voice_queue_dispositions_save_list

Save a list of dispositions for a queue (gate) in RingCentral Voice. Returns the saved dispositions including disposition, gateDispositionId, isComplete, isContact, isSuccess, rank, doNotCall, xferDest. Required: account_id, gate_group_id, gate_id.

delete_a_ring_central_voice_queue_disposition_by_id

Delete a disposition for a queue (AKA gate) in RingCentral Engage Voice. Returns an empty 204 response on success. Required: account_id, gate_group_id, gate_id, id.

get_single_ring_central_voice_queue_disposition_by_id

Get a single disposition for a queue (AKA gate) in RingCentral Voice. Returns: gateDispositionId, disposition, dncTagLabel, doNotCall, dtmfMapping, emailDestinations, emailTemplate, destCampaign, dispSoapService, isComplete, isContact, isDefault, isDisabled, isRequeued, isSuccess, rank, requeueDelay, requireNote, saveSurvey, setAgentFlag, timeout, xfer, xferDest. Required: account_id,…

update_a_ring_central_voice_queue_disposition_by_id

Update a single disposition for a queue (gate) in RingCentral Engage Voice. Returns the updated disposition including gateDispositionId, disposition, rank, isComplete, isContact, isSuccess, xferDest, and additional configuration fields. Required: account_id, gate_group_id, gate_id, id.

list_all_ring_central_voice_queue_events

List gate queue events for a specific queue (gate) in RingCentral Engage Voice. Returns: subscriptionName, retryCount, notificationUrl, authConfigId, active, customHeaders, expiresAt. Required: account_id, gate_group_id, gate_id.

create_a_ring_central_voice_queue_event

Create a new gate queue event for a specific queue (gate) in RingCentral Engage Voice. Returns: subscriptionName, retryCount, notificationUrl, authConfigId, active, customHeaders, expiresAt. Required: account_id, gate_group_id, gate_id.

ring_central_voice_queue_events_save_list

Save a list of gate queue events for a specific queue (gate) in RingCentral Engage Voice, replacing the existing list. Returns: subscriptionName, retryCount, notificationUrl, authConfigId, active, customHeaders, expiresAt. Required: account_id, gate_group_id, gate_id.

delete_a_ring_central_voice_queue_event_by_id

Delete a gate queue event for a specific queue (gate) in RingCentral Engage Voice. Returns an empty 204 response on success. Required: account_id, gate_group_id, gate_id, id.

get_single_ring_central_voice_queue_event_by_id

Get a single gate queue event for a specific queue (gate) in RingCentral Engage Voice. Returns: subscriptionName, retryCount, notificationUrl, authConfigId, active, customHeaders, expiresAt. Required: account_id, gate_group_id, gate_id, id.

update_a_ring_central_voice_queue_event_by_id

Update a single gate queue event subscription for a queue (gate) in RingCentral Voice. Returns: subscriptionName, description, retryCount, notificationUrl, authConfigId, active, customHeaders, expiresAt. Required: account_id, gate_group_id, gate_id, id.

list_all_ring_central_voice_queue_events_dtmf

List Gate Queue DTMF Events for a queue in RingCentral Voice. Returns: id, subscriptionName, retryCount, notificationUrl, authConfigId, active, customHeaders, expiresAt. Required: account_id, gate_group_id, gate_id.

create_a_ring_central_voice_queue_events_dtmf

Create a new Gate Queue DTMF Event for a queue in RingCentral Voice. Returns: id, subscriptionName, retryCount, notificationUrl, authConfigId, active, customHeaders, expiresAt. Required: account_id, gate_group_id, gate_id.

ring_central_voice_queue_events_dtmf_save_list

Update a listing of Gate Queue DTMF Events for a queue in RingCentral Voice. Returns: id, subscriptionName, retryCount, notificationUrl, authConfigId, active, customHeaders, expiresAt. Required: account_id, gate_group_id, gate_id.

delete_a_ring_central_voice_queue_events_dtmf_by_id

Delete a Gate Queue DTMF Event by id in RingCentral Voice. Returns an empty 204 response on success. Required: account_id, gate_group_id, gate_id, id.

get_single_ring_central_voice_queue_events_dtmf_by_id

Get a single Gate Queue DTMF Event by id in RingCentral Voice. Returns: id, subscriptionName, retryCount, notificationUrl, authConfigId, active, customHeaders, expiresAt. Required: account_id, gate_group_id, gate_id, id.

update_a_ring_central_voice_queue_events_dtmf_by_id

Update a single Gate Queue DTMF Event in RingCentral Voice. Returns: id, created_at, updated_at, subscriptionName, retryCount, notificationUrl, authConfigId, active, customHeaders, expiresAt. Required: account_id, gate_group_id, gate_id, id.

list_all_ring_central_voice_queue_phone_book

List all phone book entries for a queue (AKA gate) in ringcentralvoice. Returns: id, created_at, updated_at. Required: account_id, gate_group_id, gate_id.

create_a_ring_central_voice_queue_phone_book

Create a phone book entry for a queue (AKA gate) in ringcentralvoice. Returns: id, created_at, updated_at. Required: account_id, gate_group_id, gate_id.

delete_a_ring_central_voice_queue_phone_book_by_id

Delete a single phone book entry for a queue (AKA gate) in ringcentralvoice by id. Returns an empty 204 response on success. Required: account_id, gate_group_id, gate_id, id.

update_a_ring_central_voice_queue_phone_book_by_id

Update a phone book entry for a queue (AKA gate) in ringcentralvoice by id. Returns: id, created_at, updated_at. Required: account_id, gate_group_id, gate_id, id.

list_all_ring_central_voice_queue_skills

List all queue skills for a gate group (AKA queue group) in RingCentral Engage Voice. Returns: skillId, skillName, skillDesc, active, rank, whisperAudio, name, createdOn, startDate, agentSkillProfiles, requeueShortcut, requeueShortcutId, permissions. Required: account_id, gate_group_id.

create_a_ring_central_voice_queue_skill

Create a new queue skill for a gate group (AKA queue group) in RingCentral Engage Voice. Returns the created skill including skillId, skillName, skillDesc, active, rank, and whisperAudio. Required: account_id, gate_group_id.

ring_central_voice_queue_skills_save_list

Update an existing list of queue skills for a gate group (AKA queue group) in RingCentral Engage Voice. Returns the updated skills including skillId, skillName, skillDesc, active, and rank. Required: account_id, gate_group_id.

delete_a_ring_central_voice_queue_skill_by_id

Delete a queue skill from a gate group (AKA queue group) in RingCentral Engage Voice by id. Returns an empty 204 response on success. Required: account_id, gate_group_id, id.

get_single_ring_central_voice_queue_skill_by_id

Get a single queue skill for a gate group (AKA queue group) in RingCentral Engage Voice by id. Returns: skillId, skillName, skillDesc, active, rank, whisperAudio, name, createdOn, startDate, agentSkillProfiles, requeueShortcut, requeueShortcutId, permissions. Required: account_id, gate_group_id, id.

update_a_ring_central_voice_queue_skill_by_id

Update a queue skill for a gate group in RingCentral Engage Voice. Returns the updated skill object including skillId, skillName, skillDesc, active, rank, and createdOn. Required: account_id, gate_group_id, id.

list_all_ring_central_voice_requeue_shortcuts

List requeue shortcuts for a specific queue (gate) in ringcentralvoice. Returns: id. Required: account_id, gate_group_id, gate_id.

create_a_ring_central_voice_requeue_shortcut

Create requeue shortcuts for a specific queue (gate) in ringcentralvoice. Returns: id. Required: account_id, gate_group_id, gate_id.

delete_a_ring_central_voice_requeue_shortcut_by_id

Delete a requeue shortcut for a specific queue (gate) in ringcentralvoice by id. Returns an empty 204 response on success. Required: account_id, gate_group_id, gate_id, id.

get_single_ring_central_voice_requeue_shortcut_by_id

Get a single requeue shortcut for a specific queue (gate) in ringcentralvoice by id. Returns: id. Required: account_id, gate_group_id, gate_id, id.

update_a_ring_central_voice_requeue_shortcut_by_id

Update a requeue shortcut for a specific queue (gate) in ringcentralvoice by id. Returns: id. Required: account_id, gate_group_id, gate_id, id.

ring_central_voice_queue_schedule_list_overrides

List schedule overrides for a queue (gate) in RingCentral Engage Voice. Returns: overrideId, gateId, createdOn, startDate, endDate. Required: account_id, gate_group_id, gate_id.

ring_central_voice_queue_schedule_create_override

Create a schedule override for a queue (gate) in RingCentral Engage Voice. Returns: overrideId, gateId, createdOn, startDate, endDate. Required: account_id, gate_group_id, gate_id.

ring_central_voice_queue_schedule_save_list

Save (replace) the full list of schedule overrides for a queue (gate) in RingCentral Engage Voice. Returns: overrideId, gateId, createdOn, startDate, endDate. Required: account_id, gate_group_id, gate_id.

ring_central_voice_queue_schedule_delete_override

Delete a schedule override for a queue (gate) in RingCentral RingCX. Returns an empty 204 response on success. Required: account_id, gate_group_id, gate_id, scheduleoverride_id.

ring_central_voice_queue_schedule_bulk_update

Update a schedule override for a queue (gate) in RingCentral RingCX. Returns the updated schedule override object including its id. Required: account_id, gate_group_id, gate_id, scheduleoverride_id.

list_all_ring_central_voice_queue_special_ani

List special ANIs configured for a queue (gate) in ringcentralvoice. Returns a listing of special ANI records, each containing id. Required: account_id, gate_group_id, gate_id.

create_a_ring_central_voice_queue_special_ani

Create a special ANI for a queue (gate) in ringcentralvoice. Returns the created special ANI record including its id. Required: account_id, gate_group_id, gate_id.

delete_a_ring_central_voice_queue_special_ani_by_id

Delete a special ANI for a queue (gate) in ringcentralvoice by id. Returns an empty 204 response on success. Required: account_id, gate_group_id, gate_id, id.

ring_central_voice_queue_special_ani_upload_list

Upload a special ANI list for a queue (gate) in ringcentralvoice. Returns the uploaded special ANI record including its id. Required: account_id, gate_group_id, gate_id.

ring_central_voice_active_calls_create_manual_agent_call

Create a manual agent call in RingCentral RingCX for the specified account. Returns: id. Required: account_id.

list_all_ring_central_voice_active_calls

List current active calls for a given product or externalId on a RingCentral RingCX account. Returns: id. Required: account_id.

ring_central_voice_active_calls_check_queue_status

Check the queue status for a RingCentral RingCX account's active calls. Returns: id. Required: account_id.

ring_central_voice_active_calls_check_queue_threshold

Check the queue threshold for active calls on a RingCentral Voice account. Returns queue threshold status for the specified account. Required: account_id.

ring_central_voice_active_calls_add_session

Add a new session to an active call in RingCentral Voice. Returns the result of the session creation for the specified call. Required: account_id, call_id.

ring_central_voice_active_calls_disposition_call

Set the call disposition for an inbound or outbound active call in RingCentral RingCX, releasing the agent from PD state. Returns an empty 204 response on success. Required: account_id.

ring_central_voice_active_calls_hangup_call

Terminate an active call in RingCentral RingCX. Returns an empty 204 response on success. Required: account_id, call_id.

ring_central_voice_active_calls_hangup_session

Terminate an active session within a call in RingCentral RingCX. Returns an empty 204 response on success. Required: account_id, call_id, session_id.

ring_central_voice_active_calls_toggle_recording

Toggle call recording on or off for an active call in RingCentral RingCX. Returns an empty 204 response on success. Required: account_id, call_id.

list_all_ring_central_voice_campaigns

List campaigns for a dial group in ringcentralvoice. Returns: campaignId, campaignName, campaignDesc, campaignPriority, isActive, dncScrubOption, monSched, tueSched, wedSched, thuSched, friSched, satSched, sunSched, dispositionTimeout, maxPasses, maxDailyPasses, maxRingTime, maxDialLimit, machineDetect, exportFlag, recordCall, recordingSettings, requeueType, campaignDispositions,…

create_a_ring_central_voice_campaign

Create a new campaign for a dial group in ringcentralvoice. Returns the created campaign object including campaignId, campaignName, campaignDesc, campaignPriority, and isActive. Required: account_id, dial_group_id.

delete_a_ring_central_voice_campaign_by_id

Delete a campaign from a dial group in ringcentralvoice by id. Returns an empty 204 response on success. Required: account_id, dial_group_id, id.

get_single_ring_central_voice_campaign_by_id

Get a single campaign by id from a dial group in ringcentralvoice. Returns: campaignId, campaignName, campaignDesc, campaignPriority, isActive, dncScrubOption, monSched, tueSched, wedSched, thuSched, friSched, satSched, sunSched, dispositionTimeout, maxPasses, maxDailyPasses, maxRingTime, maxDialLimit, machineDetect, exportFlag, recordCall, recordingSettings, requeueType, campaignDispositions,…

update_a_ring_central_voice_campaign_by_id

Update an existing campaign for a dial group in ringcentralvoice by id. Returns the updated campaign object including campaignId, campaignName, campaignDesc, campaignPriority, and isActive. Required: account_id, dial_group_id, id.

ring_central_voice_campaigns_perform_lead_action

Perform a lead action against matching campaign leads in RingCentral RingCX based on given search criteria. Returns an empty 204 response on success. Required: account_id, dial_group_id, campaign_id.

ring_central_voice_campaigns_force_dialer_refresh

Clear the dialer cache for a campaign in RingCentral RingCX. Returns an empty 204 response on success. Required: account_id, dial_group_id, campaign_id.

ring_central_voice_leads_search_campaign_leads

Search campaign leads for a single campaign in RingCentral Voice. Returns: id. Required: account_id, dial_group_id, campaign_id.

ring_central_voice_leads_get_lead_states

List all lead states for a RingCentral Voice account. Returns: id. Required: account_id.

ring_central_voice_leads_get_system_dispositions

List all system dispositions for a RingCentral Voice account. Returns: id. Required: account_id.

ring_central_voice_leads_patch_campaign_lead

Partially update a campaign lead in RingCentral Voice by campaignlead_id, modifying only the fields provided in the request. Returns: id. Required: account_id, campaignlead_id.

ring_central_voice_leads_load_direct_leads

Upload a single lead or list of leads to a new or existing list in RingCentral RingCX. The request body contains lead data sent as JSON; the response shape is not documented in the available source. Required: account_id.

ring_central_voice_leads_bulk_update

Update a campaign lead in RingCentral Voice by campaignlead_id, replacing the entire lead including fields not passed in the request. Returns: id. Required: account_id, campaignlead_id.

list_all_ring_central_voice_dial_groups

List dial groups for a RingCentral Voice account. Returns each dial group with its dialGroupId, dialGroupName, dialMode, isActive, and campaigns. Required: account_id.

create_a_ring_central_voice_dial_group

Create a dial group for a RingCentral Voice account. Returns the created dial group including its dialGroupId, dialGroupName, dialMode, isActive, and campaigns. Required: account_id, dialGroupName.

ring_central_voice_dial_groups_list_with_children

List dial groups with associated campaigns for a RingCentral Voice account. Returns each dial group with its dialGroupId, dialGroupName, dialMode, campaigns, and agentDialGroupMembers. Required: account_id.

delete_a_ring_central_voice_dial_group_by_id

Delete a dial group for a RingCentral Voice account by id. Returns an empty 204 response on success. Required: account_id, id.

get_single_ring_central_voice_dial_group_by_id

Get a single dial group for a RingCentral Voice account by id. Returns the full dial group object including dialGroupId, dialGroupName, dialMode, isActive, campaigns, and maxPorts. Required: account_id, id.

update_a_ring_central_voice_dial_group_by_id

Update a dial group for a RingCentral RingCX account. Returns the updated dial group object including dialGroupId, dialGroupName, dialMode, isActive, and hciEnabled. Required: account_id, id.

ring_central_voice_dial_groups_assign_agents

Assign a listing of agents to a RingCentral RingCX dial group. Returns an empty 204 response on success. Required: account_id, dial_group_id, agentId.

ring_central_voice_dial_groups_get_assigned_agents

List all agents assigned to a RingCentral Engage Voice dial group. Returns each agent record including agentId, firstName, lastName, email, username, agentType, isActive, createdOn, dialGroupAssignments. Required: account_id, dial_group_id.

ring_central_voice_outbound_preview_lead_list

Upload new leads to a new or existing lead list in RingCentral RingCX. Returns the upload result object. Required: account_id.

ring_central_voice_outbound_load_list

Upload new leads to a new or existing lead list in RingCentral RingCX. Returns the upload result object. Required: account_id.

ring_central_voice_outbound_fetch_persona_phone_config

Fetch persona phone configurations for a RingCentral RingCX account. Returns the configuration objects. Required: account_id.

ring_central_voice_outbound_create_persona_phone_config

Create a persona phone configuration for a RingCentral RingCX account. Returns the created configuration object. Required: account_id.

ring_central_voice_outbound_delete_persona_phone_config

Delete a persona phone configuration in RingCentral Engage Voice. Returns an empty 204 response on success. Required: account_id, personaphoneconfig_id.

ring_central_voice_outbound_bulk_update

Update a persona phone configuration for a RingCentral RingCX account. Returns the updated configuration object. Required: account_id, personaphoneconfig_id.

ring_central_voice_audit_logs_get_auditable_entities

Get the list of system entities eligible for auditing in RingCentral Voice. Returns an array of auditable entity objects. No required parameters.

ring_central_voice_audit_logs_search

Search administrative audit records in RingCentral Voice by posting search criteria as a JSON body. Returns matching audit log entries.

list_all_ring_central_voice_countries

List available countries for a RingCentral RingCX account. Returns the list of countries available to the specified account. Required: account_id.

agent_access_get_logged_in_agents_by_group_per_queue

Get the count of agents in an agent group currently logged into a specific queue in RingCentral Voice. Returns: errorCode, generalMessage, timestamp. Required: account_id, agent_group_id, gate_id.

ring_central_voice_agent_access_get_gates_agents_logged_into

Get a listing of all agents that have access to a queue in RingCentral Voice, including data indicating whether each agent is currently logged into the queue. Returns: errorCode, generalMessage, timestamp. Required: account_id, gate_id.

public_integration_api_get_recording_segment_data

Get recording data for a specific interaction segment in RingCentral Voice. Returns: subscriptionId, mainAccountId, subAccountId, subscriptionName, description, notificationUrl, authConfigId, active, maxRetryCount, customHeaders, expiresAt, createdBy, createdAt, updatedBy, updatedAt, errorCode, generalMessage, timestamp. Required: rc_account_id, sub_account_id, segment_id.

public_integration_api_get_interaction_metadata

Get interaction segment metadata for a RingCentral Voice sub-account. Returns: subscriptionId, mainAccountId, subAccountId, subscriptionName, description, notificationUrl, authConfigId, active, maxRetryCount, customHeaders, expiresAt, createdBy, createdAt, updatedBy, updatedAt, errorCode, generalMessage, timestamp. Required: rc_account_id, sub_account_id.

public_integration_api_get_interaction_metadata_v_2

Get interaction metadata with current field names and voice call results for a RingCentral Voice sub-account. Returns: subscriptionId, mainAccountId, subAccountId, subscriptionName, description, notificationUrl, authConfigId, active, maxRetryCount, customHeaders, expiresAt, createdBy, createdAt, updatedBy, updatedAt, errorCode, generalMessage, timestamp. Required: rc_account_id, sub_account_id.

public_integration_api_get_transcript_segment_data

Get transcript data for both voice and digital interaction segments in RingCentral Voice. Returns: subscriptionId, mainAccountId, subAccountId, subscriptionName, description, notificationUrl, authConfigId, active, maxRetryCount, customHeaders, expiresAt, createdBy, createdAt, updatedBy, updatedAt, errorCode, generalMessage, timestamp. Required: rc_account_id, sub_account_id, segment_id.

ring_central_voice_public_integration_api_get_queue_groups

List queue groups for a RingCentral Voice sub-account. Returns: subscriptionId, mainAccountId, subAccountId, subscriptionName, description, notificationUrl, authConfigId, active, maxRetryCount, customHeaders, expiresAt, createdBy, createdAt, updatedBy, updatedAt, errorCode, generalMessage, timestamp. Required: rc_account_id, sub_account_id.

ring_central_voice_public_integration_api_get_queues_with_agents

Get queues with their associated agents for a queue group in RingCentral Voice. Returns a list of agent IDs associated with the queues in the queue group. Required: rc_account_id, sub_account_id, queue_group_id.

ring_central_voice_public_integration_api_build_queue_stats

Build aggregated queue statistics for a RingCentral Voice sub-account. Returns aggregated queue statistics data whose field structure depends on the report criteria. Required: rc_account_id, sub_account_id.

public_integration_api_build_extended_agent_stats

Build extended aggregated agent statistics for a RingCentral Voice sub-account. Returns extended agent statistics data whose field structure depends on the report criteria. Required: rc_account_id, sub_account_id.

ring_central_voice_public_integration_api_build_agent_stats

Build aggregated agent statistics for a RingCentral Voice sub-account. Returns aggregated agent statistics data whose field structure depends on the report criteria. Required: rc_account_id, sub_account_id.

list_all_ring_central_voice_agent_state_subscriptions

List RingCX agent state subscriptions for a sub-account. Returns: subscriptionId, mainAccountId, subAccountId, subscriptionName, description, notificationUrl, authConfigId, active, maxRetryCount, customHeaders, expiresAt, createdBy, createdAt, updatedBy, updatedAt, errorCode, generalMessage, timestamp. Required: rc_account_id, sub_account_id.

create_a_ring_central_voice_agent_state_subscription

Create a RingCX agent state subscription to receive agent-state notifications at a receiver endpoint. Returns: subscriptionId, mainAccountId, subAccountId, subscriptionName, description, notificationUrl, authConfigId, active, maxRetryCount, customHeaders, expiresAt, createdBy, createdAt, updatedBy, updatedAt, errorCode, generalMessage, timestamp. Required: rc_account_id, sub_account_id,…

update_a_ring_central_voice_agent_state_subscription_by_id

Update an existing RingCX agent state subscription by id. Returns: subscriptionId, mainAccountId, subAccountId, subscriptionName, description, notificationUrl, authConfigId, active, maxRetryCount, customHeaders, expiresAt, createdBy, createdAt, updatedBy, updatedAt, errorCode, generalMessage, timestamp. Required: rc_account_id, sub_account_id, id, subscriptionName, notificationUrl.

delete_a_ring_central_voice_agent_state_subscription_by_id

Delete a RingCX agent state subscription by id. Returns: subscriptionId, mainAccountId, subAccountId, subscriptionName, description, notificationUrl, authConfigId, active, maxRetryCount, customHeaders, expiresAt, createdBy, createdAt, updatedBy, updatedAt, errorCode, generalMessage, timestamp. Required: rc_account_id, sub_account_id, id.

list_all_ring_central_voice_remote_http_service_groups

List remote HTTP service groups for a RingCX account. Returns: serviceGroupId, groupName, isDefault, permissions. Required: account_id.

create_a_ring_central_voice_remote_http_service_group

Create a new remote HTTP service group in RingCX. Returns: serviceGroupId, groupName, isDefault, permissions. Required: account_id, groupName.

ring_central_voice_remote_http_service_groups_list_with_children

List remote HTTP service groups with their child services for a RingCX account. Returns: serviceGroupId, groupName, isDefault, permissions, services. Required: account_id.

get_single_ring_central_voice_remote_http_service_group_by_id

Get a single remote HTTP service group by id in RingCX. Returns: serviceGroupId, groupName, isDefault, permissions. Required: account_id, id.

update_a_ring_central_voice_remote_http_service_group_by_id

Update an existing remote HTTP service group in RingCX. Returns: serviceGroupId, groupName, isDefault, permissions. Required: account_id, id.

list_all_ring_central_voice_remote_http_services

List remote HTTP services in a RingCentral Voice service group. Returns: accountId, enableMappings, httpPassword, httpServiceConfig, httpServiceGroup, httpUsername, isDebug, isEnabled, permissions, returntype, sendAllSurveyData, serviceDescription, serviceId, serviceGroupId, serviceType, soapAction, soapEndpoint, soapOperationname, soapPortname, soapServicename, targetNamespace. Required:…

create_a_ring_central_voice_remote_http_service

Create a new remote HTTP service in a RingCentral Voice service group. Returns the created service with serviceId, serviceType, serviceDescription, isEnabled, and configuration fields. Required: account_id, service_group_id.

get_single_ring_central_voice_remote_http_service_by_id

Get a single remote HTTP service by id in a RingCentral Voice service group. Returns: accountId, enableMappings, httpPassword, httpServiceConfig, httpServiceGroup, httpUsername, isDebug, isEnabled, permissions, returntype, sendAllSurveyData, serviceDescription, serviceId, serviceGroupId, serviceType, soapAction, soapEndpoint, soapOperationname, soapPortname, soapServicename, targetNamespace.…

update_a_ring_central_voice_remote_http_service_by_id

Update a remote HTTP service by id in a RingCentral Voice service group. Returns the updated service with serviceId, serviceType, serviceDescription, isEnabled, and configuration fields. Required: account_id, service_group_id, id.

ring_central_voice_remote_http_services_clone

Clone an existing remote HTTP service in a RingCentral Voice service group. Returns the cloned service with serviceId, serviceType, serviceDescription, isEnabled, and configuration fields. Required: account_id, service_group_id, service_id.

ring_central_voice_remote_http_services_set_active

Set the active state of a remote HTTP service in RingCentral RingCX. Returns an empty 204 response on success. Required: account_id, service_group_id, service_id.

delete_a_ring_central_voice_remote_http_service_by_id

Delete a remote HTTP service from RingCentral RingCX. Returns an empty 204 response on success. Required: account_id, service_group_id, id.

create_a_ring_central_voice_remote_http_service_input

Create a new remote HTTP service input for a specific HTTP service in RingCX. Returns the created input object including its inputId. Required: account_id, service_group_id, service_id.

get_single_ring_central_voice_remote_http_service_input_by_id

Get a specific remote HTTP service input in RingCX by its id. Returns: id, accountId. Required: account_id, service_group_id, service_id, id.

delete_a_ring_central_voice_remote_http_service_input_by_id

Delete a remote HTTP service input in RingCentral Engage Voice. Returns an empty 204 response on success. Required: account_id, service_group_id, service_id, id.

list_all_ring_central_voice_external_auth_configs

List external auth configurations for a RingCX sub-account in ringcentralvoice. Returns: id, attributes. Required: rc_account_id, sub_account_id.

ring_central_voice_external_auth_configs_get_oauth_info

Get OAuth metadata for a specific external auth configuration in ringcentralvoice. Returns the OAuth configuration metadata for the specified auth config. Required: rc_account_id, sub_account_id, config_id.

get_single_ring_central_voice_external_auth_config_by_id

Get a specific external auth configuration in ringcentralvoice by its resource id. Returns: id, attributes. Required: rc_account_id, sub_account_id, id.

delete_a_ring_central_voice_external_auth_config_by_id

Delete an external auth configuration in RingCentral Voice by id. Returns an empty 204 response on success. Required: rc_account_id, sub_account_id, id.

ring_central_voice_external_auth_configs_create_api_key

Create an API key external auth configuration for a RingCentral Voice sub-account. Returns the created external auth configuration. Required: rc_account_id, sub_account_id.

ring_central_voice_external_auth_configs_create_basic

Create a basic external auth configuration in RingCentral Voice. Returns: id, createdAt, updatedAt. Required: rc_account_id, sub_account_id.

ring_central_voice_external_auth_configs_update_basic

Update a basic external auth configuration in RingCentral Voice. Returns: id, createdAt, updatedAt. Required: rc_account_id, sub_account_id, config_id.

ring_central_voice_external_auth_configs_create_custom

Create a custom external auth configuration in RingCentral Voice. Returns: id, createdAt, updatedAt. Required: rc_account_id, sub_account_id.

ring_central_voice_external_auth_configs_update_custom

Update a custom external auth configuration in RingCentral Voice. Returns: id, createdAt, updatedAt. Required: rc_account_id, sub_account_id, config_id.

ring_central_voice_external_auth_configs_create_jwt

Create a JWT external auth configuration in ringcentralvoice for a sub-account. Returns: id, createdAt, updatedAt. Required: rc_account_id, sub_account_id.

ring_central_voice_external_auth_configs_update_jwt

Update a JWT external auth configuration in ringcentralvoice. Returns: id, createdAt, updatedAt. Required: rc_account_id, sub_account_id, config_id.

ring_central_voice_external_auth_configs_create_oauth

Create an OAuth external auth configuration in ringcentralvoice for a sub-account. Returns: id, createdAt, updatedAt. Required: rc_account_id, sub_account_id.

ring_central_voice_external_auth_configs_update_oauth

Update an OAuth external auth configuration in ringcentralvoice. Returns: id, createdAt, updatedAt. Required: rc_account_id, sub_account_id, config_id.

ring_central_voice_external_auth_configs_bulk_update

Update an API key external auth configuration in RingCentral Voice. Returns: id, createdAt, updatedAt. Required: rc_account_id, sub_account_id, config_id.