Articles in this section

Available RingCentral APIs

When you configure an export, import, or other type of flow step using the prebuilt RingCentral connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Klarna API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Active calls

Creates a manual agent call

X

Returns a listing of current active calls for a given product or external ID, on an account

X

Check queue status

X

Check queue threshold

X

Provides support for adding sessions to an active call

X

Sets the call disposition for either inbound or outbound calls and releases the agent from the PD state

X

Terminates an active call

X

Terminates an active session

X

Provides support for toggling call recording on/off for an active call

X

Adaptive cards

Create adaptive card

X

Get adaptive card

X

Update adaptive card

X

Delete adaptive card

X

Agent access

Returns the count of agents in an agent group logged into a queue

X

Returns a listing of all agents that have access to the queue (aka gate) - this includes data to indicate if an agent is currently logged into the queue

X

Agent groups

Returns a listing of agent groups for an account

X

Creates a single new agent group for an account

X

Deletes an agent group for an account

X

Returns a listing of agent groups for an account

X

Updates an agent group for an account

X

Agent status

Get all connected agents status

X

Get a connected agent status

X

Changing an agent's status

X

Agents

Returns a listing of agents for an agent group

X

Creates a single agent for an agent group

X

Updates a listing of agents for an agent group

X

Deletes an agent for an agent group

X

Returns a single agent for an agent group

X

Updates a single agent for an agent group

X

Assigns a listing of agents to a queue (aka gate)

X

Returns a listing of assigned agents for a queue (aka gate)

X

Unassigns a single agent from a queue (aka gate)

X

API Info

Get API versions

X

Get version info

X

Attachments

Getting all attachments

X

Creating an attachment

X

Getting an attachment from its ID

X

Audio

List enrolled speakers

X

Create speaker enrollment

X

Get speaker enrollment status

X

Delete speaker enrollment

X

Update speaker enrollment

X

Speech to text conversion

X

Speaker diarization

X

Speaker identification

X

Audio streaming

Update streaming profile

X

Create streaming profile

X

Get streaming profile

X

Delete streaming profile

X

Audit trail

Search audit trail data

X

Automatic location updates

List emergency locations

X

Add emergency location

X

Get emergency location

X

Update emergency location

X

Delete emergency location

X

List user emergency locations

X

Create user emergency location

X

Update user emergency location

X

Delete user emergency location

X

Get user emergency location

X

Get emergency map configuration task

X

List users

X

Enable automatic location updates for users

X

Create multiple wireless points

X

Get network map

X

Create network

X

Get network

X

Update network

X

Delete network

X

Validate multiple switches

X

List account switches

X

Create switch

X

Get switch

X

Update switch

X

Delete switch

X

Validate multiple wireless points

X

List wireless points

X

Create wireless point

X

Get wireless point

X

Update wireless point

X

Delete wireless point

X

List devices

X

Enable automatic location updates feature

X

Create multiple switches

X

Update multiple wireless points

X

Update multiple switches

X

Bots

Bot engage

X

Bot complete

X

Bot handover

X

Bridge management

Create bridge

X

Get user's default bridge

X

Search bridge by PSTN pin

X

Search bridge by web pin

X

Get bridge

X

Update bridge

X

Delete bridge

X

Business hours

Get company business hours

X

Update company business hours

X

Get user business hours

X

Update user business hours

X

Calendar events

List user events

X

Create event

X

Get event

X

Update event

X

Delete event

X

List group events

X

Create event by group ID

X

Call blocking

Get caller-blocking settings

X

Update caller blocking settings

X

List blocked/allowed phone numbers

X

Add blocked/allowed number

X

Get blocked/allowed number

X

Update blocked/allowed number

X

Delete blocked/allowed number

X

Call control

Make callout

X

Start conference call session

X

Get call session status

X

Drop call session

X

Bring-in call party

X

Get call party status

X

Delete call party

X

Update call party

X

Unhold call party

X

Call park

X

Call flip on party

X

Reply with text

X

Bridge call party

X

