Features: Call Recording - Get Organization Call Recording Vendors

Get Organization Call Recording Vendors

Returns what the current vendor is as well as a list of all the available vendors.

The Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.

Requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

GET/v1/telephony/config/callRecording/vendors

Query Parameters

orgId

string

Retrieve call recording settings from this organization.

Response Properties

vendorId

string

Unique identifier of the vendor.

vendorName

string

Name of the vendor.

vendors

CallRecordingVendors

List of call recording vendors

items

array[CallRecordingVendor]

List of call recording vendors.

string

Unique identifier of the vendor.

name

string

Name of the vendor.

description

string

Description of the vendor.

migrateUserCreationEnabled

boolean

Represents whether user creation is integrated for this vendor. When user creation is integrated, a call recording account in the vendor's system is automatically created when a user is created or added.

loginUrl

string

Vendor login page to access user call recordings.

termsOfServiceUrl

string

Vendor terms of service URL.

storageRegion

string

Call recording storage region. Only applicable for Webex as a vendor and isn't used for other vendors.

failureBehavior

FailureBehavior

Call recording failure behavior.

PROCEED_WITH_CALL_NO_ANNOUNCEMENT

string

Failure behavior will make sure that the call proceeds without announcement.

PROCEED_CALL_WITH_ANNOUNCEMENT

string

Failure behavior will make sure that the call proceeds with an announcement.

END_CALL_WITH_ANNOUNCEMENT

string

Failure behavior will make sure that the call ends with an announcement.

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.
201	Created	The request has succeeded and has led to the creation of a resource.
202	Accepted	The request has been accepted for processing.
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.

GET

/v1/telephony/config/callRecording/vendors{?orgId}

Header

Content-Type
Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

orgId
string
Retrieve call recording settings from this organization.

https://webexapis.com/v1/telephony/config/callRecording/vendors?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lNTEzMTg1Zi01YTJmLTQ0OTUtYjM1Yi03MDY3YmY3Y2U0OGU

200 / OK

{
    "vendorId": "Y2lzY29zcGFyazovL3VzL1JFQ09SRElOR19WRU5ET1IvMGE0MjY3NTQtYTQ3MC00YzJkLThiYTAtZmJjNjc3M2E4YTdj",
    "vendorName": "Webex",
    "vendors": [
        {
            "id": "Y2lzY29zcGFyazovL3VzL1JFQ09SRElOR19WRU5ET1IvNTNkYzRjODctODQwOC00ODgyLTk1NzAtZGNhMmJjZGI5Mjgw",
            "name": "Dubber",
            "description": "Dubber Call Recording Provider",
            "migrateUserCreationEnabled": true,
            "loginUrl": "https://wxc-sandbox.dubber.net/login?sso=webex",
            "termsOfServiceUrl": "https://www.dubber.net/terms"
        },
        {
            "id": "Y2lzY29zcGFyazovL3VzL1JFQ09SRElOR19WRU5ET1IvMGE0MjY3NTQtYTQ3MC00YzJkLThiYTAtZmJjNjc3M2E4YTdj",
            "name": "Webex",
            "description": "Webex CRP",
            "migrateUserCreationEnabled": false,
            "loginUrl": "",
            "termsOfServiceUrl": ""
        }
    ],
    "storageRegion": "US",
    "failureBehavior": "PROCEED_WITH_CALL_NO_ANNOUNCEMENT"
}