Test Environment. You are currently using the Webex for Developers test environment. Apps created here will not be available for use with Webex Teams. Please visit Webex for Developers to manage your apps.
REST API
Getting Started Basics
Guides
API Reference
API Changelog

Read Call Recording Settings for a Person

Retrieve a Person's Call Recording Settings

The Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more.

This API requires a full or user administrator auth token with the spark-admin:people_write scope.

GET/v1/people/{personId}/features/callRecording
URI Parameters
personId
stringrequired

Unique identifier for the person.

Query Parameters
orgId
string

Person is in this organization. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as token used to access API.

Response Properties
enabled
boolean

true if call recording is enabled.

record
enum

Specified under which scenarios calls will be recorded.

Always
string

Incoming and outgoing calls will be recorded with no control to start, stop, pause, or resume.

Never
string

Calls will not be recorded.

On Demand
string

The entire call is saved when the call is placed on hold and call recording start (*44) is entered prior to call end. Pause and resume controls are supported.

Always with Pause/Resume
string

Calls are always recorded, but user can pause or resume the recording. Stop recording is not supported.

On Demand with User Initiated Start
string

Records only the portion of the call after the recording start (*44) has been entered. Pause, resume, and stop controls are supported.

recordVoicemailEnabled
boolean

When true, voicemail messages are also recorded.

startStopAnnouncementEnabled
boolean

When enabled, an announcement is played when call recording start and an announcement is played when call recording ends.

notification
object

Pause/resume notification settings.

type
enum

Type of pause/resume notification.

None
string

No notification sound played when call recording is paused or resumed.

Beep
string

A beep sound is played when call recording is paused or resumed.

Play Announcement
string

A verbal announcement is played when call recording is paused or resumed.

enabled
boolean

true when notification type setting is in effect. false indicates notification is disabled.

repeat
object

Beep sound played periodically while call recording settings.

interval
number

Interval at which warning tone "beep" will be played. This interval is an integer from 10 to 1800 seconds

enabled
boolean

true when ongoing call recording tone will be played at designated interval. false indicates no warning tone will be played.

serviceProvider
string

Name of service provider providing call recording service.

externalGroup
string

Group utilized by service provider providing call recording service.

externalIdentifier
string

Unique person identifier utilized by service provider providing call recording service.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
GET
/v1/people//features/callRecording{?orgId}
Log in to try the API.
Header
Query Parameters
  • Person is in this organization. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as token used to access API.
https://webexapis.com/v1/people/Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI/features/callRecording?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
200 / OK
{
    "enabled": true,
    "record": "Never",
    "recordVoicemailEnabled": false,
    "startStopAnnouncementEnabled": false,
    "notification": {
            "type": "None",
            "enabled": false
    },
    "repeat": {
            "interval": 15,
            "enabled": false
    },
    "serviceProvider": "WSWYZ25455",
    "externalGroup": "WSWYZ25455L31161",
    "externalIdentifier": "a34iidrh5o@64941297.int10.bcld.webex.com"
}