Ignore call in queue

X

Supervise call party

X

Reject call party

X

Create recording

X

Pause/resume recording

X

Answer call party

X

Transfer call party

X

Hold call party

X

Pickup call

X

Forward call party

X

Supervise call session

X

Call forwarding

List forwarding numbers

X

Create forwarding number

X

Delete forwarding numbers

X

Get forwarding number

X

Update forwarding number

X

Delete forwarding number

X

Call handling rules

List company call handling rules

X

Create company call handling rule

X

Get company call handling rule

X

Update company call handling rule

X

Delete company call handling rule

X

Get forward all company calls

X

Update forward all company calls

X

List call handling rules

X

Create call handling rule

X

Get call handling rule

X

Update call handling rule

X

Delete call handling rule

X

Call log

List company call records

X

Get company call record(s)

X

Sync company call log

X

List company active calls

X

List user call records

X

Delete user call records

X

Get user call record(s)

X

Sync user call log

X

List user active calls

X

Call monitoring groups

List call monitoring groups

X

Create call monitoring group

X

Update call monitoring group

X

Delete call monitoring group

X

Update call monitoring group list

X

List call monitoring group members

X

Call queues

List call queues

X

Get call queue

X

Update call queue

X

Assign multiple call queue members

X

List call queue members

X

Get the department member list

X

Assign multiple department members

X

Update user call queues

X

Get call queue overflow settings

X

Update call queue overflow settings

X

Call recording settings

Get call recording settings

X

Update call recording settings

X

Get call recording custom greeting list

X

Delete call recording custom greeting list

X

Delete call recording custom greeting

X

Update call recording extension list

X

Get call recording extension list

X

Call recordings

Get call recording content

X

Get call recording

X

Campaigns

Performs a lead action against the matching campaign leads found for the given the search criteria

X

Allows searching of campaign leads for a single campaign

X

Returns a listing of campaigns for a dial group

X

Returns a campaign for a dial group

X

Deletes a campaign for a dial group

X

Returns a campaign for a dial group

X

Updates a campaign for a dial group

X

Clears the cache for a campaign

X

Categories

Getting all categories

X

Creating a category

X

Deleting a category

X

Getting a category from its ID

X

Updating a category

X

Channels

Getting all channels

X

Getting a channel from its ID

X

Updating a channel

X

Chats

List recent chats

X

List chats

X

Get chat

X

Remove chat from favorites

X

Add chat to favorites

X

List favorite chats

X

Communities

Getting all communities

X

Getting a community from its ID

X

Company

Get account info

X

Send/resend welcome email

X

Send/resend activation email

X

Get account info

X

Get account service info

X

Get account business address

X

Update company business address

X

List contracted countries

X

List domestic countries

X

Compliance exports

List data export tasks

X

Create data export task

X

Get data export task

X

Contents

Contents

X

Creating content

X

Getting content from its ID

X

Ignoring a content

X

Categorizing a content

X

Conversations

List conversations

X

Create/open conversation

X

Get conversation

X

Countries

Returns a listing of all country codes available on the system

X

Custom field

Get custom field list

X

Create custom field

X

Update custom field

X

Delete custom field

X

Custom fields

Getting all custom fields

X

Creating a custom field

X

Deleting a custom field

X

Getting a custom field from its ID

X

Updating a custom field

X

Delegation Management

Get delegators

X

Device SIP Registration

Register device

X

Devices

Add phone to inventory

X

Delete device from inventory

X

Add BYOD devices

X

Swap devices

X

Get device

X

Update device

X

Get device SIP info

X

Update device emergency info

X

List extension devices

X

Dial groups

Returns a listing of dial groups for an account

X

Creates a dial group for an account

X

Returns a listing of dial groups with associated campaigns for an account

X

Deletes a dial group for an account

X

Returns a dial group for an account

X

Updates a dial group for an account

X

Assign a listing of agents to a dial group

X

Returns a listing of all agents assigned to a dial group

X

Events

Getting all events

X

Getting an event from its ID

