openapi: 3.0.0 info: title: Webex Admin Address Book User Call Settings (1/2) API version: 1.0.0 description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling. tags: - name: User Call Settings (1/2) paths: /people/{personId}/features/applications: put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify a person's Application Services Settings operationId: Modify a person's Application Services Settings description: 'Application services let you determine the ringing behavior for calls made to users in certain scenarios. You can also specify which devices users can download the Webex Calling app on. This API requires a full or user administrator or location administrator auth token with the spark-admin:people_write scope.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicationsSettingPut' /people/{personId}/features/bargeIn: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/BargeInInfo' example: enabled: true toneEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Barge In Settings for a Person operationId: Read Barge In Settings for a Person description: 'Retrieve a person''s Barge In settings. The Barge In feature enables you to use a Feature Access Code (FAC) to answer a call that was directed to another subscriber, or barge-in on the call if it was already answered. Barge In can be used across locations. This API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read` or a user auth token with `spark:people_read` scope can be used by a person to read their own settings.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Barge In Settings for a Person operationId: Configure Barge In Settings for a Person description: 'Configure a person''s Barge In settings. The Barge In feature enables you to use a Feature Access Code (FAC) to answer a call that was directed to another subscriber, or barge-in on the call if it was already answered. Barge In can be used across locations. This API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope or a user auth token with `spark:people_write` scope can be used by a person to update their own settings.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: true toneEnabled: true schema: $ref: '#/components/schemas/BargeInPut' /people/{personId}/features/callForwarding: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallForwardingInfo' example: callForwarding: always: enabled: false ringReminderEnabled: false destinationVoicemailEnabled: false busy: enabled: false destinationVoicemailEnabled: false noAnswer: enabled: false numberOfRings: 2 systemMaxNumberOfRings: 20 destinationVoicemailEnabled: false businessContinuity: enabled: false destinationVoicemailEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Forwarding Settings for a Person operationId: Read Forwarding Settings for a Person description: 'Retrieve a person''s Call Forwarding settings. Three types of call forwarding are supported: + Always - forwards all incoming calls to the destination you choose. + When busy - forwards all incoming calls to the destination you chose while the phone is in use or the person is busy. + When no answer - forwarding only occurs when you are away or not answering your phone. In addition, the Business Continuity feature will send calls to a destination of your choice if your phone is not connected to the network for any reason, such as a power outage, failed Internet connection, or wiring problem. This API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read` or a user auth token with `spark:people_read` scope can be used by a person to read their own settings.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Call Forwarding Settings for a Person operationId: Configure Call Forwarding Settings for a Person description: 'Configure a person''s Call Forwarding settings. Three types of call forwarding are supported: + Always - forwards all incoming calls to the destination you choose. + When busy - forwards all incoming calls to the destination you chose while the phone is in use or the person is busy. + When no answer - forwarding only occurs when you are away or not answering your phone. In addition, the Business Continuity feature will send calls to a destination of your choice if your phone is not connected to the network for any reason, such as a power outage, failed Internet connection, or wiring problem. This API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope or a user auth token with `spark:people_write` scope can be used by a person to update their settings.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: callForwarding: always: enabled: false destination: '' ringReminderEnabled: false destinationVoicemailEnabled: false busy: enabled: true destination: '9075551333' destinationVoicemailEnabled: true noAnswer: enabled: false destination: '' numberOfRings: 2 destinationVoicemailEnabled: false businessContinuity: enabled: false destination: '' destinationVoicemailEnabled: false schema: $ref: '#/components/schemas/CallForwardingPut' /people/{personId}/features/intercept: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallInterceptInfo' example: enabled: false incoming: type: INTERCEPT_ALL voicemailEnabled: false announcements: greeting: DEFAULT newNumber: enabled: false zeroTransfer: enabled: false outgoing: type: INTERCEPT_ALL transferEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Call Intercept Settings for a Person operationId: Read Call Intercept Settings for a Person description: 'Retrieves Person''s Call Intercept settings. The intercept feature gracefully takes a person''s phone out of service, while providing callers with informative announcements and alternative routing options. Depending on the service configuration, none, some, or all incoming calls to the specified person are intercepted. Also depending on the service configuration, outgoing calls are intercepted or rerouted to another location. This API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Call Intercept Settings for a Person operationId: Configure Call Intercept Settings for a Person description: 'Configures a person''s Call Intercept settings. The intercept feature gracefully takes a person''s phone out of service, while providing callers with informative announcements and alternative routing options. Depending on the service configuration, none, some, or all incoming calls to the specified person are intercepted. Also depending on the service configuration, outgoing calls are intercepted or rerouted to another location. This API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: true incoming: type: INTERCEPT_ALL voicemailEnabled: false announcements: greeting: DEFAULT fileName: '' newNumber: enabled: false destination: '' zeroTransfer: enabled: false destination: '' outgoing: transferEnabled: false type: INTERCEPT_ALL destination: '' schema: $ref: '#/components/schemas/CallInterceptPut' /people/{personId}/features/intercept/actions/announcementUpload/invoke: post: responses: '201': description: Created headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Call Intercept Greeting for a Person operationId: Configure Call Intercept Greeting for a Person description: 'Configure a person''s Call Intercept Greeting by uploading a Waveform Audio File Format, `.wav`, encoded audio file. Your request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type. This API requires a full or user administrator auth token with the `spark-admin:people_write` scope or a user auth token with `spark:people_write` scope can be used by a person to update their settings.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /people/{personId}/features/callRecording: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallRecordingInfo' example: enabled: true record: Never recordVoicemailEnabled: false startStopAnnouncementEnabled: false notification: enabled: true type: None repeat: interval: 15 enabled: false serviceProvider: WSWYZ25455 externalGroup: WSWYZ25455L31161 externalIdentifier: a34iidrh5o@64941297.int10.bcld.webex.com startStopAnnouncement: internalCallsEnabled: false pstnCallsEnabled: false callRecordingAccessSettings: viewAndPlayRecordingsEnabled: false downloadRecordingsEnabled: false deleteRecordingsEnabled: false shareRecordingsEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Call Recording Settings for a Person operationId: Read Call Recording Settings for a Person description: '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 or location administrator auth token with the `spark-admin:people_read` scope.
A person with a Webex Calling Standard license is eligible for the Call Recording feature only when the Call Recording vendor is Webex.
' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Call Recording Settings for a Person operationId: Configure Call Recording Settings for a Person description: '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 or location administrator auth token with the `spark-admin:people_write` scope.
A person with a Webex Calling Standard license is eligible for the Call Recording feature only when the Call Recording vendor is Webex.
' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: true record: Always with Pause/Resume notification: enabled: true type: Play Announcement startStopAnnouncementEnabled: true recordVoicemailEnabled: true repeat: enabled: true startStopAnnouncement: internalCallsEnabled: true pstnCallsEnabled: true schema: $ref: '#/components/schemas/CallRecordingPut' /people/{personId}/features/callWaiting: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallWaitingInfo' example: enabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Call Waiting Settings for a Person operationId: Read Call Waiting Settings for a Person description: 'Retrieve a person''s Call Waiting settings. With this feature, a person can place an active call on hold and answer an incoming call. When enabled, while you are on an active call, a tone alerts you of an incoming call and you can choose to answer or ignore the call. This API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Call Waiting Settings for a Person operationId: Configure Call Waiting Settings for a Person description: 'Configure a person''s Call Waiting settings. With this feature, a person can place an active call on hold and answer an incoming call. When enabled, while you are on an active call, a tone alerts you of an incoming call and you can choose to answer or ignore the call. This API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: true schema: $ref: '#/components/schemas/CallWaitingInfo' /people/{personId}/features/callerId: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallerIdInfo' example: types: - DIRECT_LINE - LOCATION_NUMBER - CUSTOM selected: DIRECT_LINE directNumber: '3182202028' extensionNumber: '4000' locationNumber: '+13182202021' tollFreeLocationNumber: false firstName: Lya lastName: Charrel blockInForwardCallsEnabled: false externalCallerIdNamePolicy: OTHER customExternalCallerIdName: Lya Custom locationExternalCallerIdName: Location caller id additionalExternalCallerIdDirectLineEnabled: false additionalExternalCallerIdLocationNumberEnabled: false additionalExternalCallerIdCustomNumber: '2025552000' directLineCallerIdName: selection: CUSTOM_NAME customName: Lya Charrel dialByFirstName: Lya dialByLastName: Charrel '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Caller ID Settings for a Person operationId: Read Caller ID Settings for a Person description: 'Retrieve a person''s Caller ID settings. Caller ID settings control how a person''s information is displayed when making outgoing calls. This API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Caller ID Settings for a Person operationId: Configure Caller ID Settings for a Person description: 'Configure a person''s Caller ID settings. Caller ID settings control how a person''s information is displayed when making outgoing calls. This API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: selected: LOCATION_NUMBER directNumber: '3182202028' extensionNumber: '4000' locationNumber: '+13182202021' firstName: Lya lastName: Charrel blockInForwardCallsEnabled: false externalCallerIdNamePolicy: OTHER customExternalCallerIdName: Lya Custom additionalExternalCallerIdDirectLineEnabled: false additionalExternalCallerIdLocationNumberEnabled: false additionalExternalCallerIdCustomNumber: '2025552000' directLineCallerIdName: selection: CUSTOM_NAME customName: Lya Charrel dialByFirstName: Lya dialByLastName: Charrel schema: $ref: '#/components/schemas/CallerIdPut' /people/{personId}/features/callingBehavior: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetCallingBehaviorObject' example: behaviorType: null effectiveBehaviorType: NATIVE_WEBEX_TEAMS_CALLING profileId: Y2lzY29zcGFyazovL3VzL0NBTExJTkdfUFJPRklMRS9iMzdmMmZiYS0yZTdjLTExZWItYTM2OC1kYmU0Yjc2NzFmZTk '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Person's Calling Behavior operationId: Read Person's Calling Behavior description: 'Retrieves the calling behavior and UC Manager Profile settings for the person which includes overall calling behavior and calling UC Manager Profile ID. Webex Calling Behavior controls which Webex telephony application and which UC Manager Profile is to be used for a person. An organization has an organization-wide default Calling Behavior that may be overridden for individual persons. UC Manager Profiles are applicable if your organization uses Jabber in Team Messaging mode or Calling in Webex (Unified CM). The UC Manager Profile also has an organization-wide default and may be overridden for individual persons. This API requires a full, user, or read-only administrator auth token with a scope of `spark-admin:people_read`.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure a person's Calling Behavior operationId: Configure a person's Calling Behavior description: 'Modifies the calling behavior settings for the person which includes calling behavior and UC Manager Profile ID. Webex Calling Behavior controls which Webex telephony application and which UC Manager Profile is to be used for a person. An organization has an organization-wide default Calling Behavior that may be overridden for individual persons. UC Manager Profiles are applicable if your organization uses Jabber in Team Messaging mode or Calling in Webex (Unified CM). The UC Manager Profile also has an organization-wide default and may be overridden for individual persons. This API requires a full or user administrator auth token with the `spark-admin:people_write` scope.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: behaviorType: NATIVE_WEBEX_TEAMS_CALLING profileId: Y2lzY29zcGFyazovL3VzL0NBTExJTkdfUFJPRklMRS9iMzdmMmZiYS0yZTdjLTExZWItYTM2OC1kYmU0Yjc2NzFmZTk schema: $ref: '#/components/schemas/PatchCallingBehaviorObject' /people/{personId}/features/doNotDisturb: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/DoNotDisturbInfo' example: enabled: true ringSplashEnabled: true webexGoOverrideEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Do Not Disturb Settings for a Person operationId: Read Do Not Disturb Settings for a Person description: 'Retrieve a person''s Do Not Disturb settings. When enabled, this feature will give all incoming calls the busy treatment. Optionally, you can enable a Ring Reminder to play a brief tone on your desktop phone when you receive incoming calls. This API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read` or a user auth token with `spark:people_read` scope can be used by a person to read their settings.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Do Not Disturb Settings for a Person operationId: Configure Do Not Disturb Settings for a Person description: 'Configure a person''s Do Not Disturb settings. When enabled, this feature will give all incoming calls the busy treatment. Optionally, you can enable a Ring Reminder to play a brief tone on your desktop phone when you receive incoming calls. This API requires a full or user administrator auth token with the `spark-admin:people_write` scope or a user auth token with `spark:people_write` scope can be used by a person to update their settings.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: true ringSplashEnabled: false webexGoOverrideEnabled: false schema: $ref: '#/components/schemas/DoNotDisturbPut' /people/{personId}/features/executiveAssistant: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: type: type: string enum: - UNASSIGNED - EXECUTIVE - EXECUTIVE_ASSISTANT description: "The Executive Assistant type.\n * `UNASSIGNED` - The feature is not enabled.\n * `EXECUTIVE` - The feature is enabled and the person is an Executive.\n * `EXECUTIVE_ASSISTANT` - The feature is enabled and the person is an Executive Assistant.\n" example: type: EXECUTIVE '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve Executive Assistant Settings for a Person operationId: Retrieve Executive Assistant Settings for a Person description: 'Retrieve the executive assistant settings for the specified `personId`. People with the executive service enabled, can select from a pool of assistants who have been assigned the executive assistant service and who can answer or place calls on their behalf. Executive assistants can set the call forward destination and join or leave an executive''s pool. This API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify Executive Assistant Settings for a Person operationId: Modify Executive Assistant Settings for a Person description: 'Modify the executive assistant settings for the specified personId. People with the executive service enabled, can select from a pool of assistants who have been assigned the executive assistant service and who can answer or place calls on their behalf. Executive assistants can set the call forward destination and join or leave an executive''s pool. This API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: schema: type: object properties: type: type: string enum: - UNASSIGNED - EXECUTIVE - EXECUTIVE_ASSISTANT description: "executive assistant type\n * `UNASSIGNED` - The feature is not enabled.\n * `EXECUTIVE` - The feature is enabled and the person is an Executive.\n * `EXECUTIVE_ASSISTANT` - The feature is enabled and the person is an Executive Assistant.\n" /people/{personId}/features/hoteling: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/HotelingInfo' example: enabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Hoteling Settings for a Person operationId: Read Hoteling Settings for a Person description: 'Retrieve a person''s hoteling settings. As an administrator, you can enable hoteling for people so that their phone profile (phone number, features, and calling plan) is temporarily loaded onto a shared (host) phone. This API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Hoteling Settings for a Person operationId: Configure Hoteling Settings for a Person description: 'Configure a person''s hoteling settings. As an administrator, you can enable hoteling for people so that their phone profile (phone number, features, and calling plan) is temporarily loaded onto a shared (host) phone. This API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: true schema: $ref: '#/components/schemas/HotelingInfo' /people/{personId}/features/monitoring: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/MonitoringSettings' example: callParkNotificationEnabled: true monitoredElements: - member: id: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85OWNlZjRmYS03YTM5LTQ1ZDItOTNmNi1jNjA5YTRiMjgzODY lastName: Nelson firstName: John displayName: John Nelson type: PEOPLE email: john.nelson@gmail.com numbers: - external: +1-9728138888 extension: '1234' routingPrefix: '1234' esn: '12341234' primary: true location: Dallas locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg - member: id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS83MGY2MzYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc3OGg= lastName: Smith firstName: Alice displayName: AliceSmith type: VIRTUAL_LINE numbers: - external: '+19075552859' extension: '8086' routingPrefix: '1234' esn: '12341234' primary: 'true' location: Dallas locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg callparkextension: id: Y2lzY29zcGFyazovL3VzL0NBTExfUEFSS19FWFRFTlNJT04vZTdlZDdiMDEtN2E4Ni00NDEwLWFlODMtOWJmODMzZGEzNzQy name: Dallas-Test extension: '4001' routingPrefix: '1234' esn: '12344001' location: Dallas locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve a person's Monitoring Settings operationId: Retrieve a person's Monitoring Settings description: 'Retrieves the monitoring settings of the person, which shows specified people, places, virtual lines or call park extenions that are being monitored. Monitors the line status which indicates if a person, place or virtual line is on a call and if a call has been parked on that extension. This API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify a person's Monitoring Settings operationId: Modify a person's Monitoring Settings description: 'Modifies the monitoring settings of the person. Monitors the line status of specified people, places, virtual lines or call park extension. The line status indicates if a person, place or virtual line is on a call and if a call has been parked on that extension. The number of monitored elements is limited to 50. This API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enableCallParkNotification: true monitoredElements: - Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OWNlZjRmYS03YTM5LTQ1ZDItOTNmNi1jNjA5YTRiMjgzODY - Y2lzY29zcGFyazovL3VzL0NBTExfUEFSS19FWFRFTlNJT04vZTdlZDdiMDEtN2E4Ni00NDEwLWFlODMtOWJmODMzZGEzNzQy - Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS9mNzc4ZTc4NS02MGZhLTQ1YjUtYTViZi04ODNkOWIyNTdlNGQ= schema: $ref: '#/components/schemas/MonitoringSettingsPut' /people/{personId}/features/incomingPermission: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/IncomingPermissionSetting' example: useCustomEnabled: false externalTransfer: ALLOW_ALL_EXTERNAL internalCallsEnabled: true collectCallsEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Incoming Permission Settings for a Person operationId: Read Incoming Permission Settings for a Person description: 'Retrieve a person''s Incoming Permission settings. You can change the incoming calling permissions for a person if you want them to be different from your organization''s default. This API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Incoming Permission Settings for a Person operationId: Configure Incoming Permission Settings for a Person description: 'Configure a person''s Incoming Permission settings. You can change the incoming calling permissions for a person if you want them to be different from your organization''s default. This API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: useCustomEnabled: false externalTransfer: ALLOW_ALL_EXTERNAL internalCallsEnabled: true collectCallsEnabled: true schema: $ref: '#/components/schemas/IncomingPermissionSetting' /people/{personId}/features/outgoingPermission: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/OutgoingCallingPermissionsSettingGet' example: useCustomEnabled: true useCustomPermissions: true callingPermissions: - callType: INTERNAL_CALL action: ALLOW transferEnabled: true isCallTypeRestrictionEnabled: false - callType: TOLL_FREE action: ALLOW transferEnabled: true isCallTypeRestrictionEnabled: false - callType: INTERNATIONAL action: BLOCK transferEnabled: false isCallTypeRestrictionEnabled: false - callType: OPERATOR_ASSISTED action: ALLOW transferEnabled: true isCallTypeRestrictionEnabled: false - callType: CHARGEABLE_DIRECTORY_ASSISTED action: BLOCK transferEnabled: true isCallTypeRestrictionEnabled: false - callType: SPECIAL_SERVICES_I action: ALLOW transferEnabled: true isCallTypeRestrictionEnabled: false - callType: SPECIAL_SERVICES_II action: ALLOW transferEnabled: true isCallTypeRestrictionEnabled: true - callType: PREMIUM_SERVICES_I action: BLOCK transferEnabled: false isCallTypeRestrictionEnabled: false - callType: PREMIUM_SERVICES_II action: BLOCK transferEnabled: false isCallTypeRestrictionEnabled: true - callType: NATIONAL action: ALLOW transferEnabled: true isCallTypeRestrictionEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Retrieve a person's Outgoing Calling Permissions Settings operationId: Retrieve a person's Outgoing Calling Permissions Settings description: 'Retrieve a person''s Outgoing Calling Permissions settings. Outgoing calling permissions regulate behavior for calls placed to various destinations and default to the local level settings. You can change the outgoing calling permissions for a person if you want them to be different from your organization''s default. This API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Modify a person's Outgoing Calling Permissions Settings operationId: Modify a person's Outgoing Calling Permissions Settings description: 'Modify a person''s Outgoing Calling Permissions settings. Outgoing calling permissions regulate behavior for calls placed to various destinations and default to the local level settings. You can change the outgoing calling permissions for a person if you want them to be different from your organization''s default. This API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: useCustomEnabled: true useCustomPermissions: true callingPermissions: - callType: INTERNAL_CALL action: ALLOW transferEnabled: true schema: $ref: '#/components/schemas/OutgoingCallingPermissionsSettingPut' /people/{personId}/features/numbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetNumbers' example: distinctiveRingEnabled: true phoneNumbers: - primary: true directNumber: '2143456789' extension: '1234' routingPrefix: '1234' esn: '12341234' ringPattern: NORMAL '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get a List of Phone Numbers for a Person operationId: Get a List of Phone Numbers for a Person description: 'Get a person''s phone numbers including alternate numbers. A person can have one or more phone numbers and/or extensions via which they can be called. This API requires a full or user administrator or location administrator auth token with the `spark-admin:people_read` scope.
The `preferE164Format` query parameter can be used to get phone numbers either in E.164 format or in their legacy format. The support for getting phone numbers in non-E.164 format in some geographies will be removed in the future.
' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: preferE164Format in: query description: Return phone numbers in E.164 format. example: 'true' schema: type: boolean /people/{personId}/features/privacy: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PrivacyGet' example: aaExtensionDialingEnabled: true aaNamingDialingEnabled: true enablePhoneStatusDirectoryPrivacy: true enablePhoneStatusPickupBargeInPrivacy: true monitoringAgents: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MWU3MDlkNy1hM2IxLTQ2MDctOTBiOC04NmE5MDgxYWFkNmE lastName: Little firstName: Alice displayName: Alice Little type: PEOPLE email: alice@example.com numbers: - external: '+19845551088' extension: '1088' routingPrefix: '1234' esn: '12341088' primary: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get a person's Privacy Settings operationId: Get a person's Privacy Settings description: 'Get a person''s privacy settings for the specified person ID. The privacy feature enables the person''s line to be monitored by others and determine if they can be reached by Auto Attendant services. This API requires a full, user, or read-only administrator or location administrator auth token with a scope of spark-admin:people_read.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '200': description: OK headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure a person's Privacy Settings operationId: Configure a person's Privacy Settings description: 'Configure a person''s privacy settings for the specified person ID. The privacy feature enables the person''s line to be monitored by others and determine if they can be reached by Auto Attendant services. This API requires a full or user administrator or location administrator auth token with the spark-admin:people_write scope.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: schema: type: object properties: aaExtensionDialingEnabled: type: boolean example: true description: When `true` auto attendant extension dialing is enabled. aaNamingDialingEnabled: type: boolean example: true description: When `true` auto attendant dailing by first or last name is enabled. enablePhoneStatusDirectoryPrivacy: type: boolean example: true description: When `true` phone status directory privacy is enabled. enablePhoneStatusPickupBargeInPrivacy: type: boolean example: true description: When `true` privacy is enforced for call pickup and barge-in. Only members specified by `monitoringAgents` can pickup or barge-in on the call. monitoringAgents: type: array items: type: string description: List of monitoring person IDs. /people/{personId}/features/pushToTalk: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PushToTalkInfo' example: allowAutoAnswer: true connectionType: ONE_WAY accessType: ALLOW_MEMBERS members: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MWU3MDlkNy1hM2IxLTQ2MDctOTBiOC04NmE5MDgxYWFkNmE lastName: Little firstName: Alice displayName: Alice Little type: PEOPLE email: alice@example.com location: name: Paragville id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhjOWZkMjg1LTY1MDAtNDUxOC04NTZlLWViODM2YzY3NjFkOA numbers: - external: '+19845551088' extension: '1088' routingPrefix: '1234' esn: '12341088' primary: true - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jMTQzMzhkNS02YTdjLTRiZjYtOTFiMS0zYmM2ZWMzMGJiMTE lastName: Johnson firstName: Bob displayName: Bob Johnson type: PEOPLE email: bob@example.com numbers: - external: '+198455501099' extension: '1099' routingPrefix: '1234' esn: '12341099' primary: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Push-to-Talk Settings for a Person operationId: Read Push-to-Talk Settings for a Person description: 'Retrieve a person''s Push-to-Talk settings. Push-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people in different parts of your organization. This API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Push-to-Talk Settings for a Person operationId: Configure Push-to-Talk Settings for a Person description: 'Configure a person''s Push-to-Talk settings. Push-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people in different parts of your organization. This API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: allowAutoAnswer: true connectionType: ONE_WAY accessType: ALLOW_MEMBERS members: - Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MWU3MDlkNy1hM2IxLTQ2MDctOTBiOC04NmE5MDgxYWFkNmE - Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jMTQzMzhkNS02YTdjLTRiZjYtOTFiMS0zYmM2ZWMzMGJiMTE schema: $ref: '#/components/schemas/PushToTalkPut' /people/{personId}/features/reception: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ReceptionInfo' example: receptionEnabled: true monitoredMembers: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MWU3MDlkNy1hM2IxLTQ2MDctOTBiOC04NmE5MDgxYWFkNmE lastName: Little firstName: Alice displayName: Alice Little type: PEOPLE email: alice@example.com location: name: Paragville id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhjOWZkMjg1LTY1MDAtNDUxOC04NTZlLWViODM2YzY3NjFkOA numbers: - external: '+19845551088' extension: '1088' routingPrefix: '1234' esn: '12341088' primary: true - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jMTQzMzhkNS02YTdjLTRiZjYtOTFiMS0zYmM2ZWMzMGJiMTE lastName: Johnson firstName: Bob displayName: Bob Johnson type: PEOPLE email: bob@example.com numbers: - external: '+198455501099' extension: '1099' routingPrefix: '1234' esn: '12341099' primary: true - id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS83MGY2MzYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc3OGg lastName: Alice firstName: Smith displayName: AliceSmith type: VIRTUAL_LINE numbers: - external: '+19075552859' extension: '8083' routingPrefix: '1234' esn: '12348083' primary: 'true' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Receptionist Client Settings for a Person operationId: Read Receptionist Client Settings for a Person description: 'Retrieve a person''s Receptionist Client settings. To help support the needs of your front-office personnel, you can set up people, workspaces or virtual lines as telephone attendants so that they can screen all incoming calls to certain numbers within your organization. This API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Receptionist Client Settings for a Person operationId: Configure Receptionist Client Settings for a Person description: 'Configure a person''s Receptionist Client settings. To help support the needs of your front-office personnel, you can set up people, workspaces or virtual lines as telephone attendants so that they can screen all incoming calls to certain numbers within your organization. This API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: receptionEnabled: true monitoredMembers: - Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MWU3MDlkNy1hM2IxLTQ2MDctOTBiOC04NmE5MDgxYWFkNmE - Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jMTQzMzhkNS02YTdjLTRiZjYtOTFiMS0zYmM2ZWMzMGJiMTE - Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS83MGY2MzYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc3OGg schema: $ref: '#/components/schemas/ReceptionPut' /people/{personId}/features/schedules: get: responses: '200': description: OK headers: Link: schema: type: string content: application/json: schema: $ref: '#/components/schemas/ScheduleCollectionResponse' example: schedules: - id: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ name: Dallas_Office_Hours type: businessHours level: LOCATION '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List of Schedules for a Person operationId: List of Schedules for a Person description: 'List schedules for a person in an organization. Schedules are used to support calling features and can be defined at the location or person level. `businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events. This API requires a full, user, or read-only administrator auth token with a scope of `spark-admin:people_read`.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: start in: query description: Specifies the offset from the first result that you want to fetch. example: '0' schema: type: number - name: max in: query description: Specifies the maximum number of records that you want to fetch. example: '100' schema: type: number default: 2000 - name: name in: query description: Specifies the case insensitive substring to be matched against the schedule names. The maximum length is 40. example: dallas schema: type: string default: 'null' - name: type in: query description: Specifies the schedule event type to be matched on the given type. example: businessHours schema: type: string default: 'null' post: responses: '201': description: Created headers: {} content: application/json: schema: $ref: '#/components/schemas/ScheduleResponseWithId' example: id: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create Schedule for a Person operationId: Create Schedule for a Person description: 'Create a new schedule for a person. Schedules are used to support calling features and can be defined at the location or person level. `businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events. This API requires a full or user administrator auth token with the `spark-admin:people_write` scope.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: name: Dallas_Office_Hours type: businessHours events: - name: Day_Shift startDate: '2020-03-18' endDate: '2020-03-18' startTime: 08:00 endTime: '17:00' allDayEnabled: false recurrence: recurForEver: true recurEndDate: '2020-03-18' recurEndOccurrence: 1 recurDaily: recurInterval: 1 recurWeekly: recurInterval: 1 sunday: false monday: false tuesday: false wednesday: true thursday: false friday: false saturday: false schema: $ref: '#/components/schemas/ScheduleCollectionRequest' /people/{personId}/features/schedules/{scheduleType}/{scheduleId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ScheduleLongDetails' example: id: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ name: Dallas_Office_Hours type: businessHours events: - name: Day_Shift startDate: '2020-03-18' endDate: '2020-03-18' startTime: 08:00 endTime: '17:00' allDayEnabled: false recurrence: recurForEver: true recurEndDate: '2020-03-18' recurEndOccurrence: 1 recurDaily: recurInterval: 1 recurWeekly: recurInterval: 1 sunday: false monday: false tuesday: false wednesday: true thursday: false friday: false saturday: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get a Schedule Details operationId: Get a Schedule Details description: 'Retrieve a schedule by its schedule ID. Schedules are used to support calling features and can be defined at the location or person level. `businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events. This API requires a full, user, or read-only administrator auth token with a scope of `spark-admin:people_read`.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: scheduleType in: path description: Type of schedule, either `businessHours` or `holidays`. required: true schema: type: string - name: scheduleId in: path description: Unique identifier for the schedule. required: true example: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SchedulePutResponseWithId' example: id: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvVW1samFHRnlaSE52Ymw5UFptWnBZMlZmU0c5MWNuTT0 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update a Schedule operationId: Update a Schedule description: 'Modify a schedule by its schedule ID. Schedules are used to support calling features and can be defined at the location or person level. `businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events. This API requires a full or user administrator auth token with the `spark-admin:people_write` scope.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: scheduleType in: path description: Type of schedule, either `businessHours` or `holidays`. required: true schema: type: string - name: scheduleId in: path description: Unique identifier for the schedule. required: true example: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ScheduleUpdateRequest' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete a Schedule operationId: Delete a Schedule description: 'Delete a schedule by its schedule ID. Schedules are used to support calling features and can be defined at the location or person level. `businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events. This API requires a full or user administrator auth token with the `spark-admin:people_write` scope.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: scheduleType in: path description: Type of schedule, either `businessHours` or `holidays`. required: true schema: type: string - name: scheduleId in: path description: Unique identifier for the schedule. required: true example: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /people/{personId}/features/schedules/{scheduleType}/{scheduleId}/events/{eventId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetEvent' example: id: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUkdGNVgxTm9hV1ow name: Day_Shift startDate: '2020-03-18' endDate: '2020-03-18' startTime: 08:00 endTime: '17:00' allDayEnabled: false recurrence: recurForEver: true recurEndDate: '2020-03-18' recurEndOccurrence: 1 recurDaily: recurInterval: 1 recurWeekly: recurInterval: 1 sunday: false monday: false tuesday: false wednesday: true thursday: false friday: false saturday: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Fetch Event for a person's Schedule operationId: Fetch Event for a person's Schedule description: 'People can use shared location schedules or define personal schedules containing events. `businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events. This API requires a full, user, or read-only administrator auth token with a scope of `spark-admin:people_read`.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: scheduleType in: path description: Type of schedule, either `businessHours` or `holidays`. required: true schema: type: string - name: scheduleId in: path description: Unique identifier for the schedule. required: true example: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ schema: type: string - name: eventId in: path description: Unique identifier for the event. required: true example: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUkdGNVgxTm9hV1ow schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/EventPutResponseWithId' example: id: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUTJWdWRISmhiRjlhYjI1bFgwUmhlVjlUYUdsbWRBPT0 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update an Event for a person's Schedule operationId: Update an Event for a person's Schedule description: 'People can use shared location schedules or define personal schedules containing events. `businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events. This API requires a full or user administrator auth token with the `spark-admin:people_write` scope.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: scheduleType in: path description: Type of schedule, either `businessHours` or `holidays`. required: true schema: type: string - name: scheduleId in: path description: Unique identifier for the schedule. required: true example: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ schema: type: string - name: eventId in: path description: Unique identifier for the event. required: true example: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUkdGNVgxTm9hV1ow schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: newName: Central_Zone_Day_Shift name: Day_Shift startDate: '2020-03-18' endDate: '2020-03-18' startTime: 08:00 endTime: '17:00' allDayEnabled: false recurrence: recurForEver: true recurEndDate: '2020-03-18' recurEndOccurrence: 1 recurDaily: recurInterval: 1 recurWeekly: recurInterval: 1 sunday: false monday: false tuesday: false wednesday: true thursday: false friday: false saturday: false schema: $ref: '#/components/schemas/PutEvent' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete an Event for a person's Schedule operationId: Delete an Event for a person's Schedule description: 'People can use shared location schedules or define personal schedules containing events. `businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events. This API requires a full or user administrator auth token with the `spark-admin:people_write` scope.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: scheduleType in: path description: Type of schedule, either `businessHours` or `holidays`. required: true schema: type: string - name: scheduleId in: path description: Unique identifier for the schedule. required: true example: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ schema: type: string - name: eventId in: path description: Unique identifier for the event. required: true example: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUkdGNVgxTm9hV1ow schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /people/{personId}/features/schedules/{scheduleType}/{scheduleId}/events: post: responses: '201': description: Created headers: {} content: application/json: schema: $ref: '#/components/schemas/EventResponseWithId' example: id: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUkdGNVgxTm9hV1ow '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Add a New Event for Person's Schedule operationId: Add a New Event for Person's Schedule description: 'People can use shared location schedules or define personal schedules containing events. `businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events. This API requires a full or user administrator auth token with the `spark-admin:people_write` scope.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: scheduleType in: path description: Type of schedule, either `businessHours` or `holidays`. required: true schema: type: string - name: scheduleId in: path description: Unique identifier for the schedule. required: true example: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: name: Day_Shift startDate: '2020-03-18' endDate: '2020-03-18' startTime: 08:00 endTime: '17:00' allDayEnabled: false recurrence: recurForEver: true recurEndDate: '2020-03-18' recurEndOccurrence: 1 recurDaily: recurInterval: 1 recurWeekly: recurInterval: 1 sunday: false monday: false tuesday: false wednesday: true thursday: false friday: false saturday: false schema: $ref: '#/components/schemas/EventLongDetails' /people/{personId}/features/voicemail: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/VoicemailInfo' example: enabled: true sendAllCalls: enabled: true sendBusyCalls: enabled: false greeting: DEFAULT greetingUploaded: false sendUnansweredCalls: enabled: false greeting: DEFAULT greetingUploaded: true numberOfRings: 3 systemMaxNumberOfRings: 20 notifications: enabled: true destination: julie@example.com transferToNumber: enabled: false emailCopyOfMessage: enabled: false emailId: julie@example.com messageStorage: mwiEnabled: true storageType: INTERNAL externalEmail: julia@example.com faxMessage: enabled: false voiceMessageForwardingEnabled: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read Voicemail Settings for a Person operationId: Read Voicemail Settings for a Person description: 'Retrieve a person''s Voicemail settings. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. Voicemail audio is sent in Waveform Audio File Format, `.wav`, format. Optionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files. This API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read` or a user auth token with `spark:people_read` scope can be used by a person to read their settings.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Voicemail Settings for a Person operationId: Configure Voicemail Settings for a Person description: 'Configure a person''s Voicemail settings. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. Voicemail audio is sent in Waveform Audio File Format, `.wav`, format. Optionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files. This API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope or a user auth token with `spark:people_write` scope can be used by a person to update their settings.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: enabled: true notifications: enabled: true destination: julie@example.com sendAllCalls: enabled: true sendBusyCalls: enabled: false greeting: DEFAULT sendUnansweredCalls: enabled: false greeting: CUSTOM numberOfRings: 3 transferToNumber: enabled: false emailCopyOfMessage: enabled: false emailId: julie@example.com schema: $ref: '#/components/schemas/VoicemailPut' /people/{personId}/features/voicemail/actions/uploadBusyGreeting/invoke: post: responses: '201': description: Created headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure Busy Voicemail Greeting for a Person operationId: Configure Busy Voicemail Greeting for a Person description: 'Configure a person''s Busy Voicemail Greeting by uploading a Waveform Audio File Format, `.wav`, encoded audio file. Your request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type. This API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope or a user auth token with `spark:people_write` scope can be used by a person to update their settings.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /people/{personId}/features/voicemail/actions/uploadNoAnswerGreeting/invoke: post: responses: '201': description: Created headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Configure No Answer Voicemail Greeting for a Person operationId: Configure No Answer Voicemail Greeting for a Person description: 'Configure a person''s No Answer Voicemail Greeting by uploading a Waveform Audio File Format, `.wav`, encoded audio file. Your request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type. This API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope or a user auth token with `spark:people_write` scope can be used by a person to update their settings.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /people/{personId}/features/voicemail/actions/resetPin/invoke: post: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Reset Voicemail PIN operationId: Reset Voicemail PIN description: 'Reset a voicemail PIN for a person. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. A voicemail PIN is used to retrieve your voicemail messages. This API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope. **NOTE**: This API is expected to have an empty request body and Content-Type header should be set to `application/json`.' tags: - User Call Settings (1/2) parameters: - name: personId in: path description: Unique identifier for the person. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: {} schema: type: object properties: {} components: schemas: PeopleOrPlaceOrVirtualLineType: type: string enum: - PEOPLE - PLACE - VIRTUAL_LINE description: " * `PEOPLE` - Person or list of people.\n * `PLACE` - Workspace that is not assigned to a specific person such as for a shared device in a common area.\n * `VIRTUAL_LINE` - Virtual line or list of virtual lines.\n" CallForwardingPut: type: object properties: callForwarding: type: object properties: always: type: object required: - enabled properties: enabled: type: boolean example: true description: '"Always" call forwarding is enabled or disabled.' destination: type: string example: '2225551212' description: Destination for "Always" call forwarding. ringReminderEnabled: type: boolean description: If `true`, a brief tone will be played on the virtual line's phone when a call has been forwarded. destinationVoicemailEnabled: type: boolean description: Enables and disables sending incoming calls to voicemail when the destination is an internal phone number and that number has the voicemail service enabled. description: Settings for forwarding all incoming calls to the destination you choose. busy: type: object properties: enabled: type: boolean example: true description: '"Busy" call forwarding is enabled or disabled.' destination: type: string example: '2225551212' description: Destination for "Busy" call forwarding. destinationVoicemailEnabled: type: boolean description: Enables and disables sending incoming to the destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled. description: Settings for forwarding all incoming calls to the destination you chose while the phone is in use or the virtual line is busy. noAnswer: type: object properties: enabled: type: boolean example: true description: '"No Answer" call forwarding is enabled or disabled.' destination: type: string example: '2225551212' description: Destination for "No Answer" call forwarding. numberOfRings: type: number example: 3 description: Number of rings before the call will be forwarded if unanswered. `numberOfRings` must be between 2 and 20, inclusive. destinationVoicemailEnabled: type: boolean description: Enables and disables sending incoming to destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled. description: Settings for forwarding which only occurs when you are away or not answering your phone. description: Settings related to "Always", "Busy", and "No Answer" call forwarding. businessContinuity: type: object properties: enabled: type: boolean example: true description: Business Continuity is enabled or disabled. destination: type: string example: '2225551212' description: Destination for Business Continuity. destinationVoicemailEnabled: type: boolean description: Enables and disables sending incoming to destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled. description: Settings for sending calls to a destination of your choice if your phone is not connected to the network for any reason, such as a power outage, failed Internet connection, or wiring problem. EventResponseWithId: type: object required: - id properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUkdGNVgxTm9hV1ow description: Identifier for a event. ReceptionPut: type: object required: - receptionEnabled properties: receptionEnabled: type: boolean example: true description: '`true` if the Receptionist Client feature is enabled.' monitoredMembers: type: array items: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MWU3MDlkNy1hM2IxLTQ2MDctOTBiOC04NmE5MDgxYWFkNmE description: List of members' unique identifiers to monitor. MonitoredMemberObject: type: object required: - id - lastName - firstName - displayName - type properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MWU3MDlkNy1hM2IxLTQ2MDctOTBiOC04NmE5MDgxYWFkNmE description: Unique identifier of the person, workspace or virtual line to be monitored. lastName: type: string example: Little description: Last name of the monitored person, workspace or virtual line. firstName: type: string example: Alice description: First name of the monitored person, workspace or virtual line. displayName: type: string example: Alice Little description: Display name of the monitored person, workspace or virtual line. type: $ref: '#/components/schemas/PeopleOrPlaceOrVirtualLineType' description: Indicates whether type is person, workspace or virtual line. email: type: string example: alice@example.com description: Email address of the monitored person, workspace or virtual line. numbers: type: array items: $ref: '#/components/schemas/MonitoredNumberObject' description: List of phone numbers of the monitored person, workspace or virtual line. DirectLineCallerIdNameObject: type: object properties: selection: $ref: '#/components/schemas/SelectionObject' description: The selection of the direct line caller ID name. Defaults to `DISPLAY_NAME`. customName: type: string example: Hakim Smith description: The custom direct line caller ID name. Required if `selection` is set to `CUSTOM_NAME`. description: Settings for the direct line caller ID name to be shown for this workspace. HotelingInfo: type: object required: - enabled properties: enabled: type: boolean example: true description: When `true`, allow this person to connect to a Hoteling host device. PushToTalkNumberObject: type: object properties: external: type: string example: '+19845551088' description: External phone number of the person. extension: type: string example: '1088' description: Extension number of the person. routingPrefix: type: string example: '1234' description: Routing prefix of location. esn: type: string example: '12341088' description: Routing prefix + extension of a person or workspace. primary: type: boolean example: true description: If `true`, specifies whether the phone number is primary number. CallWaitingInfo: type: object required: - enabled properties: enabled: type: boolean example: true description: '`true` if the Call Waiting feature is enabled.' GetCallingBehaviorObject: type: object required: - behaviorType - effectiveBehaviorType - profileId properties: behaviorType: type: string enum: - NATIVE_WEBEX_TEAMS_CALLING - CALL_WITH_APP_REGISTERED_FOR_CISCOTEL - CALL_WITH_APP_REGISTERED_FOR_TEL - CALL_WITH_APP_REGISTERED_FOR_WEBEXCALLTEL - NATIVE_SIP_CALL_TO_UCM - 'null' description: "The current Calling Behavior setting for the person. If `null`, the effective Calling Behavior will be the Organization's current default.\n * `NATIVE_WEBEX_TEAMS_CALLING` - Calling in Webex or Hybrid Calling.\n * `CALL_WITH_APP_REGISTERED_FOR_CISCOTEL` - Cisco Jabber app\n * `CALL_WITH_APP_REGISTERED_FOR_TEL` - Third-Party app\n * `CALL_WITH_APP_REGISTERED_FOR_WEBEXCALLTEL` - Webex Calling app\n * `NATIVE_SIP_CALL_TO_UCM` - Calling in Webex (Unified CM)\n * `null` - Using the non-string value of `null` results in the organization-wide default calling behavior being in effect.\n" effectiveBehaviorType: type: string enum: - NATIVE_WEBEX_TEAMS_CALLING - CALL_WITH_APP_REGISTERED_FOR_CISCOTEL - CALL_WITH_APP_REGISTERED_FOR_TEL - CALL_WITH_APP_REGISTERED_FOR_WEBEXCALLTEL - NATIVE_SIP_CALL_TO_UCM description: "The effective Calling Behavior setting for the person, will be the organization's default Calling Behavior if the user's `behaviorType` is set to `null`.\n * `NATIVE_WEBEX_TEAMS_CALLING` - Calling in Webex or Hybrid Calling.\n * `CALL_WITH_APP_REGISTERED_FOR_CISCOTEL` - Cisco Jabber app\n * `CALL_WITH_APP_REGISTERED_FOR_TEL` - Third-Party app\n * `CALL_WITH_APP_REGISTERED_FOR_WEBEXCALLTEL` - Webex Calling app\n * `NATIVE_SIP_CALL_TO_UCM` - Calling in Webex (Unified CM)\n" profileId: type: string example: Y2lzY29zcGFyazovL3VzL0NBTExJTkdfUFJPRklMRS9iMzdmMmZiYS0yZTdjLTExZWItYTM2OC1kYmU0Yjc2NzFmZTk description: The UC Manager Profile ID. PutEvent: type: object required: - newName - name - startDate - endDate - startTime - endTime properties: newName: type: string example: Central_Zone_Day_Shift description: New name for the event. name: type: string example: Day_Shift description: Name for the event. startDate: type: string example: '2020-03-18' description: Start date of the event, or first occurrence if repeating, in the format of YYYY-MM-DD. This field is required if the `allDayEnabled` field is present. endDate: type: string example: '2020-03-18' description: End date of the event, or first occurrence if repeating, in the format of YYYY-MM-DD. This field is required if the `allDayEnabled` field is present. startTime: type: string example: 08:00 description: Start time of the event in the format of HH:MM (24 hours format). This field is required if the `allDayEnabled` field is false or omitted. endTime: type: string example: '17:00' description: End time of the event in the format of HH:MM (24 hours format). This field is required if the `allDayEnabled` field is false or omitted. allDayEnabled: type: boolean description: True if it is all-day event. recurrence: type: object properties: recurForEver: type: boolean example: true description: True if the event repeats forever. Requires either `recurDaily` or `recurWeekly` to be specified. recurEndDate: type: string example: '2020-03-18' description: End date for the recurring event in the format of YYYY-MM-DD. Requires either `recurDaily` or `recurWeekly` to be specified. recurEndOccurrence: type: number example: 1 description: End recurrence after the event has repeated the specified number of times. Requires either `recurDaily` or `recurWeekly` to be specified. recurDaily: type: object required: - recurInterval properties: recurInterval: type: number example: 1 description: Recurring interval in days. The number of days after the start when an event will repeat. Repetitions cannot overlap. description: Specifies the number of days between the start of each recurrence and is not allowed with `recurWeekly`. recurWeekly: type: object required: - recurInterval properties: recurInterval: type: number example: 1 description: Specifies the number of weeks between the start of each recurrence. sunday: type: boolean description: The Event occurs weekly on Sunday. monday: type: boolean description: The Event occurs weekly on Monday. tuesday: type: boolean description: The Event occurs weekly on Tuesday. wednesday: type: boolean example: true description: The Event occurs weekly on Wednesday. thursday: type: boolean description: The Event occurs weekly on Thursday. friday: type: boolean description: The Event occurs weekly on Friday. saturday: type: boolean description: The Event occurs weekly on Saturday. description: Specifies the event recurs weekly on the designated days of the week and is not allowed with `recurDaily`. description: Recurrance scheme for an event. PatchCallingBehaviorObject: type: object properties: behaviorType: type: string enum: - NATIVE_WEBEX_TEAMS_CALLING - CALL_WITH_APP_REGISTERED_FOR_CISCOTEL - CALL_WITH_APP_REGISTERED_FOR_TEL - CALL_WITH_APP_REGISTERED_FOR_WEBEXCALLTEL - NATIVE_SIP_CALL_TO_UCM - 'null' description: "The new Calling Behavior setting for the person (case-insensitive). If `null`, the effective Calling Behavior will be the Organization's current default.\n * `NATIVE_WEBEX_TEAMS_CALLING` - Calling in Webex or Hybrid Calling.\n * `CALL_WITH_APP_REGISTERED_FOR_CISCOTEL` - Cisco Jabber app\n * `CALL_WITH_APP_REGISTERED_FOR_TEL` - Third-Party app\n * `CALL_WITH_APP_REGISTERED_FOR_WEBEXCALLTEL` - Webex Calling app\n * `NATIVE_SIP_CALL_TO_UCM` - Calling in Webex (Unified CM)\n * `null` - The non-string value of `null` results in the organization-wide default calling behavior being in effect.\n" profileId: type: string example: Y2lzY29zcGFyazovL3VzL0NBTExJTkdfUFJPRklMRS9iMzdmMmZiYS0yZTdjLTExZWItYTM2OC1kYmU0Yjc2NzFmZTk description: The UC Manager Profile ID. Specifying null results in the organizational default being applied. In addition, when `behaviorType` is set to `CALL_WITH_APP_REGISTERED_FOR_CISCOTEL`, then the profile ID value will be cleared irrespective of any value being passed. PushToTalkInfo: type: object required: - allowAutoAnswer - connectionType - accessType properties: allowAutoAnswer: type: boolean example: true description: Set to `true` to enable the Push-to-Talk feature. When enabled, a workspace receives a Push-to-Talk call and answers the call automatically. connectionType: $ref: '#/components/schemas/PushToTalkConnectionType' description: Specifies the connection type to be used. accessType: $ref: '#/components/schemas/PushToTalkAccessType' description: Specifies the access type to be applied when evaluating the member list. members: type: array items: $ref: '#/components/schemas/MonitoredPersonObject' description: List of people/workspaces that are allowed or disallowed to interact using the Push-to-Talk feature. PushToTalkConnectionType: type: string enum: - ONE_WAY - TWO_WAY description: " * `ONE_WAY` - Push-to-Talk initiators can chat with this workspace but only in one direction. The workspace you enable Push-to-Talk for cannot respond.\n * `TWO_WAY` - Push-to-Talk initiators can chat with this workspace in a two-way conversation. The workspace you enable Push-to-Talk for can respond.\n" GetMonitoredElementsObject: type: object properties: member: type: object required: - id - lastName - firstName - displayName - numbers - location - locationId properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OWNlZjRmYS03YTM5LTQ1ZDItOTNmNi1jNjA5YTRiMjgzODY description: The identifier of the monitored person, workspace or virtual line. lastName: type: string example: Nelson description: The last name of the monitored person, workspace or virtual line. firstName: type: string example: John description: The first name of the monitored person, workspace or virtual line. displayName: type: string example: John Nelson description: The display name of the monitored person, workspace or virtual line. type: $ref: '#/components/schemas/PeopleOrPlaceOrVirtualLineType' description: Indicates whether the type is `PEOPLE`, `PLACE` or `VIRTUAL_LINE`. email: type: string example: john.nelson@gmail.com description: The email address of the monitored person. numbers: type: array items: $ref: '#/components/schemas/MonitoredNumberObject' description: The list of phone numbers containing only the primary number for the monitored person, workspace, or virtual line. location: type: string example: Dallas description: The name of the location where the monitored person, workspace, or virtual line is situated. locationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzZhZjk4ZGViLWVlZGItNGFmYi1hMDAzLTEzNzgyYjdjODAxYw description: The ID for the location. callparkextension: type: object required: - id - location - locationId properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NBTExfUEFSS19FWFRFTlNJT04vZTdlZDdiMDEtN2E4Ni00NDEwLWFlODMtOWJmODMzZGEzNzQy description: The identifier of the call park extension. name: type: string example: Dallas-Test description: The name used to describe the call park extension. extension: type: string example: '4001' description: The extension number for the call park extension. routingPrefix: type: string example: '1234' description: Routing prefix of location. esn: type: string example: '12344001' description: Routing prefix + extension of the call park extension. location: type: string example: Dallas description: The location name where the call park extension is. locationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzZhZjk4ZGViLWVlZGItNGFmYi1hMDAzLTEzNzgyYjdjODAxYw description: The ID for the location. CallInterceptInfo: type: object required: - enabled - incoming - outgoing properties: enabled: type: boolean example: true description: '`true` if call intercept is enabled.' incoming: type: object required: - type - voicemailEnabled - announcements properties: type: type: string enum: - INTERCEPT_ALL - ALLOW_ALL description: "`INTERCEPT_ALL` indicated incoming calls are intercepted.\n * `INTERCEPT_ALL` - Incoming calls are routed as the destination and voicemail specify.\n * `ALLOW_ALL` - Incoming calls are not intercepted.\n" voicemailEnabled: type: boolean description: If `true`, the destination will be the virtual line's voicemail. announcements: type: object required: - greeting - filename - newNumber - zeroTransfer properties: greeting: type: string enum: - CUSTOM - DEFAULT description: "`DEFAULT` indicates that a system default message will be placed when incoming calls are intercepted.\n * `CUSTOM` - A custom greeting is played when incoming calls are intercepted.\n * `DEFAULT` - A System default greeting will be played when incoming calls are intercepted.\n" filename: type: string example: incoming.wav description: Filename of custom greeting; will be an empty string if no custom greeting has been uploaded. newNumber: type: object properties: enabled: type: boolean example: true description: If `true`, the caller will hear this new number when the call is intercepted. destination: type: string example: '2225551212' description: New number caller will hear announced. description: Information about the new number announcement. zeroTransfer: type: object properties: enabled: type: boolean example: true description: If `true`, the caller will be transferred to destination of when zero (0) is pressed. destination: type: string example: '2225551212' description: Destination to which caller will be transferred when zero is pressed. description: Information about how the call will be handled if zero (0) is pressed. description: Settings related to how incoming calls are handled when the intercept feature is enabled. description: Settings related to how incoming calls are handled when the intercept feature is enabled. outgoing: type: object required: - type - transferEnabled properties: type: type: string enum: - INTERCEPT_ALL - ALLOW_LOCAL_ONLY description: "`INTERCEPT_ALL` indicated all outgoing calls are intercepted.\n * `INTERCEPT_ALL` - Outgoing calls are routed as the destination and voicemail specify.\n * `ALLOW_LOCAL_ONLY` - Only non-local calls are intercepted.\n" transferEnabled: type: boolean example: true description: If `true`, allows transfer and forwarding for the call type. destination: type: string example: '2225551212' description: Number to which the outbound call be transferred. description: Settings related to how outgoing calls are handled when the intercept feature is enabled. CallForwardingInfo: type: object required: - callForwarding - businessContinuity properties: callForwarding: type: object required: - always - busy - noAnswer properties: always: type: object required: - enabled - ringReminderEnabled - destinationVoicemailEnabled properties: enabled: type: boolean example: true description: '"Always" call forwarding is enabled or disabled.' destination: type: string example: '2225551212' description: Destination for "Always" call forwarding. ringReminderEnabled: type: boolean description: If `true`, a brief tone will be played on the virtual line's phone when a call has been forwarded. destinationVoicemailEnabled: type: boolean description: Indicates enabled or disabled state of sending incoming calls to voicemail when the destination is an internal phone number and that number has the voicemail service enabled. description: Settings for forwarding all incoming calls to the destination you choose. busy: type: object required: - enabled - destinationVoicemailEnabled properties: enabled: type: boolean example: true description: '"Busy" call forwarding is enabled or disabled.' destination: type: string example: '2225551212' description: Destination for "Busy" call forwarding. destinationVoicemailEnabled: type: boolean description: Indicates the enabled or disabled state of sending incoming calls to voicemail when the destination is an internal phone number and that number has the voicemail service enabled. description: Settings for forwarding all incoming calls to the destination you chose while the phone is in use or the virtual line is busy. noAnswer: type: object required: - enabled - numberOfRings - systemMaxNumberOfRings - destinationVoicemailEnabled properties: enabled: type: boolean example: true description: '"No Answer" call forwarding is enabled or disabled.' destination: type: string example: '2225551212' description: Destination for "No Answer" call forwarding. numberOfRings: type: number example: 3 description: Number of rings before the call will be forwarded if unanswered. systemMaxNumberOfRings: type: number example: 15 description: System-wide maximum number of rings allowed for `numberOfRings` setting. destinationVoicemailEnabled: type: boolean description: Indicates the enabled or disabled state of sending incoming calls to destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled. description: Settings for forwarding which only occurs when you are away or not answering your phone. description: Settings related to "Always", "Busy", and "No Answer" call forwarding. businessContinuity: type: object required: - enabled - destinationVoicemailEnabled properties: enabled: type: boolean example: true description: Business Continuity is enabled or disabled. destination: type: string example: '2225551212' description: Destination for Business Continuity. destinationVoicemailEnabled: type: boolean description: Indicates enabled or disabled state of sending incoming calls to the destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled. description: Settings for sending calls to a destination of your choice if your phone is not connected to the network for any reason, such as power outage, failed Internet connection, or wiring problem. GetEvent: type: object required: - id - name - startDate - endDate - startTime - endTime properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUkdGNVgxTm9hV1ow description: Identifier for a event. name: type: string example: Day_Shift description: Name for the event. startDate: type: string example: '2020-03-18' description: Start date of the event, or first occurrence if repeating, in the format of `YYYY-MM-DD`. This field is required if the `allDayEnabled` field is present. endDate: type: string example: '2020-03-18' description: End date of the event, or first occurrence if repeating, in the format of `YYYY-MM-DD`. This field is required if the `allDayEnabled` field is present. startTime: type: string example: 08:00 description: Start time of the event in the format of `HH:MM` (24 hours format). This field is required if the `allDayEnabled` field is false or omitted. endTime: type: string example: '17:00' description: End time of the event in the format of `HH:MM `(24 hours format). This field is required if the `allDayEnabled` field is false or omitted. allDayEnabled: type: boolean description: True if it is all-day event. recurrence: type: object properties: recurForEver: type: boolean example: true description: True if the event repeats forever. Requires either `recurDaily` or `recurWeekly` to be specified. recurEndDate: type: string example: '2020-03-18' description: End date for the recurring event in the format of `YYYY-MM-DD`. Requires either `recurDaily` or `recurWeekly` to be specified. recurEndOccurrence: type: number example: 1 description: End recurrence after the event has repeated the specified number of times. Requires either `recurDaily` or `recurWeekly` to be specified. recurDaily: type: object required: - recurInterval properties: recurInterval: type: number example: 1 description: Recurring interval in days. The number of days after the start when an event will repeat. Repetitions cannot overlap. description: Specifies the number of days between the start of each recurrence and is not allowed with `recurWeekly`. recurWeekly: type: object required: - recurInterval properties: recurInterval: type: number example: 1 description: Specifies the number of weeks between the start of each recurrence. sunday: type: boolean description: The Event occurs weekly on Sunday. monday: type: boolean description: The Event occurs weekly on Monday. tuesday: type: boolean description: The Event occurs weekly on Tuesday. wednesday: type: boolean example: true description: The Event occurs weekly on Wednesday. thursday: type: boolean description: The Event occurs weekly on Thursday. friday: type: boolean description: The Event occurs weekly on Friday. saturday: type: boolean description: The Event occurs weekly on Saturday. description: Specifies the event recur weekly on the designated days of the week and is not allowed with `recurDaily`. description: Recurrance scheme for an event. ScheduleUpdateRequest: type: object required: - newName - name - type properties: newName: type: string example: Richardson_Office_Hours description: New name for the schedule. name: type: string example: Dallas_Office_Hours description: Name for the schedule. type: $ref: '#/components/schemas/ScheduleType' description: The Schedule type whether `businessHours` or `holidays`. events: type: array items: $ref: '#/components/schemas/EventLongDetails' description: List of events. ScheduleLongDetails: type: object required: - id - name - type properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ description: Identifier for a schedule. name: type: string example: Dallas_Office_Hours description: Name for the schedule. type: $ref: '#/components/schemas/ScheduleType' description: The Schedule type whether `businessHours` or `holidays`. events: type: array items: $ref: '#/components/schemas/EventLongDetails' description: List of events. CallerIdPut: type: object required: - selected properties: selected: type: string enum: - DIRECT_LINE - LOCATION_NUMBER - CUSTOM description: "Which type of outgoing Caller ID will be used. This setting is for the number portion.\n * `DIRECT_LINE` - Outgoing caller ID will show the caller's direct line number.\n * `LOCATION_NUMBER` - Outgoing caller ID will show the main number for the location.\n * `CUSTOM` - Outgoing caller ID will show the value from the customNumber field.\n" customNumber: type: string example: '2025551212' description: Custom number which will be shown if CUSTOM is selected. This value must be a number from the virtual line's location or from another location with the same country, PSTN provider, and zone (only applicable for India locations) as the virtual line's location. firstName: type: string example: Hakim description: Virtual line's Caller ID first name. The characters `%`, `+`, ``, `"` and Unicode characters are not allowed. This field has been deprecated. Please use `directLineCallerIdName` and `dialByFirstName` instead. lastName: type: string example: Gonzales description: Virtual line's Caller ID last name. The characters `%`, `+`, ``, `"` and Unicode characters are not allowed. This field has been deprecated. Please use `directLineCallerIdName` and `dialByLastName` instead. blockInForwardCallsEnabled: type: boolean example: true description: Block this virtual line's identity when receiving a call. externalCallerIdNamePolicy: type: string enum: - DIRECT_LINE - LOCATION - OTHER description: "Designates which type of External Caller ID Name policy is used. Default is DIRECT_LINE.\n * `DIRECT_LINE` - Outgoing caller ID will show the caller's direct line name.\n * `LOCATION` - Outgoing caller ID will show the external caller ID name for the location.\n * `OTHER` - Outgoing caller ID will show the value from the `customExternalCallerIdName` field.\n" customExternalCallerIdName: type: string example: Hakim Custom description: Custom external caller ID name which will be shown if external caller ID name policy is `OTHER`. additionalExternalCallerIdDirectLineEnabled: type: boolean example: true description: Set the virtual line's direct line number as additional external caller ID. additionalExternalCallerIdLocationNumberEnabled: type: boolean description: Set the Location main number as additional external caller ID for the virtual line. additionalExternalCallerIdCustomNumber: type: string example: '2025552000' description: To set a custom number as additional external caller ID for the virtual line. This value must be a number from the virtual line's location or from another location with the same country, PSTN provider, and zone (only applicable for India locations) as the virtual line's location. directLineCallerIdName: $ref: '#/components/schemas/UserDirectLineCallerIdNameObject' description: Settings for the direct line caller ID name to be shown for this virtual line. dialByFirstName: type: string example: Hakim description: Sets or clears the first name to be used for dial-by-name functions. To clear the `dialByFirstName`, the attribute must be set to null or empty string. Characters of `%`, `+`, `\`, `"` and Unicode characters are not allowed. dialByLastName: type: string example: Smith description: Sets or clears the last name to be used for dial-by-name functions. To clear the `dialByLastName`, the attribute must be set to null or empty string. Characters of `%`, `+`, `\`, `"` and Unicode characters are not allowed. EventLongDetails: type: object required: - name - startDate - endDate - startTime - endTime properties: name: type: string example: Day_Shift description: Name for the event. startDate: type: string example: '2020-03-18' description: Start date of the event, or first occurrence if repeating, in the format of `YYYY-MM-DD`. This field is required if the `allDayEnabled` field is present. endDate: type: string example: '2020-03-18' description: End date of the event, or first occurrence if repeating, in the format of `YYYY-MM-DD`. This field is required if the `allDayEnabled` field is present. startTime: type: string example: 08:00 description: Start time of the event in the format of `HH:MM` (24 hours format). This field is required if the `allDayEnabled` field is false or omitted. endTime: type: string example: '17:00' description: End time of the event in the format of `HH:MM` (24 hours format). This field is required if the `allDayEnabled` field is false or omitted. allDayEnabled: type: boolean description: True if it is all-day event. recurrence: type: object properties: recurForEver: type: boolean example: true description: True if the event repeats forever. Requires either `recurDaily` or `recurWeekly` to be specified. recurEndDate: type: string example: '2020-03-18' description: End date for the recurring event in the format of `YYYY-MM-DD`. Requires either `recurDaily` or `recurWeekly` to be specified. recurEndOccurrence: type: number example: 1 description: End recurrence after the event has repeated the specified number of times. Requires either `recurDaily` or `recurWeekly` to be specified. recurDaily: type: object required: - recurInterval properties: recurInterval: type: number example: 1 description: Recurring interval in days. The number of days after the start when an event will repeat. Repetitions cannot overlap. description: Specifies the number of days between the start of each recurrence. Not allowed with `recurWeekly`. recurWeekly: type: object required: - recurInterval properties: recurInterval: type: number example: 1 description: Specifies the number of weeks between the start of each recurrence. sunday: type: boolean description: The Event occurs weekly on Sunday. monday: type: boolean description: The Event occurs weekly on Monday. tuesday: type: boolean description: The Event occurs weekly on Tuesday. wednesday: type: boolean example: true description: The Event occurs weekly on Wednesday. thursday: type: boolean description: The Event occurs weekly on Thursday. friday: type: boolean description: The Event occurs weekly on Friday. saturday: type: boolean description: The Event occurs weekly on Saturday. description: Specifies the event recur weekly on the designated days of the week. Not allowed with `recurDaily`. description: Recurrence scheme for an event. BargeInInfo: type: object required: - enabled - toneEnabled properties: enabled: type: boolean example: true description: Indicates if the Barge In feature is enabled. toneEnabled: type: boolean description: Indicates that a stutter dial tone will be played when a virtual line is barging in on the active call. CallerIdInfo: type: object required: - types - selected - tollFreeLocationNumber - firstName - lastName - blockInForwardCallsEnabled - locationExternalCallerIdName properties: types: type: array items: $ref: '#/components/schemas/CallerIdSelectedType' description: Allowed types for the `selected` field. This field is read-only and cannot be modified. selected: type: string enum: - DIRECT_LINE - LOCATION_NUMBER - CUSTOM description: "Which type of outgoing Caller ID will be used. This setting is for the number portion.\n * `DIRECT_LINE` - Outgoing caller ID will show the caller's direct line number.\n * `LOCATION_NUMBER` - Outgoing caller ID will show the main number for the location.\n * `CUSTOM` - Outgoing caller ID will show the value from the customNumber field.\n" directNumber: type: string example: '2025551212' description: Direct number which will be shown if `DIRECT_LINE` is selected. extensionNumber: type: string example: '3456' description: Extension number of the virtual line. locationNumber: type: string example: '2025551212' description: Location number which will be shown if `LOCATION_NUMBER` is selected. tollFreeLocationNumber: type: boolean description: Flag to indicate if the location number is toll-free number. customNumber: type: string example: '2025551212' description: Custom number which will be shown if CUSTOM is selected. This value must be a number from the virtual line's location or from another location with the same country, PSTN provider, and zone (only applicable for India locations) as the virtual line's location. firstName: type: string example: Hakim description: Virtual line's Caller ID first name. The characters `%`, `+`, ``, `"` and Unicode characters are not allowed. This field has been deprecated. Please use `directLineCallerIdName` and `dialByFirstName` instead. lastName: type: string example: Gonzales description: Virtual line's Caller ID last name. The characters `%`, `+`, ``, `"` and Unicode characters are not allowed. This field has been deprecated. Please use `directLineCallerIdName` and `dialByLastName` instead. blockInForwardCallsEnabled: type: boolean example: true description: Block this virtual line's identity when receiving a call. externalCallerIdNamePolicy: type: string enum: - DIRECT_LINE - LOCATION - OTHER description: "Designates which type of External Caller ID Name policy is used. Default is `DIRECT_LINE`.\n * `DIRECT_LINE` - Outgoing caller ID will show the caller's direct line name.\n * `LOCATION` - Outgoing caller ID will show the external caller ID name for the location.\n * `OTHER` - Outgoing caller ID will show the value from the `customExternalCallerIdName` field.\n" customExternalCallerIdName: type: string example: Hakim custom description: Custom external caller ID name which will be shown if external caller ID name policy is `OTHER`. locationExternalCallerIdName: type: string example: Hakim location description: Location's external caller ID name which will be shown if external caller ID name policy is `LOCATION`. additionalExternalCallerIdDirectLineEnabled: type: boolean example: true description: Flag to indicate the virtual line's direct line number is available as an additional external caller ID for the virtual line. additionalExternalCallerIdLocationNumberEnabled: type: boolean description: Flag to indicate the location main number is available as an additional external caller ID for the virtual line. additionalExternalCallerIdCustomNumber: type: string example: '2025552000' description: The custom number available as an additional external caller ID for the virtual line. This value must be a number from the virtual line's location or from another location with the same country, PSTN provider, and zone (only applicable for India locations) as the virtual line's location. directLineCallerIdName: $ref: '#/components/schemas/DirectLineCallerIdNameObject' description: Settings for the direct line caller ID name to be shown for this virtual line. dialByFirstName: type: string example: Hakim description: The first name to be used for dial-by-name functions. dialByLastName: type: string example: Smith description: The last name to be used for dial-by-name functions. ScheduleShortDetails: type: object required: - id - name - type properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ description: Identifier for a schedule. name: type: string example: Dallas_Office_Hours description: Name for the schedule. type: $ref: '#/components/schemas/ScheduleType' description: The Schedule type whether `businessHours` or `holidays`. level: $ref: '#/components/schemas/ScheduleLevel' description: The Schedule level whether `LOCATION` or `PEOPLE`. OutgoingCallingPermissionsSettingPut: type: object required: - callingPermissions properties: useCustomEnabled: type: boolean example: true description: When true, indicates that this user uses the shared control that applies to all outgoing call settings categories when placing outbound calls. useCustomPermissions: type: boolean example: true description: When true, indicates that this user uses the specified outgoing calling permissions when placing outbound calls. callingPermissions: type: array items: type: object required: - transferEnabled properties: callType: type: string enum: - INTERNAL_CALL - TOLL_FREE - INTERNATIONAL - OPERATOR_ASSISTED - CHARGEABLE_DIRECTORY_ASSISTED - SPECIAL_SERVICES_I - SPECIAL_SERVICES_II - PREMIUM_SERVICES_I - PREMIUM_SERVICES_II - NATIONAL description: "Designates the action to be taken for each call type and if transferring the call type is allowed.\n * `INTERNAL_CALL` - Controls calls within your own company.\n * `TOLL_FREE` - Controls calls to a telephone number that is billed for all arriving calls instead of incurring charges to the originating caller, usually free of charge from a landline.\n * `INTERNATIONAL` - Controls calls to locations outside of the Long Distance areas that require an international calling code before the number is dialed.\n * `OPERATOR_ASSISTED` - Controls calls requiring Operator Assistance.\n * `CHARGEABLE_DIRECTORY_ASSISTED` - Controls calls to Directory Assistant companies that require a charge to connect the call.\n * `SPECIAL_SERVICES_I` - Controls calls to carrier-specific number assignments to special services or destinations.\n * `SPECIAL_SERVICES_II` - Controls calls to carrier-specific number assignments to special services or destinations.\n * `PREMIUM_SERVICES_I` - Controls calls used to provide information or entertainment for a fee charged directly to the caller.\n * `PREMIUM_SERVICES_II` - Controls calls used to provide information or entertainment for a fee charged directly to the caller.\n * `NATIONAL` - Controls calls that are within your country of origin, both within and outside of your local area code.\n" action: type: string enum: - ALLOW - BLOCK - AUTH_CODE - TRANSFER_NUMBER_1 - TRANSFER_NUMBER_2 - TRANSFER_NUMBER_3 description: "Action on the given `callType`.\n * `ALLOW` - Allow the designated call type.\n * `BLOCK` - Block the designated call type.\n * `AUTH_CODE` - Allow only via Authorization Code.\n * `TRANSFER_NUMBER_1` - Transfer to Auto Transfer Number 1. The answering virtual line can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_2` - Transfer to Auto Transfer Number 2. The answering virtual line can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_3` - Transfer to Auto Transfer Number 3. The answering virtual line can then approve the call and send it through or reject the call.\n" transferEnabled: type: boolean description: Allow the virtual line to transfer or forward a call of the specified call type. description: Specifies the outbound calling permissions settings. BargeInPut: type: object properties: enabled: type: boolean example: true description: Set to enable or disable the Barge In feature. toneEnabled: type: boolean description: Set to enable or disable a stutter dial tone being played when a virtual line is barging in on the active call. ReceptionInfo: type: object required: - receptionEnabled properties: receptionEnabled: type: boolean example: true description: Set to `true` to enable the Receptionist Client feature. monitoredMembers: type: array items: $ref: '#/components/schemas/MonitoredMemberObject' description: List of people, workspaces or virtual lines to monitor. ScheduleType: type: string enum: - businessHours - holidays description: " * `businessHours` - The schedule type that specifies the business or working hours during the day.\n * `holidays` - The schedule type that specifies the day when your organization is not open.\n" DoNotDisturbPut: type: object required: - webexGoOverrideEnabled properties: enabled: type: boolean example: true description: '`true` if the Do Not Disturb feature is enabled.' ringSplashEnabled: type: boolean description: Enables a Ring Reminder to play a brief tone on your desktop phone when you receive incoming calls. webexGoOverrideEnabled: type: boolean description: '`true` if a mobile device will still ring even if Do Not Disturb is enabled.' MonitoredPersonObject: type: object properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MWU3MDlkNy1hM2IxLTQ2MDctOTBiOC04NmE5MDgxYWFkNmE description: Unique identifier of the person. lastName: type: string example: Little description: Last name of the person. firstName: type: string example: Alice description: First name of the person. displayName: type: string example: Alice Little description: Display name of the person. type: $ref: '#/components/schemas/PeopleOrPlaceOrVirtualLineType' description: Type usually indicates `PEOPLE`, `PLACE` or `VIRTUAL_LINE`. Push-to-Talk and Privacy features only supports `PEOPLE`. email: type: string example: alice@example.com description: Email address of the person. numbers: type: array items: $ref: '#/components/schemas/PushToTalkNumberObject' description: List of phone numbers of the person. CallInterceptPut: type: object properties: enabled: type: boolean example: true description: '`true` if the intercept feature is enabled.' incoming: type: object properties: type: type: string enum: - INTERCEPT_ALL - ALLOW_ALL description: "`INTERCEPT_ALL` indicated incoming calls are intercepted.\n * `INTERCEPT_ALL` - Incoming calls are routed as the destination and voicemail specify.\n * `ALLOW_ALL` - Incoming calls are not intercepted.\n" voicemailEnabled: type: boolean description: If `true`, the destination will be the virtual line's voicemail. announcements: type: object properties: greeting: type: string enum: - CUSTOM - DEFAULT description: "`DEFAULT` indicates that a system default message will be placed when incoming calls are intercepted.\n * `CUSTOM` - A custom greeting is played when incoming calls are intercepted.\n * `DEFAULT` - A System default greeting is played when incoming calls are intercepted.\n" newNumber: type: object properties: enabled: type: boolean example: true description: If `true`, the caller will hear this new number when a call is intercepted. destination: type: string example: '2225551212' description: New number caller will hear announced. description: Information about the new number announcement. zeroTransfer: type: object properties: enabled: type: boolean example: true description: If `true`, the caller will be transferred to destination of when zero (0) is pressed. destination: type: string example: '2225551212' description: Destination to which caller will be transferred when zero is pressed. description: Information about how call will be handled if zero (0) is pressed. description: Settings related to how incoming calls are handled when the intercept feature is enabled. description: Settings related to how incoming calls are handled when the intercept feature is enabled. outgoing: type: object properties: type: type: string enum: - INTERCEPT_ALL - ALLOW_LOCAL_ONLY description: "`INTERCEPT_ALL` indicated all outgoing calls are intercepted.\n * `INTERCEPT_ALL` - Outgoing calls are routed as the destination and voicemail specify.\n * `ALLOW_LOCAL_ONLY` - Only non-local calls are intercepted.\n" transferEnabled: type: boolean example: true description: If `true`, allows transfer and forwarding for the call type. destination: type: string example: '2225551212' description: Number to which the outbound call will be transferred. description: Settings related to how outgoing calls are handled when the intercept feature is enabled. PushToTalkAccessType: type: string enum: - ALLOW_MEMBERS - BLOCK_MEMBERS description: " * `ALLOW_MEMBERS` - List of people/workspaces that are allowed to use the Push-to-Talk feature to interact with the workspace being configured.\n * `BLOCK_MEMBERS` - List of people/workspaces that are disallowed to interact using the Push-to-Talk feature with the workspace being configured.\n" VoicemailPut: type: object required: - notifications - transferToNumber properties: enabled: type: boolean example: true description: Voicemail is enabled or disabled. sendAllCalls: type: object properties: enabled: type: boolean example: true description: All calls will be sent to voicemail. description: Settings for sending all calls to voicemail. sendBusyCalls: type: object properties: enabled: type: boolean example: true description: Calls will be sent to voicemail when busy. greeting: type: string enum: - DEFAULT - CUSTOM description: "`DEFAULT` indicates the default greeting will be played. `CUSTOM` indicates a custom `.wav` file will be played.\n * `DEFAULT` - The default greeting will be played.\n * `CUSTOM` - Designates that a custom `.wav` file will be played.\n" description: Settings for sending calls to voicemail when the line is busy. sendUnansweredCalls: type: object properties: enabled: type: boolean example: true description: Unanswered call sending to voicemail is enabled or disabled. greeting: type: string enum: - DEFAULT - CUSTOM description: "`DEFAULT` indicates the default greeting will be played. `CUSTOM` indicates a custom `.wav` file will be played.\n * `DEFAULT` - The default greeting will be played.\n * `CUSTOM` - Designates that a custom `.wav` file will be played.\n" numberOfRings: type: number example: 3 description: Number of rings before an unanswered call will be sent to voicemail. `numberOfRings` must be between 2 and 20, inclusive. notifications: type: object properties: enabled: type: boolean example: true description: Notifications for voicemails will be sent. destination: type: string example: 2025551212@txt.example.net description: Email address to which the notification will be sent. For text messages, use an email to text message gateway like `2025551212@txt.att.net`. description: Settings for notifications when there are any new voicemails. transferToNumber: type: object properties: enabled: type: boolean example: true description: Enable or disable voicemail caller transfer to a destination by pressing zero (0). destination: type: string example: '6527' description: Number voicemail caller will be transferred to when they press zero (0). description: Settings for voicemail caller to transfer to a different number by pressing zero (0). emailCopyOfMessage: type: object properties: enabled: type: boolean example: true description: When `true` copy of new voicemail message audio will be sent to the designated email. emailId: type: string example: dummy@example.com description: Email address to which the new voicemail audio will be sent. description: Settings for sending a copy of new voicemail message audio via email. messageStorage: type: object properties: mwiEnabled: type: boolean example: true description: When `true` desktop phone will indicate there are new voicemails. storageType: type: string enum: - INTERNAL - EXTERNAL description: "Designates which type of voicemail message storage is used.\n * `INTERNAL` - Internal mailbox storage has the following limitations: Single message limit of 10 minutes and total mailbox limit of 100 minutes.\n * `EXTERNAL` - If `EXTERNAL` is selected, all messages will be sent to the email address entered. Messages will not be accessible via phone, clients, or the end user's calling portal.\n" externalEmail: type: string example: dummy@example.com description: External email address to which the new voicemail audio will be sent. faxMessage: type: object properties: enabled: type: boolean example: true description: When `true` FAX messages for new voicemails are sent to the designated number. phoneNumber: type: string example: '2025551212' description: Designates FAX number. extension: type: string example: '1234' description: Designates Optional FAX extension. SelectionObject: type: string enum: - CUSTOM_NAME - DISPLAY_NAME description: " * `DISPLAY_NAME` - When this option is selected, `displayName` is to be shown for this workspace.\n * `CUSTOM_NAME` - When this option is selected, `customName` is to be shown for this workspace." CallRecordingPut: type: object properties: enabled: type: boolean example: true description: '`true` if call recording is enabled.' record: type: string enum: - Always - Never - Always with Pause/Resume - On Demand with User Initiated Start description: "Call recording scenario.\n * `Always` - Incoming and outgoing calls will be recorded with no control to start, stop, pause, or resume.\n * `Never` - Calls will not be recorded.\n * `Always with Pause/Resume` - Calls are always recorded, but user can pause or resume the recording. Stop recording is not supported.\n * `On Demand with User Initiated Start` - Records only the portion of the call after the recording start (`*44`) has been entered. Pause, resume, and stop controls are supported.\n" recordVoicemailEnabled: type: boolean description: When `true`, voicemail messages are also recorded. notification: type: object properties: type: type: string enum: - Beep - Play Announcement description: "Type of pause/resume notification. If `enabled` is `true` and `type` is not provided then `type` is set to `Beep` by default.\n * `Beep` - A beep sound is played when call recording is paused or resumed.\n * `Play Announcement` - A verbal announcement is played when call recording is paused or resumed.\n" enabled: type: boolean description: '`true` when notification feature is in effect. `false` indicates notification is disabled.' description: Pause/resume notification settings. repeat: type: object properties: interval: type: number example: 15 description: Interval at which warning tone "beep" will be played. This interval is an integer from 10 to 1800 seconds enabled: type: boolean description: '`true` when ongoing call recording tone will be played at the designated interval. `false` indicates no warning tone will be played.' description: Beep sound plays periodically. startStopAnnouncement: type: object properties: internalCallsEnabled: type: boolean example: true description: When `true`, an announcement is played when call recording starts and an announcement is played when call recording ends for internal calls. pstnCallsEnabled: type: boolean example: true description: When `true`, an announcement is played when call recording starts and an announcement is played when call recording ends for PSTN calls. description: Call Recording starts and stops announcement settings. UserDirectLineCallerIdNameObject: type: object properties: selection: $ref: '#/components/schemas/UserSelectionObject' description: The selection of the direct line caller ID name. customName: type: string example: Hakim Smith description: Sets or clears the custom direct line caller ID name. To clear the `customName`, the attribute must be set to null or empty string. Required if `selection` is set to `CUSTOM_NAME`. description: Settings for the direct line caller ID name to be shown for this virtual line. IncomingPermissionSetting: type: object required: - useCustomEnabled - externalTransfer - internalCallsEnabled - collectCallsEnabled properties: useCustomEnabled: type: boolean description: When true, indicates that this virtual line uses the specified calling permissions for receiving inbound calls rather than the organizational defaults. externalTransfer: type: string enum: - ALLOW_ALL_EXTERNAL - ALLOW_ONLY_TRANSFERRED_EXTERNAL - BLOCK_ALL_EXTERNAL description: "Specifies the transfer behavior for incoming, external calls.\n * `ALLOW_ALL_EXTERNAL` - Allow transfer and forward for all external calls including those which were transferred.\n * `ALLOW_ONLY_TRANSFERRED_EXTERNAL` - Only allow transferred calls to be transferred or forwarded and disallow transfer of other external calls.\n * `BLOCK_ALL_EXTERNAL` - Block all external calls from being transferred or forwarded.\n" internalCallsEnabled: type: boolean example: true description: Internal calls are allowed to be received. collectCallsEnabled: type: boolean example: true description: Collect calls are allowed to be received. OutgoingCallingPermissionsSettingGet: type: object required: - useCustomPermissions - callingPermissions properties: useCustomEnabled: type: boolean example: true description: When true, indicates that this user uses the shared control that applies to all outgoing call settings categories when placing outbound calls. useCustomPermissions: type: boolean example: true description: When true, indicates that this user uses the specified outgoing calling permissions when placing outbound calls. callingPermissions: type: array items: type: object required: - transferEnabled - isCallTypeRestrictionEnabled properties: callType: type: string enum: - INTERNAL_CALL - TOLL_FREE - INTERNATIONAL - OPERATOR_ASSISTED - CHARGEABLE_DIRECTORY_ASSISTED - SPECIAL_SERVICES_I - SPECIAL_SERVICES_II - PREMIUM_SERVICES_I - PREMIUM_SERVICES_II - NATIONAL description: "Designates the action to be taken for each call type and if transferring the call type is allowed.\n * `INTERNAL_CALL` - Controls calls within your own company.\n * `TOLL_FREE` - Controls calls to a telephone number that is billed for all arriving calls instead of incurring charges to the originating caller, usually free of charge from a landline.\n * `INTERNATIONAL` - Controls calls to locations outside of the Long Distance areas that require an international calling code before the number is dialed.\n * `OPERATOR_ASSISTED` - Controls calls requiring Operator Assistance.\n * `CHARGEABLE_DIRECTORY_ASSISTED` - Controls calls to Directory Assistant companies that require a charge to connect the call.\n * `SPECIAL_SERVICES_I` - Controls calls to carrier-specific number assignments to special services or destinations.\n * `SPECIAL_SERVICES_II` - Controls calls to carrier-specific number assignments to special services or destinations.\n * `PREMIUM_SERVICES_I` - Controls calls used to provide information or entertainment for a fee charged directly to the caller.\n * `PREMIUM_SERVICES_II` - Controls calls used to provide information or entertainment for a fee charged directly to the caller.\n * `NATIONAL` - Controls calls that are within your country of origin, both within and outside of your local area code.\n" action: type: string enum: - ALLOW - BLOCK - AUTH_CODE - TRANSFER_NUMBER_1 - TRANSFER_NUMBER_2 - TRANSFER_NUMBER_3 description: "Action on the given `callType`.\n * `ALLOW` - Allow the designated call type.\n * `BLOCK` - Block the designated call type.\n * `AUTH_CODE` - Allow only via Authorization Code.\n * `TRANSFER_NUMBER_1` - Transfer to Auto Transfer Number 1. The answering virtual line can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_2` - Transfer to Auto Transfer Number 2. The answering virtual line can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_3` - Transfer to Auto Transfer Number 3. The answering virtual line can then approve the call and send it through or reject the call.\n" transferEnabled: type: boolean example: true description: If `true`, allows transfer and forwarding for the call type. isCallTypeRestrictionEnabled: type: boolean example: true description: Indicates if the restriction is enforced by the system for the corresponding call type and cannot be changed. For example, certain call types (such as `INTERNATIONAL`) may be permanently blocked and this field will be `true` to reflect that the restriction is system-controlled and not editable. description: Specifies the outbound calling permissions settings. ApplicationsSettingPut: type: object properties: ringDevicesForClickToDialCallsEnabled: type: boolean example: true description: When `true`, indicates to ring devices for outbound Click to Dial calls. ringDevicesForGroupPageEnabled: type: boolean example: true description: When `true`, indicates to ring devices for inbound Group Pages. ringDevicesForCallParkEnabled: type: boolean example: true description: When `true`, indicates to ring devices for Call Park recalled. browserClientEnabled: type: boolean example: true description: If `true`, the browser Webex Calling application is enabled for use. desktopClientEnabled: type: boolean example: true description: If `true`, the desktop Webex Calling application is enabled for use. tabletClientEnabled: type: boolean example: true description: If `true`, the tablet Webex Calling application is enabled for use. mobileClientEnabled: type: boolean example: true description: If `true`, the mobile Webex Calling application is enabled for use. PushToTalkPut: type: object properties: allowAutoAnswer: type: boolean example: true description: '`true` if Push-to-Talk feature is enabled.' connectionType: $ref: '#/components/schemas/PushToTalkConnectionType' description: Specifies the connection type to be used. accessType: $ref: '#/components/schemas/PushToTalkAccessType' description: Specifies the access type to be applied when evaluating the member list. members: type: array items: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MWU3MDlkNy1hM2IxLTQ2MDctOTBiOC04NmE5MDgxYWFkNmE description: List of people that are allowed or disallowed to interact using the Push-to-Talk feature. MonitoredNumberObject: type: object properties: external: type: string example: '+19845551088' description: External phone number of the monitored person, workspace or virtual line. extension: type: string example: '1088' description: Extension number of the monitored person, workspace or virtual line. routingPrefix: type: string example: '1234' description: Routing prefix of location. esn: type: string example: '12341088' description: Routing prefix + extension of a person or workspace. primary: type: boolean example: true description: Indicates whether phone number is a primary number. ScheduleResponseWithId: type: object required: - id properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ description: Identifier for a schedule. ScheduleLevel: type: string enum: - PEOPLE - GROUP description: " * `PEOPLE` - The schedule level that specifies that criteria is of People level.\n * `GROUP` - The schedule level that specifies that criteria is of Group level.\n" UserSelectionObject: type: string enum: - CUSTOM_NAME - FIRSTNAME_LASTNAME - LASTNAME_FIRSTNAME - DISPLAY_NAME description: " * `DISPLAY_NAME` - When this option is selected, `displayName` is to be shown for this virtual line.\n * `FIRSTNAME_LASTNAME` - When this option is selected, `firstName` and `lastName` are to be shown for this virtual line.\n * `LASTNAME_FIRSTNAME` - When this option is selected, `lastName` and `firstName` are to be shown for this virtual line.\n * `CUSTOM_NAME` - When this option is selected, `customName` is to be shown for this virtual line." CallerIdSelectedType: type: string enum: - DIRECT_LINE - LOCATION_NUMBER - CUSTOM description: " * `DIRECT_LINE` - Outgoing caller ID will show the caller's direct line number\n * `LOCATION_NUMBER` - Outgoing caller ID will show the main number for the location.\n * `CUSTOM` - Outgoing caller ID will show the value from the customNumber field.\n" ScheduleCollectionRequest: type: object required: - name - type properties: name: type: string example: Dallas_Office_Hours description: Name for the schedule. type: $ref: '#/components/schemas/ScheduleType' description: The Schedule type whether `businessHours` or `holidays`. events: type: array items: $ref: '#/components/schemas/EventLongDetails' description: A list of events. CallRecordingInfo: type: object required: - enabled - record - recordVoicemailEnabled - notification - repeat - serviceProvider - externalGroup - externalIdentifier - startStopAnnouncement properties: enabled: type: boolean example: true description: '`true` if call recording is enabled.' record: type: string enum: - Always - Never - Always with Pause/Resume - On Demand with User Initiated Start description: "Call recording scenario.\n * `Always` - Incoming and outgoing calls will be recorded with no control to start, stop, pause, or resume.\n * `Never` - Calls will not be recorded.\n * `Always with Pause/Resume` - Calls are always recorded, but user can pause or resume the recording. Stop recording is not supported.\n * `On Demand with User Initiated Start` - Records only the portion of the call after the recording start (`*44`) has been entered. Pause, resume, and stop controls are supported.\n" recordVoicemailEnabled: type: boolean description: When `true`, voicemail messages are also recorded. notification: type: object required: - type - enabled properties: type: type: string enum: - None - Beep - Play Announcement description: "Type of pause/resume notification.\n * `None` - No notification sound played when call recording is paused or resumed.\n * `Beep` - A beep sound is played when call recording is paused or resumed.\n * `Play Announcement` - A verbal announcement is played when call recording is paused or resumed.\n" enabled: type: boolean description: '`true` when the notification feature is in effect. `false` indicates notification is disabled.' description: Pause/resume notification settings. repeat: type: object required: - interval - enabled properties: interval: type: number example: 15 description: Interval at which warning tone "beep" will be played. This interval is an integer from 10 to 1800 seconds enabled: type: boolean description: '`true` when ongoing call recording tone will be played at the designated interval. `false` indicates no warning tone will be played.' description: Beep sound plays periodically. serviceProvider: type: string example: WSWYZ25455 description: Name of the service provider providing call recording service. externalGroup: type: string example: WSWYZ25455L31161 description: Group utilized by the service provider providing call recording service. externalIdentifier: type: string example: a34iidrh5o@64941297.int10.bcld.webex.com description: Unique person identifier utilized by the service provider providing call recording service. startStopAnnouncement: type: object required: - internalCallsEnabled - pstnCallsEnabled properties: internalCallsEnabled: type: boolean description: When `true`, an announcement is played when call recording starts and an announcement is played when call recording ends for internal calls. pstnCallsEnabled: type: boolean description: When `true`, an announcement is played when call recording starts and an announcement is played when call recording ends for PSTN calls. description: Call Recording starts and stops announcement settings. PrivacyGet: type: object properties: aaExtensionDialingEnabled: type: boolean example: true description: When `true` auto attendant extension dialing is enabled. aaNamingDialingEnabled: type: boolean example: true description: When `true` auto attendant dialing by first or last name is enabled. enablePhoneStatusDirectoryPrivacy: type: boolean example: true description: When `true` phone status directory privacy is enabled. enablePhoneStatusPickupBargeInPrivacy: type: boolean example: true description: When `true` privacy is enforced for call pickup and barge-in. Only members specified by `monitoringAgents` can pickup or barge-in on the call. monitoringAgents: type: array items: $ref: '#/components/schemas/MonitoredPersonObject' description: List of people that are being monitored. EventPutResponseWithId: type: object required: - id properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUTJWdWRISmhiRjlhYjI1bFgwUmhlVjlUYUdsbWRBPT0 description: Identifier for a event. DoNotDisturbInfo: type: object required: - enabled - ringSplashEnabled - webexGoOverrideEnabled properties: enabled: type: boolean example: true description: '`true` if the Do Not Disturb feature is enabled.' ringSplashEnabled: type: boolean description: Enables a Ring Reminder to play a brief tone on your desktop phone when you receive incoming calls. webexGoOverrideEnabled: type: boolean description: '`true` if a mobile device will still ring even if Do Not Disturb is enabled.' GetNumbers: type: object required: - phoneNumbers properties: distinctiveRingEnabled: type: boolean example: true description: Enable/disable a distinctive ring pattern that identifies calls coming from a specific phone number. phoneNumbers: type: array items: type: object properties: primary: type: boolean example: true description: Flag to indicate if the number is primary or not. directNumber: type: string example: '2143456789' description: Phone number. extension: type: string example: '1234' description: Extension. routingPrefix: type: string example: '1234' description: Routing prefix of location. esn: type: string example: '12341234' description: Routing prefix + extension of a person or workspace. ringPattern: type: string enum: - NORMAL - LONG_LONG - SHORT_SHORT_LONG - SHORT_LONG_SHORT description: "Optional ring pattern. Applicable only for alternate numbers.\n * `NORMAL` - Normal incoming ring pattern.\n * `LONG_LONG` - Incoming ring pattern of two long rings.\n * `SHORT_SHORT_LONG` - Incoming ring pattern of two short rings, followed by a long ring.\n * `SHORT_LONG_SHORT` - Incoming ring pattern of a short ring, followed by a long ring, followed by a short ring.\n" description: Information about the number. ScheduleCollectionResponse: type: object required: - schedules properties: schedules: type: array items: $ref: '#/components/schemas/ScheduleShortDetails' description: List of schedules. MonitoringSettingsPut: type: object required: - enableCallParkNotification - monitoredElements properties: enableCallParkNotification: type: boolean example: true description: Enable or disable call park notification. monitoredElements: type: array maxItems: 50 items: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OWNlZjRmYS03YTM5LTQ1ZDItOTNmNi1jNjA5YTRiMjgzODY description: Identifiers of monitored elements whose monitoring settings will be modified. Maximum 50 elements. MonitoringSettings: type: object required: - callParkNotificationEnabled - monitoredElements properties: callParkNotificationEnabled: type: boolean example: true description: Call park notification is enabled or disabled. monitoredElements: type: array items: $ref: '#/components/schemas/GetMonitoredElementsObject' description: Settings of monitored elements which can be person, place, virtual line or call park extension. VoicemailInfo: type: object required: - enabled - sendAllCalls - sendBusyCalls - sendUnansweredCalls - notifications - transferToNumber - emailCopyOfMessage - messageStorage - faxMessage properties: enabled: type: boolean example: true description: Voicemail is enabled or disabled. sendAllCalls: type: object required: - enabled properties: enabled: type: boolean example: true description: All calls will be sent to voicemail. description: Settings for sending all calls to voicemail. sendBusyCalls: type: object required: - enabled - greeting - greetingUploaded properties: enabled: type: boolean example: true description: Calls will be sent to voicemail when busy. greeting: type: string enum: - DEFAULT - CUSTOM description: "`DEFAULT` indicates the default greeting will be played. `CUSTOM` indicates a custom `.wav` file will be played.\n * `DEFAULT` - The default greeting will be played.\n * `CUSTOM` - Designates that a custom `.wav` file will be played.\n" greetingUploaded: type: boolean example: true description: A custom greeting has been uploaded. description: Settings for sending calls to voicemail when the line is busy. sendUnansweredCalls: type: object required: - enabled - greeting - greetingUploaded - numberOfRings - systemMaxNumberOfRings properties: enabled: type: boolean example: true description: Enables and disables sending unanswered calls to voicemail. greeting: type: string enum: - DEFAULT - CUSTOM description: "`DEFAULT` indicates the default greeting will be played. `CUSTOM` indicates a custom `.wav` file will be played.\n * `DEFAULT` - The default greeting will be played.\n * `CUSTOM` - Designates that a custom `.wav` file will be played.\n" greetingUploaded: type: boolean example: true description: A custom greeting has been uploaded numberOfRings: type: number example: 3 description: Number of rings before unanswered call will be sent to voicemail. systemMaxNumberOfRings: type: number example: 15 description: System-wide maximum number of rings allowed for `numberOfRings` setting. notifications: type: object required: - enabled properties: enabled: type: boolean example: true description: Send of unanswered calls to voicemail is enabled or disabled. destination: type: string example: 2025551212@txt.att.net description: Email address to which the notification will be sent. For text messages, use an email to text message gateway like `2025551212@txt.example.net`. description: Settings for notifications when there are any new voicemails. transferToNumber: type: object required: - enabled properties: enabled: type: boolean example: true description: Enabled or disabled state of giving caller option to transfer to destination when pressing zero (0). destination: type: string example: '6527' description: Number voicemail caller will be transferred to when they press zero (0). description: Settings for voicemail caller to transfer to a different number by pressing zero (0). emailCopyOfMessage: type: object required: - enabled - emailId properties: enabled: type: boolean example: true description: When `true` copy of new voicemail message audio will be sent to the designated email. emailId: type: string example: dummy@example.com description: Email address to which the new voicemail audio will be sent. description: Settings for sending a copy of new voicemail message audio via email. messageStorage: type: object required: - mwiEnabled - storageType - externalEmail properties: mwiEnabled: type: boolean example: true description: When `true` desktop phone will indicate there are new voicemails. storageType: type: string enum: - INTERNAL - EXTERNAL description: "Designates which type of voicemail message storage is used.\n * `INTERNAL` - For message access via phone or the Calling User Portal.\n * `EXTERNAL` - For sending all messages to the person's email.\n" externalEmail: type: string example: dummy@example.com description: External email address to which the new voicemail audio will be sent. A value for this field must be provided in the request if a `storageType` of `EXTERNAL` is given in the request. faxMessage: type: object required: - enabled properties: enabled: type: boolean example: true description: When `true` FAX messages for new voicemails will be sent to the designated number. phoneNumber: type: string example: '2025551212' description: Designates phone number for the FAX. A value for this field must be provided in the request if faxMessage `enabled` field is given as `true` in the request. extension: type: string example: '1234' description: Designates optional FAX extension. SchedulePutResponseWithId: type: object required: - id properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvVW1samFHRnlaSE52Ymw5UFptWnBZMlZmU0c5MWNuTT0 description: Identifier for a schedule. securitySchemes: oauth2: flows: authorizationCode: authorizationUrl: / scopes: {} tokenUrl: / type: oauth2 bearer-key: type: http description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN scheme: bearer bearerFormat: JWT bearerAuth: type: oauth2 description: OAuth 2.0 Bearer token authentication flows: authorizationCode: authorizationUrl: https://webexapis.com/v1/authorize tokenUrl: https://webexapis.com/v1/access_token scopes: spark:applications_token: Create access tokens for Service Apps