Configure Call Recording Settings for a Person
Configure 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.
URI Parameters
Unique identifier for the person.
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.
Body Parameters
true if call recording is enabled.
Specified under which scenarios calls will be recorded.
Incoming and outgoing calls will be recorded with no control to start, stop, pause, or resume.
Calls will not be recorded.
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.
Calls are always recorded, but user can pause or resume the recording. Stop recording is not supported.
Records only the portion of the call after the recording start (*44) has been entered. Pause, resume, and stop controls are supported.
When true, voicemail messages are also recorded.
When enabled, an announcement is played when call recording start and an announcement is played when call recording ends.
Pause/resume notification settings.
Type of pause/resume notification.
No notification sound played when call recording is paused or resumed.
A beep sound is played when call recording is paused or resumed.
A verbal announcement is played when call recording is paused or resumed.
true when notification type setting is in effect. false indicates notification is disabled.
Beep sound played periodically while call recording settings.
Interval at which warning tone "beep" will be played. This interval is an integer from 10 to 1800 seconds
true when ongoing call recording tone will be played at designated interval. false indicates no warning tone will be played.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The 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. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The 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. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The 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. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too 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. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
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.
Body
- `true` if call recording is enabled.
- Specified under which scenarios calls will be recorded.
- When `true`, voicemail messages are also recorded.
- When enabled, an announcement is played when call recording start and an announcement is played when call recording ends.
- Pause/resume notification settings.
{
"enabled": true,
"record": "Always with Pause/Resume",
"notification": {
"enabled": true,
"type": "Play Announcement"
},
"startStopAnnouncementEnabled": true,
"recordVoicemailEnabled": true,
"repeat": {
"enabled": true
}
}