X

Extensions

Update multiple extensions

X

Get extension update task status

X

List user templates

X

Get user template

X

List extensions

X

Create extension

X

External contacts

Upload multiple user contacts

X

Get contacts upload task

X

List favorite contacts

X

Update favorite contact list

X

List contacts

X

Create user contact

X

Get user contact(s)

X

Update user contact(s)

X

Update contact attributes

X

Delete user contact(s)

X

Address book synchronization

X

Fax

Create fax message

X

List fax cover pages

X

Features

Get user features

X

Folders

Getting all folders

X

Creating a folder

X

Deleting a folder

X

Getting a folder from its ID

X

Updating a folder

X

Greetings

Get account greeting media content

X

Get extension greeting media content

X

Create company greeting

X

Create custom user greeting

X

Get custom greeting

X

List standard greetings

X

Get standard greeting

X

High volume SMS

List A2P SMS statuses

X

List A2P SMS messages

X

Get A2P SMS

X

Get opted-out numbers

X

Add opt-in/out numbers

X

Send a2p smsA2P SMS

X

List a2p sms batches

X

Get A2P SMS batch

X

Historical recordings

List webinar recordings (admin)

X

Get webinar recording (admin)

X

List webinar recordings

X

Get webinar recording

X

Get webinar recording download resource

X

Historical webinars

Get historical webinar

X

Get historical webinar session

X

List session participants

X

Get participant information

X

List session invitees

X

Get session invitee

X

List historical webinar sessions across multiple webinars/hosts

X

List historical webinar sessions across multiple webinars

X

Identities

Getting all identities

X

Getting an identity from its ID

X

Importing an identity

X

Identity groups

Getting all identity groups

X

Getting an identity group from its ID

X

Updating an identity group

X

Merging an identity into an identity group

X

Incoming webhooks

List webhooks

X

Get webhook

X

Delete webhook

X

Activate webhook

X

Suspend webhook

X

List webhooks in group

X

Create webhook in group

X

Insights

Interaction analytics

X

Integration account controller

Returns a listing of sub accounts by engage voice main account identifier

X

Returns a list of read-only agents for an agent group

X

Integration Agent Group Controller

Returns a list of agent groups for a sub-account

X

Integration gate group controller

Returns a list of inbound queue groups

X

Returns a list of queues with agent IDs

X

Integration report controller

Builds queue extended statistics report in requested format

X

Builds agent segment metadata report in requested format

X

Builds agent statistics report in requested format

X

Builds inbound/outbound queue statistics in requested format

X

Integration user controller

Returns a listing of all users that a user has access to

X

Internal contacts

Get company directory entries

X

Get corporate directory entry

X

Search company directory entries

X

Get account federation

X

Intervention comments

Getting all intervention comments

X

Creating an intervention comment

X

Deleting an intervention comment

X

Getting an intervention comment from its ID

X

Interventions

Getting all interventions

X

Creating an intervention

X

Getting an intervention from its ID

X

Updating an intervention from its ID

X

Cancelling an intervention

X

Closing an intervention

X

Reassigning an intervention

X

Categorizing an intervention

X

Invitees

Bulk add/delete session invitees

X

List session invitees

X

Get session invitee

X

Update session invitee

X

Delete session invitee

X

IVR

Get IVR prompt content

X

List IVR prompts

X

Create IVR prompts

X

Get IVR prompt

X

Update IVR prompt

X

Delete IVR prompt

X

Get IVR menu list

X

Create IVR menu

X

Get IVR menu

X

Update IVR menu

X

Leads

Allows searching of campaign leads for a single campaign

X

Returns a listing of all lead states for an account

X

Returns a listing of all system dispositions for an account

X

Allows updating of a campaign lead, only updating those fields passed in

X

Allows updating of a campaign lead, updating entire lead including fields not passed in

X

Uploads a single lead or list of leads to a new or existing list

X

Legacy auth

Retrieves all API tokens for authenticated user

X

Creates a new 'API token' based authenticated user that does not expire

