RingCentral Call Log API

The Call Log API from RingCentral — 8 operation(s) for call log.

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

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

This API exposes 9 operations across 8 paths, and defines 35 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.

9 operations 8 paths 35 schemas 1 DELETE8 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

Contact

RingCentral Developers Support

License

RingCentral API License Agreement

View terms

Resource Areas

Authentication & Security 1

RingCentral Call Log 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 9

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

Call Log 9

GET

/restapi/v1.0/account/{accountId}/call-log

List Company Call Records

readCompanyCallLog 14 params → 200400403404500503

GET

/restapi/v1.0/account/{accountId}/call-log/{callRecordId}

Get Company Call Record(s)

readCompanyCallRecord 3 params → 200400403404500503

GET

/restapi/v1.0/account/{accountId}/call-log-sync

Sync Company Call Log

syncAccountCallLog 10 params → 200400403404500503

GET

/restapi/v1.0/account/{accountId}/active-calls

List Company Active Calls

listCompanyActiveCalls 8 params → 200400403404500503

GET

/restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log

List User Call Records

readUserCallLog 18 params → 200400403404500503

DELETE

/restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log

Delete User Call Records

deleteUserCallLog 3 params → 204400403404500503

GET

/restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log/{callRecordId}

Get User Call Record(s)

readUserCallRecord 4 params → 200400403404500503

GET

/restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log-sync

Sync User Call Log

syncUserCallLog 11 params → 200400403404500503

GET

/restapi/v1.0/account/{accountId}/extension/{extensionId}/active-calls

List User Active Calls

listExtensionActiveCalls 9 params → 200400403404500503

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are BaseCallLogRecord (25 properties), EnumeratedPagingModel (6 properties), CallLogResponse (4 properties), CallLogRecordingInfo (4 properties). Each schema is shown below with its type and property counts.

CallLogResponse

object

4 properties 3 required

CallResultReasonEnum

string

The reason of the call result: Accepted - The call was connected to and accepted by this number Connected - The call was answered, but there was no response on…

BaseCallLogFromParty

object

Sender/initiator caller information

1 property

CallLogDelegateInfo

object

Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented…

2 properties 1 required

ApiErrorWithParameter

The error model with additional attributes which can be used for HTTP 400/409 This is a deprecated model: "ApiError" model can be used instead with arbitrary a…

CallResultEnum

string

The result of the call operation

CallLogSyncTypeEnum

string

Type of call log synchronization request: full or incremental sync

ApiError

object

Generalized API error structure suitable for any error type

2 properties 2 required

PageNavigationUri

object

1 property

ApiErrorResponseModel

object

Standard error response model which is returned in case of any unsuccessful operation

1 property 1 required

EnumeratedPagingModel

object

6 properties 1 required

CallLogSyncInfo

object

3 properties 3 required

CallLogRecordLegInfo

BillingInfo

object

Billing information related to the call. Returned for 'Detailed' view only

2 properties

CallLogRecordingInfo

object

Call recording data. Returned if the call was recorded

4 properties 4 required

BaseCallLogParty

object

Base schema for call log parties and history call log parties

4 properties

PageNavigationModel

object

Links to other pages of the current result set

4 properties

CallLogParty

BaseCallLogToParty

object

Target caller information

1 property

CallLegTypeEnum

string

Leg type

ExtensionInfoCallLog

object

Information about extension on whose behalf a call is initiated. For Secretary call log the Boss extension info is returned

2 properties 2 required

CallTypeEnum

string

The type of call

CallLogRecordDeviceInfo

object

2 properties 2 required

CallLogRecord

ParameterizedErrorResponseModel

object

Standard error response which may include parameterized errors

1 property 1 required

CallActionEnum

string

The internal action corresponding to the call operation

DelegationTypeEnum

string

Call delegation type

CallTransportEnum

string

The type of call transport. 'PSTN' indicates that a call leg was initiated from the PSTN network provider; 'VoIP' - from an RC phone.

CallLogSyncResponse

object

3 properties 3 required

CallInternalTypeEnum

string

The internal type of the call

CallLogToParty

CallLogFromParty

CallDirectionEnum

string

The direction of a call

BaseCallLogRecord

object

Base schema for CallLogRecord and CallLogRecordLegInfo

25 properties 6 required

CallLogRecordMessage

object

Linked message (Fax/Voicemail)

3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs RingCentral publishes across the network.

RingCentral SMS API

AE Profile APIs.io

RingCentral Team Messaging API

AE Profile APIs.io

RingCentral Video API

AE Profile APIs.io

RingCentral Fax API

AE Profile APIs.io

RingCentral Data API

AE Profile APIs.io

RingCentral Audio and Video AI API

AE Profile APIs.io

RingCentral Call Analytics API

AE Profile APIs.io

RingCentral Presence API

AE Profile APIs.io

RingCentral Voicemail API

AE Profile APIs.io

RingCentral Provisioning API

AE Profile APIs.io

RingCentral Webhooks and Subscriptions API

AE Profile APIs.io

RingCentral Contact Center API

AE Profile APIs.io

#Call Log

← Back to R APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

RingCentral Call Log API

Metadata

Authentication & Security 1

Paths & Operations 9

Schemas 35

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

RingCentral Call Log API

Metadata

Authentication & Security 1

Paths & Operations 9

Schemas 35

Specification

Source

More from RingCentral 12

API Details

Provider

Explore more