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 Identities API

The Identities API from RingCentral — 2 operation(s) for identities.

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

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

This API exposes 2 operations across 2 paths, and defines 41 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.

2 operations 2 paths 41 schemas 2 GET

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 Identities 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 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Identities 2
GET
/cx/social-messaging/v1/identities
List All Identities
socMsgListIdentities 7 params → 200400
GET
/cx/social-messaging/v1/identities/{identityId}
Get Identity
socMsgGetIdentity 1 param → 200404

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are IdentityModel (36 properties), NonEnumeratedPagingModel (5 properties), IdentitiesList (2 properties), ApiError (2 properties). Each schema is shown below with its type and property counts.

IdentityUUID
string
UUID of the identity.
SocMsgLastName
string
LastName.
SocMsgGender
string
Gender.
IdentityMcc
string
Viber mobile country code of the identity. Applicable to Viber channels only.
IdentityPrimaryDeviceOs
string
Viber primary device OS of the identity. Applicable to Viber channels only.
IdentityViberVersion
string
Viber application version of the identity. Applicable to Viber channels only.
IdentityTwLocation
string
Twitter location of the identity. Applicable to Twitter channels only.
SocMsgEmailAddress
string
Email address.
IdentityDeviceType
string
Viber device type of the identity. Applicable to Viber channels only.
ApiError
object
Generalized API error structure suitable for any error type
2 properties 2 required
IdentityLanguage
string
Viber language of the identity. Applicable to Viber channels only.
IdentityTwFollowingCount
integer
Count of Twitter accounts followed by the identity. Applicable to Twitter channels only.
IdentityType
string
Type of the identity.
SocMsgPhoneNumber
string
Phone number.
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property 1 required
IdentityFbBio
string
Facebook biography of the identity. Applicable to Facebook and Messenger channels only.
IdentityGroupId
string
The identity group id references the identity group that contains all information (phone, notes, etc.). Many identities may belong to this group. If the identi…
NonEnumeratedPagingModel
object
5 properties 1 required
IdentityFbCategory
string
Facebook category of the identity. Applicable to Facebook and Messenger channels only.
IdentityScreenName
string
Screen name of the identity.
SocMsgCreationTimeOrder
string
Ordering by creationTime is descending by default.
IdentityTwStatusesCount
integer
Count of tweets of the identity. Applicable to Twitter channels only.
IdentityTwDescription
string
Twitter description of the identity. Applicable to Twitter channels only.
IdentityUserIds
array
List of the associated user identifiers who can use the identity.
SocMsgLastModifiedTime
string
The time when the last modification was completed.
IdentityDisplayName
string
Display name of the identity.
IdentityAvatarURI
string
Identity's avatar Uri.
IdentityCountry
string
Viber country of the identity. Applicable to Viber channels only.
SocMsgCompany
string
Company.
IdentityModel
object
36 properties 4 required
IdentityFbLocale
string
Facebook locale of the identity. Applicable to Facebook and Messenger channels only.
IdentityIgFollowersCount
integer
Instagram followers count of the identity. Applicable to Instagram and InstagramMessaging channels only.
IdentityTwFollowersCount
integer
Twitter followers count of the identity. Applicable to Twitter channels only.
IdentityApiVersion
string
Viber API version of the identity. Applicable to Viber channels only.
IdentityId
string
Identity identifier.
IdentityExtraValues
object
Additional data to store along the identity.
SocMsgFirstName
string
FirstName.
IdentitiesList
object
2 properties 2 required
IdentityMobileDeviceInfo
string
Device info of the identity. Applicable to RingCX Digital Messaging channels only.
SocMsgCreationTime
string
Creation time of the resource.
IdentityMnc
string
Viber mobile network code of the identity. Applicable to Viber channels only.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-identities-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