X

Removes an API token

X

Application login to authenticate and receive an x-auth-token

X

Licenses

Assign account licenses

X

Line of business analytics

Calls aggregation data

X

Calls timeline data

X

Locales

Getting all user interface locales

X

Getting all content locales

X

Meeting recordings

List account recordings

X

List user recordings

X

Meetings history

List video meetings

X

Get video meeting

X

Message exports

Create message store report

X

Get message store report task

X

Get message store report archive

X

Message store

Get message attachment content

X

Get message store configuration

X

Update message store configuration

X

Sync messages

X

List messages

X

Delete conversation

X

Get message(s)

X

Update message(s)

X

Patch message(s)

X

Delete message

X

Multi site

List sites

X

Create site

X

Get site

X

Update site

X

Delete site

X

Edit sites

X

List site members

X

Get site IVR settings

X

Update site IVR settings

X

Notes

List notes

X

Create note

X

Get note

X

Delete note

X

Update note

X

Lock note

X

Publish note

X

Unlock note

X

Number management

Update DNIS records in bulk

X

Returns all DNIS pools for customer

X

Updates for bulk CSV data DNIS pool, will update assignments too

X

Creates a list of DNIS pools from upload file

X

OAuth/OIDC

Get OAuth token

X

OAuth 2.0 authorization

X

OAuth 2.0 authorization (post)

X

Revoke token

X

Outbound

Upload new leads to a new or existing list

X

Upload new leads to a new or existing list

X

Pager messages

Create internal text message

X

Paging only groups

Get paging group users

X

Assign paging group users and devices

X

Get paging group devices

X

Phone numbers

List account phone numbers

X

Delete numbers from inventory

X

Assign phone number

X

Replace phone number

X

Add numbers to inventory

X

Get add numbers task results

X

Get extension phone number list

X

List company phone numbers

X

Get phone number

X

Parse phone number(s)

X

Posts

Upload file

X

List posts

X

Create post

X

Get post

X

Delete post

X

Update post

X

Presence

Get call queue presence

X

Update call queue presence

X

Get user presence status list

X

Get agent’s call queue presence

X

Update call queue presence

X

Get user presence status

X

Update user presence status

X

Get unified presence

X

Update unified presence

X

Presence status

Getting all presence statuses

X

Creating a presence status

X

Deleting a presence status

X

Getting a presence status from its ID

X

Updating a presence status

X

Profile

Get company info

X

Get person

X

Queue dispositions

Returns a listing of dispositions for a queue (aka gate)

X

Creates a disposition for a queue (aka gate)

X

Saves a list of dispositions for a queue (aka gate)

X

Deletes a disposition for a queue (aka gate)

X

Returns a single disposition for a queue (aka gate)

X

Updates a single disposition for a queue (aka gate)

X

Queue events

Returns a listing of gate queue events for a queue

X

Creategatequeueevent

X

Saves a list of gate queue events for a queue

X

Deletes a gate queue event for a queue

X

Returns a single gate queue event for a queue

X

Updates a single gate queue event for a queue

X

Returns a listing of gate queue DTMP events for a queue

X

Creates a new gate queue DTMP event

X

Updates a listing of gate queue DTMP events

X

Deletes a gate queue DTMP event

X

Returns a single gate queue DTMP event

X

Updates a single gate queue DTMP event

X

Queue groups

Returns a listing of queue groups (aka gate groups) for an account

X

Create a single queue group (aka gate group) for an account

X

Returns a listing of queue groups (aka gate groups) with related data for an account

X

Returns a listing of queue groups (aka gate groups) with related and additional data for an account

X

Deletes a single queue group (aka gate group)

X

Returns a single queue group (aka gate group) for an account

X

Updates a single queue group (aka gate group) for an account

X

Queue phone book

Returns all phone book entries for a queue (aka gate)

X

Creates a phone book entry for a queue (aka gate)

X

Updates a listing of phone book entries for a queue (aka gate)

X

Deletes a single phone book entry for a queue (aka gate)

