Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RingCentral External Contacts API

The External Contacts API from RingCentral — 6 operation(s) for external contacts.

RingCentral External Contacts API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include External Contacts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 11 operations across 6 paths, and defines 22 schemas. It is described by OpenAPI 3.0.3, at version 1.0.58-20240529-47eda8bd.

Requests are made against 4 base URLs: https://platform.ringcentral.com, https://media.ringcentral.com, https://platform.devtest.ringcentral.com, https://platform.devtest.ringcentral.com.

11 operations 6 paths 22 schemas 1 DELETE5 GET1 PATCH2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.58-20240529-47eda8bd
Servers
https://platform.ringcentral.com
https://media.ringcentral.com
https://platform.devtest.ringcentral.com
https://platform.devtest.ringcentral.com
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

RingCentral External Contacts API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow. By default, every request must be authenticated.

Paths & Operations 11

Across 6 paths, the API surfaces 11 operations — 1 DELETE, 5 GET, 1 PATCH, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

External Contacts 11
POST
/restapi/v1.0/account/{accountId}/address-book-bulk-upload
Upload Multiple User Contacts
addressBookBulkUpload 1 param body → 202
GET
/restapi/v1.0/account/{accountId}/address-book-bulk-upload/tasks/{taskId}
Get Contacts Upload Task
getAddressBookBulkUploadTask 2 params → 200
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/favorite
List Favorite Contacts
listFavoriteContacts 2 params → 200
PUT
/restapi/v1.0/account/{accountId}/extension/{extensionId}/favorite
Update Favorite Contact List
updateFavoriteContactList 2 params body → 200
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact
List Contacts
listContacts 7 params → 200
POST
/restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact
Create User Contact
createContact 3 params body → 200400
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}
Get User Contact(s)
readContact 3 params → 200
PUT
/restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}
Update User Contact(s)
updateContact 4 params body → 200
PATCH
/restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}
Update Contact Attributes
patchContact 4 params body → 200
DELETE
/restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}
Delete User Contact(s)
deleteContact 3 params → 204
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book-sync
Address Book Synchronization
syncAddressBook 6 params → 200

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are PersonalContactResource (31 properties), PersonalContactRequest (28 properties), AddressBookBulkContactResource (27 properties), UserContactsPagingInfo (6 properties). Each schema is shown below with its type and property counts.

AddressBookBulkContactResource
object
27 properties
FavoriteCollection
object
1 property
ExtensionFavoritesEventBody
object
Notification payload body
2 properties
PersonalContactResource
object
31 properties
AddressBookSync
object
5 properties
UserContactsNavigationInfoUri
object
Canonical URI for a corresponding page of a list
1 property
FavoriteContactList
object
2 properties
PersonalContactRequest
object
28 properties
ContactList
object
5 properties
AddressBookBulkUploadResource
object
2 properties 2 required
ContactAddressInfo
object
5 properties
AddressBookBulkUploadTaskResult
object
2 properties
AddressBookBulkUploadResponse
object
Information on a task for adding multiple contacts to multiple extensions
6 properties 5 required
ExtensionFavoritesEvent
object
5 properties
UserContactsGroupsInfo
object
Information on address book groups
1 property
FavoriteContactResource
object
4 properties
AddressBookBulkContactAddressInfo
object
5 properties
SyncInfo
object
4 properties
UserContactsPagingInfo
object
Information on paging
6 properties
UserContactsNavigationInfo
object
Information on navigation
4 properties
AddressBookBulkUploadRequest
object
1 property 1 required
ErrorEntity
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-external-contacts-api-openapi.yml Raw ↑

Other APIs RingCentral publishes across the network.

RingCentral SMS API
RingCentral Team Messaging API
RingCentral Video API
RingCentral Fax API
RingCentral Data API
RingCentral Audio and Video AI API
RingCentral Call Log API
RingCentral Call Analytics API
RingCentral Presence API
RingCentral Voicemail API
RingCentral Provisioning API
RingCentral Webhooks and Subscriptions API