X

Updates a phone book entry for a queue (aka gate)

X

Queue schedule

Returns a listing of schedule overrides for a queue (aka gate)

X

Creates a schedule override for a queue (aka gate)

X

Saves a listing of schedule overrides for a queue (aka gate)

X

Deletes a schedule override for a queue (aka gate)

X

Updates a schedule override for a queue (aka gate)

X

Queue skills

Returns a listing of skills for a queue group (aka gate group)

X

Creates a skill for a queue group (aka gate group)

X

Updates an existing list of skills for a queue group (aka gate group)

X

Deletes a skill for a queue group (aka gate group)

X

Returns a skill for a queue group (aka gate group)

X

Updates a skill for a queue group (aka gate group)

X

Queue special ANI

Deletes a special ANI for a queue (aka gate)

X

Returns a listing of special ANIs for a queue (aka gate)

X

Creates a special ANI for a queue (aka gate)

X

Uploads a special ANI for a queue (aka gate)

X

Queues

Returns a listing of all queues (aka gates) for a queue group

X

Creates a new queue (aka gate) for a queue group

X

Deletes a queue (aka gate) for a queue group

X

Returns a single queue (aka gate) for a queue group

X

Updates a queue (aka gate) for a queue group

X

Assigns a queue (aka gate) to a queue priority group for an account

X

Creates a clone of a queue (aka gate) for a queue group

X

Move an existing queue (aka gate) to a new existing queue group

X

Set queue (aka gate) active state

X

RCM meetings (legacy)

Get locked meeting settings

X

Get account-level meeting info

X

List account meeting recordings

X

Upload user meeting profile image

X

List scheduled meetings

X

Create meeting

X

Get meeting user settings

X

Get meeting info

X

Update meeting

X

Delete meeting

X

Update meeting

X

End meeting

X

Get meeting invitation

X

Get meeting service info

X

Update meeting service info

X

Get assisted users

X

Get assistants

X

List user meeting recordings

X

Regional settings

List states

X

Get state

X

List locations

X

List languages

X

Get language

X

List timezones

X

Get timezone

X

List countries

X

Get country

X

Registrants

List session registrants

X

Create registrant

X

Get registrant

X

Delete registrant

X

Registration management

Get registration session info

X

Update registration session

X

Reply assistant entries

Getting all reply assistant entries

X

Creating an entry

X

Deleting a reply assistant entry

X

Getting a reply assistant entry from its ID

X

Updating a reply assistant entry

X

Reply assistant groups

Getting all reply assistant groups

X

Creating a reply assistant group

X

Deleting a reply assistant group

X

Getting a reply assistant group from its ID

X

Updating a reply assistant group

X

Reply assistant versions

Getting all reply assistant versions

X

Creating a reply assistant version

X

Deleting a reply assistant version

X

Getting a reply assistant version from its ID

X

Updating a reply assistant version

X

Reporting

Builds a report in different formats: XLS/XLSX/CSV/etc

X

Returns a report criteria definition for a report type

X

Requeue shortcuts

Returns a listing of requeue shortcuts for a queue (aka gate)

X

Updates a queue shortcut for a queue (aka gate)

X

Creates a list of requeue shortcuts for a queue (aka gate)

X

Returns a listing of requeue shortcuts for a queue (aka gate)

X

Returns a requeue shortcut for a queue (aka gate)

X

Updates a requeue shortcut for a queue (aka gate)

X

RingCentral auth

Logs in an RC user via their access token issued by the RC API server returns engage access token and user details

X

Ring-out

Make ring-out call

X

Get ring-out call status

X

Cancel ring-out call

X

Role management

List company-assigned roles

X

List company user roles

X

Create custom role

X

Get default user role

X

Set default user role

X

Get user role

X

Update user role

X

Delete custom role

X

Assign multiple user roles

X

List user-assigned roles

X

Update user-assigned roles

X

Assign default role

X

List standard user roles

X

Get standard user role

X

Roles

Getting all roles

X

Creating a role

X

Getting a role from its ID

X

Updating a role

X

SCIM

List schemas

X

Get schema

X

Search/list users

X

Create user

X

Search/list users

X

Get user

X

Update/replace user

X

Delete user

X

Update/patch user

X

Get provider config

X

List resource types

X

Get resource type

X

Settings

Getting all settings

X

Updating settings

X

Site administration

List user-administered sites

X

Update user-administered sites

X

SMS

Send SMS

X

Send MMS

X

Sources

Getting all sources

X

Getting a source from its ID

X

Updating a source

X

Updating source credentials

X

Status

Get async task status

X

Subscriptions

List subscriptions

X

Create subscription

X

Get subscription

X

Update subscription

X

Cancel subscription

X

Renew subscription

X

Survey responses

Get a survey response

X

Surveys

Getting all surveys

X

Getting a survey from its ID

X

Tags

Getting all tags

X

Creating a tag

X

Deleting a tag

X

Getting a tag from its ID

X

Updating a tag

X

Tasks

Get task

X

Delete task

X

Update task

X

Complete task

X

List chat tasks

X

Create task

X

Getting all tasks

X

Getting a task from its ID

X

Move a task to another queue

X

Complete a task

X

Transferring a task

X

Teams

Get everyone chat

X

Update everyone chat

X

List teams

X

Create team

X

Get team

X

Delete team

X

Update team

X

Remove team members

X

Join team

X

Archive team

X

Unarchive team

X

Leave team

X

Add team members

X

Getting all teams

X

Creating a team

X

Deleting a team

X

Getting a team from its ID

X

Updating a team

X

Text

Conversational summarization

X

Smart punctuation

X

Threads

Getting all threads

X

Getting a thread from its ID

X

Close a thread

X

Archiving a thread

X

Open a thread

X

Categorizing a thread

X

Timesheets

Getting all timesheets

X

Creating a timesheet

X

Deleting a timesheet

X

Getting a timesheet from its ID

X

Updating a timesheet

X

Timezones

Getting all timezones

X

Topologies

Activating a topology

X

Updating a topology

X

Deleting a topology

X

Getting a topology from its ID

X

Creating a topology

X

Getting all topologies

X

User capacities

Getting all user capacities

X

Creating a user capacity

X

Deleting a user capacity

X

Getting a user capacity from its ID

X

Updating a user capacity

X

User permissions

Get authorization profile

X

Check user permission

X

List permissions

X

Get permission

X

List permission categories

X

Get permission category

X

User settings

Get scaled profile image

X

Create multiple user extensions

X

Delete user extensions

X

Get extension

X

Update extension

X

Delete extension

X

List extension grants

X

Get user conferencing settings

X

Update user conferencing settings

X

Get user profile image

X

Update user profile image

X

Upload user profile image

X

Delete user profile image

X

Get extension caller ID

X

Update extension caller ID

X

Get notification settings

X

Update notification settings

X

User signatures

Getting all user's signatures

X

Creating a user's signature

X

Deleting a user's signature

X

Getting a user's signature from its ID

X

Updating a user's signature

X

Users

Getting all users

X

Creating a user

X

Inviting a user

X

Deleting a user

X

Getting a user from its ID

X

Updating a user

X

Returns a listing of all users that a user has access to

X

Creates a single new user

X

Video configuration

Get user video configuration

X

Webhooks

Getting all webhooks

X

Creating a webhook

X

Deleting a webhook

X

Getting a webhook from its ID

X

Updating a webhook

X

Webinar subscriptions

List webinar subscriptions

X

Create webinar subscription

X

Get webinar subscription

X

Update webinar subscription

X

Cancel webinar subscription

X

Renew webinar subscription

X

Webinars and sessions

Create webinar

X

List user's webinars

X

Get webinar

X

Update webinar

X

Delete webinar

X

Create webinar session

X

Update webinar session

X

Get webinar session

X

Delete webinar session

X

List sessions across multiple webinars/hosts

X

List sessions across multiple webinars

X

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.