openapi: 3.0.0 info: title: Webex Admin Address Book Call Settings For Me 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: Call Settings For Me paths: /telephony/config/people/me/settings/availablePreferredAnswerEndpoints: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/preferredAnswerEndpointInformation' example: endpoints: - id: Y2lzY29z... type: DEVICE name: Cisco 8865 (Phone in reception area) isPreferredAnswerEndpoint: false - id: Y2lzY29b... type: APPLICATION name: Webex Desktop Application isPreferredAnswerEndpoint: 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 List Available Preferred Answer Endpoints operationId: getListAvailablePreferredAnswerEndpoints description: "Get the person's preferred answer endpoint and the list of endpoints available for selection. The list of endpoints is empty if the person has no endpoints assigned which support the preferred answer endpoint functionality.\n\n A Webex Calling user may be associated with multiple endpoints such as Webex App (desktop or mobile), Cisco desk IP phone, Webex Calling-supported analog devices or third-party endpoints. Preferred answering endpoints allow users to specify which of these devices should be prioritized for answering calls, particularly when a person's extension (or a virtual line assigned to them) rings on multiple devices. This helps ensure that calls are answered on the most convenient or appropriate device for the person.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." tags: - Call Settings For Me parameters: [] security: - bearer-key: [] /telephony/config/people/me/settings/secondaryLines/{lineOwnerId}/availablePreferredAnswerEndpoints: get: summary: Get My Secondary Line Owner's Available Preferred Answer Endpoint List operationId: getSecondaryLinesAvailablePreferredAnswerEndpointList description: "Retrieve the list of available preferred answer endpoints for the secondary line owner of the authenticated person. \n\n A Webex Calling user may be associated with multiple endpoints such as Webex App (desktop or mobile), Cisco desk IP phone, Webex Calling-supported analog devices or third-party endpoints. Preferred answering endpoints allow users to specify which of these devices should be prioritized for answering calls, particularly when a person's extension (or a virtual line assigned to them) rings on multiple devices. This helps ensure that calls are answered on the most convenient or appropriate device for the person.\n\n This API requires a user auth token with a scope of `spark:telephony_config_read`." tags: - Call Settings For Me parameters: - name: lineOwnerId in: path required: true description: Unique identifier for the secondary line owner (applicable only for Virtual Lines). example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/preferredAnswerEndpointInformation' example: endpoints: - id: Y2lzY29z... type: DEVICE name: Cisco 8865 (Phone in reception area) isPreferredAnswerEndpoint: false - id: Y2lzY29b... type: APPLICATION name: Webex Desktop Application isPreferredAnswerEndpoint: 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.' /telephony/config/people/me/settings/preferredAnswerEndpoint: get: summary: Get Preferred Answer Endpoint operationId: getMyPreferredAnswerEndpoint description: "Retrieve the selected preferred answering endpoint for the user. If a preferred endpoint is not set for the person, API returns empty \n\n A Webex Calling user may be associated with multiple endpoints such as Webex App (desktop or mobile), Cisco desk IP phone, Webex Calling-supported analog devices or third-party endpoints. Preferred answering endpoints allow users to specify which of these devices should be prioritized for answering calls, particularly when a person's extension (or a virtual line assigned to them) rings on multiple devices. This helps ensure that calls are answered on the most convenient or appropriate device for the person.\n\n This API requires a user auth token with a scope of `spark:telephony_config_read`." tags: - Call Settings For Me responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/preferredAnswerEndpoint' example: id: Y2lzY29z... type: DEVICE name: Cisco 8865 (Phone in reception area) '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.' parameters: [] security: - bearer-key: [] put: summary: Modify Preferred Answer Endpoint operationId: modifyMyPreferredAnswerEndpoint description: "Sets or clears the person’s preferred answer endpoint. To clear the preferred answer endpoint the `id` attribute must be set to null.\n\n A Webex Calling user may be associated with multiple endpoints such as Webex App (desktop or mobile), Cisco desk IP phone, Webex Calling-supported analog devices or third-party endpoints. Preferred answering endpoints allow users to specify which of these devices should be prioritized for answering calls, particularly when a person's extension (or a virtual line assigned to them) rings on multiple devices. This helps ensure that calls are answered on the most convenient or appropriate device for the person.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." tags: - Call Settings For Me requestBody: content: application/json: schema: $ref: '#/components/schemas/EndpointIdType' example: id: Y2lzY29z... responses: '204': description: 'No Content: The preferred answering endpoint was successfully updated.' '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.' parameters: [] security: - bearer-key: [] /telephony/config/people/me/settings/secondaryLines/{lineOwnerId}/preferredAnswerEndpoint: get: summary: Get My Secondary Line Owner's Preferred Answer Endpoint operationId: getMySecondaryLinesPreferredAnswerEndpoint description: "Retrieve the selected preferred answering endpoint for the secondary line owner of the authenticated person. If a preferred endpoint is not set for the person, API returns empty \n\n A Webex Calling user may be associated with multiple endpoints such as Webex App (desktop or mobile), Cisco desk IP phone, Webex Calling-supported analog devices or third-party endpoints. Preferred answering endpoints allow users to specify which of these devices should be prioritized for answering calls, particularly when a person's extension (or a virtual line assigned to them) rings on multiple devices. This helps ensure that calls are answered on the most convenient or appropriate device for the person.\n\n This API requires a user auth token with a scope of `spark:telephony_config_read`." tags: - Call Settings For Me responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/preferredAnswerEndpoint' example: id: Y2lzY29z... type: DEVICE name: Cisco 8865 (Phone in reception area) '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.' parameters: - name: lineOwnerId in: path required: true description: Unique identifier for the secondary line owner (applicable only for Virtual Lines). example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU schema: type: string security: - bearer-key: [] put: summary: Modify My Secondary Line Owner's Preferred Answer Endpoint operationId: modifyMySecondaryLinesPreferredAnswerEndpoint description: "Sets or clears the preferred answer endpoint for the secondary line owner of the authenticated person. To clear the preferred answer endpoint the `id` attribute must be set to null.\n\n A Webex Calling user may be associated with multiple endpoints such as Webex App (desktop or mobile), Cisco desk IP phone, Webex Calling-supported analog devices or third-party endpoints. Preferred answering endpoints allow users to specify which of these devices should be prioritized for answering calls, particularly when a person's extension (or a virtual line assigned to them) rings on multiple devices. This helps ensure that calls are answered on the most convenient or appropriate device for the person.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." tags: - Call Settings For Me requestBody: content: application/json: schema: $ref: '#/components/schemas/EndpointIdType' example: id: Y2lzY29z... responses: '204': description: 'No Content: The preferred answering endpoint was successfully updated.' '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.' parameters: - name: lineOwnerId in: path required: true description: Unique identifier for the secondary line owner (applicable only for Virtual Lines). example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU schema: type: string security: - bearer-key: [] /telephony/config/people/me/settings/webexGoOverride: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UserDNDWebexGoOverrideGet' example: enabled: true '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.' '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).' summary: Get My WebexGoOverride Settings operationId: getMyWebexGoOverrideSettings description: 'Retrieve "Mobile User Aware" override setting for Do Not Disturb feature. When enabled, a mobile device will still ring even if Do Not Disturb, Quiet Hours, or Presenting Status are enabled. When disabled, a mobile device will return busy for all incoming calls if Do Not Disturb, Quiet Hours, or Presenting Status are enabled. It requires a user auth token with `spark:telephony_config_read` scope.' tags: - Call Settings For Me parameters: [] put: responses: '204': description: No Content headers: {} content: {} '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.' '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).' summary: Modify My WebexGoOverride Settings operationId: modifyMyWebexGoOverrideSettings description: 'Update "Mobile User Aware" override setting for Do Not Disturb feature. When enabled, a mobile device will still ring even if Do Not Disturb, Quiet Hours, or Presenting Status are enabled. When disabled, a mobile device will return busy for all incoming calls if Do Not Disturb, Quiet Hours, or Presenting Status are enabled. It requires a user auth token with the `spark:telephony_config_write` scope.' tags: - Call Settings For Me parameters: [] requestBody: content: application/json: example: enabled: true schema: $ref: '#/components/schemas/UserDNDWebexGoOverridePatch' /telephony/config/people/me/settings/callerId: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallerIdSettingsGet' example: callingLineIdDeliveryBlockingEnabled: false connectedLineIdentificationRestrictionEnabled: 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 My Caller ID Settings operationId: getMyCallerIDSettings description: 'Get Caller ID Settings for the authenticated user. Calling Line ID Delivery Blocking in Webex prevents your name and phone number from being shown to people you call. Connected Line Identification Restriction allows you to block your name and phone number from being shown when receiving a call. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: [] 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 My Caller ID Settings operationId: modifyMyCallerIDSettings description: 'Update Caller ID Settings for the authenticated user. Calling Line ID Delivery Blocking in Webex prevents your name and phone number from being shown to people you call. Connected Line Identification Restriction allows you to block your name and phone number from being shown when receiving a call. This API requires a user auth token with a scope of `spark:telephony_config_write`.' tags: - Call Settings For Me parameters: [] requestBody: content: application/json: example: callingLineIdDeliveryBlockingEnabled: false connectedLineIdentificationRestrictionEnabled: false schema: $ref: '#/components/schemas/CallerIdSettingsPut' /telephony/config/people/me/settings/secondaryLines/{lineownerId}/callerId: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallerIdSettingsGet' example: callingLineIdDeliveryBlockingEnabled: false connectedLineIdentificationRestrictionEnabled: 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 My Secondary Line Owner Caller ID Settings operationId: getMySecondaryLinesCallerIDSettings description: 'Get Caller ID Settings for the secondary line owner of the authenticated user. Note that the secondary line information is only available for the authenticated user. Calling Line ID Delivery Blocking in Webex prevents your name and phone number from being shown to people you call. Connected Line Identification Restriction allows you to block your name and phone number from being shown when receiving a call. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: - name: lineownerId in: path description: Unique identifier for the secondary line owner (applicable only for Virtual Lines). required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU 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 My Secondary Line Owner Caller ID Settings operationId: modifyMySecondaryLinesCallerIDSettings description: 'Update Caller ID Settings for the secondary line owner of the authenticated user. Note that the secondary line information is only available for the authenticated user. Calling Line ID Delivery Blocking in Webex prevents your name and phone number from being shown to people you call. Connected Line Identification Restriction allows you to block your name and phone number from being shown when receiving a call. This API requires a user auth token with a scope of `spark:telephony_config_write`.' tags: - Call Settings For Me parameters: - name: lineownerId in: path description: Unique identifier for the secondary line owner (applicable only for Virtual Lines). required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU schema: type: string requestBody: content: application/json: example: callingLineIdDeliveryBlockingEnabled: false connectedLineIdentificationRestrictionEnabled: false schema: $ref: '#/components/schemas/CallerIdSettingsPut' /telephony/config/people/me/settings/selectedCallerId: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SelectedCallerIdSettingsGet' example: selected: type: CALL_QUEUE id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNmU1NTVjZDAtNjM0MS00MmI4LWEyMWMtZTc1ZjIxNDQ4Mjc1 name: Call Queue DND directNumber: '+19075552859' extension: '10079' '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 My Selected Caller ID Settings operationId: getMySelectedCallerIDSettings description: 'Read selected caller ID settings associated with the authenticated user. Caller ID settings control how a person''s information is displayed when making outgoing calls. Selected Caller ID settings allow users to choose which configuration among available caller IDs is selected currently. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: [] 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 My Selected Caller ID Settings operationId: modifyMySelectedCallerIDSettings description: 'Update selected caller ID settings associated with the authenticated user. Caller ID settings control how a person''s information is displayed when making outgoing calls. Selected Caller ID settings allow users to choose which configuration among available caller IDs is selected currently. This API requires a user auth token with a scope of `spark:telephony_config_write`.' tags: - Call Settings For Me parameters: [] requestBody: content: application/json: example: selected: type: HUNT_GROUP id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvNmU1NTVjZDAtNjM0MS00MmI4LWEyMWMtZTc1ZjIxNDQ4Mjc1 schema: $ref: '#/components/schemas/SelectedCallerIdSettingsPut' /telephony/config/people/me/settings/secondaryLines/{lineownerId}/selectedCallerId: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SelectedCallerIdSettingsGet' example: selected: type: CALL_QUEUE id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNmU1NTVjZDAtNjM0MS00MmI4LWEyMWMtZTc1ZjIxNDQ4Mjc1 name: Call Queue DND directNumber: '+19075552859' extension: '10079' '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 My Secondary Line Owner's Selected Caller ID Settings operationId: getMySecondaryLinesSelectedCallerIDSettings description: 'Get details of selected caller ID settings associated with a secondary line of the authenticated user. Note that an authenticated user can only retrieve information for their configured secondary lines. Caller ID settings control how a person''s information is displayed when making outgoing calls. Selected Caller ID settings allow users to choose which configuration among available caller IDs is selected currently. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: - name: lineownerId in: path description: Unique identifier for the secondary line owner (applicable only for Virtual Lines). required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU 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 My Secondary Line Owner's Selected Caller ID Settings operationId: modifyMySecondaryLinesSelectedCallerIDSettings description: 'Update selected caller ID settings associated with a secondary line owner of the authenticated user. Note that an authenticated user can only modify information for their configured secondary lines. Caller ID settings control how a person''s information is displayed when making outgoing calls. Selected Caller ID settings allow users to choose which configuration among available caller IDs is selected currently. This API requires a user auth token with a scope of `spark:telephony_config_write`.' tags: - Call Settings For Me parameters: - name: lineownerId in: path description: Unique identifier for the secondary line owner (applicable only for Virtual Lines). required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU schema: type: string requestBody: content: application/json: example: selected: type: DEFAULT_CLID schema: $ref: '#/components/schemas/SelectedCallerIdSettingsPut' /telephony/config/people/me/settings/availableCallerIds: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/AvailableCallerIdSettingsGet' example: availableCallerIds: - type: HUNT_GROUP id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvNmU1NTVjZDAtNjM0MS00MmI4LWEyMWMtZTc1ZjIxNDQ4Mjc5 name: Hunt Group directNumber: '+19075552860' extension: '10079' '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 My Available Caller ID List operationId: getMyAvailableCallerIDList description: 'Get details of available caller IDs of the authenticated user. Caller ID settings control how a person''s information is displayed when making outgoing calls. The available caller ID list shows the caller IDs that the user can choose from. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: [] /telephony/config/people/me/settings/secondaryLines/{lineownerId}/availableCallerIds: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/AvailableCallerIdSettingsGet' example: availableCallerIds: - type: HUNT_GROUP id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvNmU1NTVjZDAtNjM0MS00MmI4LWEyMWMtZTc1ZjIxNDQ4Mjc5 name: Hunt Group directNumber: '+19075552860' extension: '10079' '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: Get My Secondary Line Owner's Available Caller ID List operationId: getMySecondaryLinesAvailableCallerIDList description: 'Get details of available caller IDs for a secondary line of the authenticated user. Note that an authenticated user can only retrieve information for their configured secondary lines. Caller ID settings control how a person''s information is displayed when making outgoing calls. The available caller ID list shows the caller IDs that the user can choose from. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: - name: lineownerId in: path description: Unique identifier for the secondary line owner (applicable only for Virtual Lines). required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU schema: type: string /telephony/config/people/me/endpoints: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/EndpointListGetObject' example: endpoints: - id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS85MGQyMmM0Yy0wMGI3LTQ4YzAtYjUwNi0yM2UwY2E2MTlkYmM= type: CALLING_DEVICE name: Webex Go Device autoAndForcedAnswerEnabled: false ownerId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNTlkYzFkOC00NjdkLTRhNGUtOTRlNi1jOTYyZjEyMmY5YWM ownerType: PEOPLE mobilitySettings: phoneNumber: '+13374831660' alertingEnabled: false - id: Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OLzIyNjBkMDYxLWViNDUtNDJhMi05MmY3LWFkZDMyMzRiYzI0Yw type: APPLICATION name: Webex Tablet Application autoAndForcedAnswerEnabled: false ownerId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNTlkYzFkOC00NjdkLTRhNGUtOTRlNi1jOTYyZjEyMmY5YWM ownerType: PEOPLE secondaryLines: - id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS82NDhjYjBkMC1kODU2LTQzNzQtYmI4My0zNWFhNTIxZDhiZmI memberType: VIRTUAL_LINE - id: Y2lzY29zcGFyazovL3VzL0hPVERFU0tJTkdfR1VFU1QvN2FmYTFlNWMtOTFiYS00NzRkLWEzODMtZTAyMDgxZDU3YmE5 type: HOTDESKING_GUEST name: Cisco HotDesking autoAndForcedAnswerEnabled: false ownerId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNTlkYzFkOC00NjdkLTRhNGUtOTRlNi1jOTYyZjEyMmY5YWM ownerType: PEOPLE secondaryLines: - id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS82NDhjYjBkMC1kODU2LTQzNzQtYmI4My0zNWFhNTIxZDhiZmI memberType: VIRTUAL_LINE host: id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS9lMTRhNTFlMC1mM2Q1LTQzNzktOWM2OC1hNWFiY2Y1M2E5MTY= type: CALLING_DEVICE name: Cisco 8861 autoAndForcedAnswerEnabled: false ownerId: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8zNDU1MDQ1YS0xN2UyLTQxNzEtOGMwYy02ZWVkMDgwNjM5ZDI= ownerType: PLACE secondaryLines: - id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS9iNmYwNzQyNS1lYjgyLTQzMDEtOWRlNy04YWI3NTFjM2ZhZDQ memberType: VIRTUAL_LINE '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 the List of My Endpoints operationId: getMyEndpointsList description: 'Retrieve the list of endpoints associated with the authenticated user. Endpoints are devices, applications, or hotdesking guest profiles. Endpoints can be owned by an authenticated user or have the user as a secondary line. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: [] /telephony/config/people/me/endpoints/{endpointId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/Endpoint' example: id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS80NmNmMGEyYi0yNTE5LTQ1NGEtYTAzMi1iODYxMWZjYmZkNTQ= type: CALLING_DEVICE name: Cisco 8875 autoAndForcedAnswerEnabled: true ownerId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNTlkYzFkOC00NjdkLTRhNGUtOTRlNi1jOTYyZjEyMmY5YWM ownerType: PEOPLE secondaryLines: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xYmZhOTM4Ny1kZjQ5LTRkMGQtYjRmMi1jNTMwNDE2YWNlNDQ memberType: PEOPLE '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 My Endpoints Details operationId: getMyEndpointDetails description: 'Get details of an endpoint associated with the authenticated user. Endpoints are devices, applications, or hotdesking guest profiles. Endpoints can be owned by an authenticated user or have the user as a secondary line. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: - name: endpointId in: path description: Unique identifier of the endpoint. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS80NmNmMGEyYi0yNTE5LTQ1NGEtYTAzMi1iODYxMWZjYmZkNTQ 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 My Endpoints Details operationId: modifyMyEndpointDetails description: 'Update alerting settings of the mobility endpoint associated with the authenticated user. Endpoints are devices, applications, or hotdesking guest profiles. Endpoints can be owned by an authenticated user or have the user as a secondary line. This API requires a user auth token with a scope of `spark:telephony_config_write`.' tags: - Call Settings For Me parameters: - name: endpointId in: path description: Unique identifier of the endpoint. required: true example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS85MGQyMmM0Yy0wMGI3LTQ4YzAtYjUwNi0yM2UwY2E2MTlkYmM schema: type: string requestBody: content: application/json: example: mobilitySettings: alertingEnabled: true schema: $ref: '#/components/schemas/ModifyEndpointObject' /telephony/config/people/me/settings/callRecording: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UserCallRecordingGetResponseObject' example: enabled: true vendor: id: Y2lzY29zcGFyazovL3VzL1JFQ09SRElOR19WRU5ET1IvZmVjYjYzNGUtYzMyZS00ZWJmLThlYzMtMmVhYjk3Y2IyNjNk name: ITFDual loginUrl: https://www.itfdualportal.com recordingMode: On Demand pauseResumeNotifyMethod: Beep announcementEnabled: true warningToneEnabled: false warningToneDuration: 70 '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 My Call Recording Settings operationId: getMyCallRecordingSettings description: 'Get details of call recording settings associated with the authenticated user. Call recording settings allow you to access and customize options that determine when and how your calls are recorded, providing control over recording modes and notifications. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: [] /telephony/config/people/me/settings/secondaryLines/{lineownerId}/callRecording: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UserCallRecordingGetResponseObject' example: enabled: true vendor: id: Y2lzY29zcGFyazovL3VzL1JFQ09SRElOR19WRU5ET1IvZmVjYjYzNGUtYzMyZS00ZWJmLThlYzMtMmVhYjk3Y2IyNjNk name: ITFDual loginUrl: https://www.itfdualportal.com recordingMode: On Demand pauseResumeNotifyMethod: Beep announcementEnabled: true warningToneEnabled: false warningToneDuration: 70 '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 My Secondary Line Owner's Call Recording Settings operationId: getMySecondaryLinesCallRecordingSettings description: 'Get details of call recording settings associated with a secondary line of the authenticated user. Note that an authenticated user can only retrieve information for their configured secondary lines. Call recording settings allow you to access and customize options that determine when and how your calls are recorded, providing control over recording modes and notifications. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: - name: lineownerId in: path description: Unique identifier for the secondary line owner (applicable only for Virtual Lines). required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU schema: type: string /telephony/config/people/me: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UserProfileGetResponseObject' example: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYWZiM2JhYi1hN2UxLTQ1ZGUtYmYzZS1kOWUxMzkxYzU0Yjk lastName: Doe firstName: John email: john.doe@gmail.com announcementLanguage: English locationDialingCode: '8327' supportMobility: false emergencyCallBackNumber: '+16232992720' phoneNumbers: - directNumber: '+441234222304' enterprise: '832731599' extension: '31599' routingPrefix: '8327' esn: '832731599' primary: true - directNumber: '+441234200015' enterprise: '832731587' extension: '31587' routingPrefix: '8327' esn: '832731587' primary: false devices: - description: [] model: DMS Cisco 8865 mac: '110723241134' primaryOwner: true type: PRIMARY owner: lastName: Mac firstName: Jone type: PEOPLE activationState: ACTIVATED location: name: Brampton address: address1: mclean address2: mclean city: mclean state: GB-BGE postalCode: '112233' country: GB receptionistUrl: https://cisco.receptionist.cloud callingHostUrl: https://var-int.broadcloudpbx.net attendantConsoleUrl: https://cisco.receptionist.cloud '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 My Own Details operationId: getMyOwnDetails description: 'Get profile details for the authenticated user. Profile details include the user''s name, email, location and calling details. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: [] /telephony/config/people/me/settings/featureAccessCode: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/FeatureAccessCodeListGetObject' example: featureAccessCodeList: - name: Call Forwarding Busy Interrogation code: '*67*' alternateCode: '*18' - name: Cancel Call Waiting code: '*70' - name: Call Waiting Interrogation code: '*53*' alternateCode: '*38' '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 My Feature Access Codes operationId: getMyFeatureAccessCodes description: 'Retrieve all Feature Access Codes configured for services that are assigned to the authenticated user. For each feature access code, the name and code are returned. If an alternate code is defined, it is also returned. Feature access codes (FACs), also known as star codes, give users access to advanced calling features. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: [] /telephony/config/people/me/settings/secondaryLines/{lineownerId}/featureAccessCode: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/FeatureAccessCodeListGetObject' example: featureAccessCodeList: - name: Call Forwarding Busy Interrogation code: '*67*' alternateCode: '*18' - name: Cancel Call Waiting code: '*70' - name: Call Waiting Interrogation code: '*53*' alternateCode: '*38' '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 My Feature Access Codes For Secondary Line Owner operationId: getMySecondaryLinesFeatureAccessCodes description: 'Retrieve all Feature Access Codes configured for services that are assigned for the secondary line owner. For each feature access code, the name and code are returned. If an alternate code is defined, it is also returned. Feature access codes (FACs), also known as star codes, give users access to advanced calling features. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: - name: lineownerId in: path description: Unique identifier for the secondary line owner (applicable only for Virtual Lines). required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS82NDhjYjBkMC1kODU2LTQzNzQtYmI4My0zNWFhNTIxZDhiZmI schema: type: string /telephony/config/people/me/settings/executive/assignedAssistants: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ExecutiveAssignedAssistantsGet' example: allowOptInOutEnabled: true assistants: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU firstName: doe lastName: John directNumber: +91-6557765419 extension: '10079' optInEnabled: true location: name: Bangalore id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzMGMzYTNlLTA3Y2EtNDNmOS1iZjE4LTZlZGM2OGE1Y2Y3Yg '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 My Executive Assigned Assistants operationId: getMyExecutiveAssignedAssistants description: 'Get list of assigned executive assistants for an authenticated user. As an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: [] 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 My Executive Assigned Assistants operationId: modifyMyExecutiveAssignedAssistants description: 'Update assigned executive assistants for the authenticated user. As an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required. This API requires a user auth token with a scope of `spark:telephony_config_write`.' tags: - Call Settings For Me parameters: [] requestBody: content: application/json: example: allowOptInOutEnabled: false assistantIds: - Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mM2ZjMDFlOC1iZjM3LTQyMDgtOThjZS1iMzdlYWEwYTVlY2U - Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMzRmNjdhNS1kYTFiLTQxYzUtODBkNS03ZDFmZTY3ZTE5ZTY schema: $ref: '#/components/schemas/ExecutiveAssignedAssistantsPatchRequestObject' /telephony/config/people/me/settings/executive/availableAssistants: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ExecutiveAvailableAssistantsGet' example: assistants: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU firstName: doe lastName: John directNumber: +91-6557765419 extension: '10079' '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 My Executive Available Assistants operationId: getMyExecutiveAvailableAssistants description: 'Get a list of available executive assistants for the authenticated user. As an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: [] /telephony/config/people/me/settings/executive/assistant: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ExecutiveAssistantSettingsGet' example: forwardFilteredCallsEnabled: true forwardToPhoneNumber: '+14155551234' executives: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZWQzNDg0MS0yZTkwLTQ4OGEtYmVmZi1iNTk0OTA1ODFkNWM firstName: John lastName: Doe directNumber: +91-6557765419 extension: '10079' optInEnabled: 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 My Executive Assistant Settings operationId: getMyExecutiveAssistantSettings description: 'Get settings for an executive assistant. Executive assistants can make, answer, intercept, and route calls appropriately on behalf of their executive. Assistants can also set the call forwarding destination, and join or leave an executive’s pool. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: [] 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 My Executive Assistant Settings operationId: modifyMyExecutiveAssistantSettings description: 'Update Settings for an executive assistant. Executive assistants can make, answer, intercept, and route calls appropriately on behalf of their executive. Assistants can also set the call forwarding destination, and join or leave an executive’s pool. This API requires a user auth token with a scope of `spark:telephony_config_write`.' tags: - Call Settings For Me parameters: [] requestBody: content: application/json: example: forwardFilteredCallsEnabled: true forwardToPhoneNumber: '+19075552860' executives: - personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZWQzNDg0MS0yZTkwLTQ4OGEtYmVmZi1iNTk0OTA1ODFkNWM optInEnabled: true schema: $ref: '#/components/schemas/ExecutiveAssistantSettingsPut' /telephony/config/people/me/settings/services: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ServiceObject' example: services: - Anonymous Call Rejection - Call Forwarding Always - Call Forwarding Busy - Call Forwarding No Answer - Call Notify '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 My Calling Services List operationId: getMyCallingServicesList description: 'Retrieves the list of enabled calling services for the authenticated user. These services are designed to improve call handling and ensure that users can manage their communications effectively. They are commonly found in both personal and business telephony systems. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: [] /telephony/config/people/me/settings/secondaryLines/{lineownerId}/services: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ServiceObject' example: services: - Anonymous Call Rejection - Call Forwarding Always - Call Forwarding Busy - Call Forwarding No Answer - Call Notify '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 My Secondary Line Owner Calling Services List operationId: getMySecondaryLinesCallingServicesList description: 'Retrieves the list of enabled calling services for the secondary line owner of the authenticated user. These services are designed to improve call handling and ensure that users can manage their communications effectively. They are commonly found in both personal and business telephony systems. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: - name: lineownerId in: path description: Unique identifier for the secondary line owner (applicable only for Virtual Lines). required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU schema: type: string /telephony/config/people/me/settings/singleNumberReach: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetSingleNumberReachObject' example: enabled: true alertAllLocationsForClickToDialCallsEnabled: false alertAllLocationsForGroupPagingCallsEnabled: true numbers: - phoneNumber: '+19075552859' name: John enabled: true doNotForwardCallsEnabled: true answerConfirmationEnabled: 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 User's Single Number Reach Settings operationId: getMySingleNumberReachSettings description: 'Retrieves all single number reach settings configured for the authenticated user. The "Single Number Reach" feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office. This is especially useful for remote or mobile workers needing flexibility. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: [] 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 User's Single Number Reach Settings operationId: modifyMySingleNumberReachSettings description: 'Updates single number reach settings associated with the authenticated user. The "Single Number Reach" feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office. This is especially useful for remote or mobile workers needing flexibility. This API requires a user auth token with a scope of `spark:telephony_config_write`.' tags: - Call Settings For Me parameters: [] requestBody: content: application/json: example: alertAllLocationsForClickToDialCallsEnabled: true schema: $ref: '#/components/schemas/UserSingleNumberReachPatchRequestObject' /telephony/config/people/me/settings/singleNumberReach/numbers: post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id properties: id: type: string description: Unique identifier for the phone number. example: id: Y2lzY29zcGFyazovL3VzL1BIT05FX05VTUJFUi9LekU1TnpnNU5EWTJOelkz '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 phone number as User's Single Number Reach operationId: addPhoneNumberAsSingleNumberReach description: 'Add a phone number as a single number reach for the authenticated user. The "Single Number Reach" feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office. This is especially useful for remote or mobile workers needing flexibility. This API requires a user auth token with a scope of `spark:telephony_config_write`.' tags: - Call Settings For Me parameters: [] requestBody: content: application/json: example: phoneNumber: '+19075552859' name: John enabled: true doNotForwardCallsEnabled: true answerConfirmationEnabled: false schema: $ref: '#/components/schemas/PostNumberForSingleReachNumber' /telephony/config/people/me/settings/singleNumberReach/numbers/{phoneNumberId}: 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 User's Single Number Reach Contact Settings operationId: modifyMySingleNumberReachContactSettings description: 'Update the contact settings of single number reach for the authenticated user. The "Single Number Reach" feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office. This is especially useful for remote or mobile workers needing flexibility. This API requires a user auth token with a scope of `spark:telephony_config_write`.' tags: - Call Settings For Me parameters: - name: phoneNumberId in: path description: Unique identifier of the phone number. required: true example: Y2lzY29zcGFyazovL3VzL1BIT05FX05VTUJFUi9LekU0T1RjMk5UUXpNekUx schema: type: string requestBody: content: application/json: example: phoneNumber: '+19075552859' name: John enabled: true doNotForwardCallsEnabled: true answerConfirmationEnabled: false schema: $ref: '#/components/schemas/SingleNumberReachNumber' 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 User's Single Number Reach Contact Settings operationId: deleteMySingleNumberReachContactSettings description: 'Delete contact settings associated with the authenticated user. The "Single Number Reach" feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office. This is especially useful for remote or mobile workers needing flexibility. This API requires a user auth token with a scope of `spark:telephony_config_write`.' tags: - Call Settings For Me parameters: - name: phoneNumberId in: path description: Unique identifier of the phone number. required: true example: Y2lzY29zcGFyazovL3VzL1BIT05FX05VTUJFUi9LekU0T1RjMk5UUXpNekUx schema: type: string /telephony/config/people/me/settings/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 My Call Forwarding Settings operationId: getMyCallForwardingSettings description: 'Read call forwarding settings associated with the authenticated user. 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 user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: [] 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 My Call Forwarding Settings operationId: modifyMyCallForwardingSettings description: 'Update call forwarding settings associated with the authenticated user. 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 user auth token with a scope of `spark:telephony_config_write`.' tags: - Call Settings For Me parameters: [] requestBody: content: application/json: example: callForwarding: always: enabled: false ringReminderEnabled: false destinationVoicemailEnabled: false busy: enabled: false destinationVoicemailEnabled: false noAnswer: enabled: false numberOfRings: 2 destinationVoicemailEnabled: false businessContinuity: enabled: false destinationVoicemailEnabled: false schema: $ref: '#/components/schemas/CallForwardingPut' /telephony/config/people/me/settings/secondaryLines/{lineownerId}/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: Get My Secondary Line Owner's Call Forwarding Settings operationId: getMySecondaryLinesCallForwardingSettings description: 'Get details of call forwarding settings associated with a secondary line of the authenticated user. Note that an authenticated user can only retrieve information for their configured secondary lines. 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 user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: - name: lineownerId in: path description: Unique identifier for the secondary line owner (applicable only for Virtual Lines). required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU 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 My Secondary Line Owner's Call Forwarding Settings operationId: modifyMySecondaryLinesCallForwardingSettings description: 'Update call forwarding settings associated with a secondary line owner of the authenticated user. Note that an authenticated user can only modify information for their configured secondary lines. 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 user auth token with a scope of `spark:telephony_config_write`.' tags: - Call Settings For Me parameters: - name: lineownerId in: path description: Unique identifier for the secondary line owner (applicable only for Virtual Lines). required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU schema: type: string requestBody: content: application/json: example: callForwarding: always: enabled: false ringReminderEnabled: false destinationVoicemailEnabled: false busy: enabled: false destinationVoicemailEnabled: false noAnswer: enabled: false numberOfRings: 2 destinationVoicemailEnabled: false businessContinuity: enabled: false destinationVoicemailEnabled: false schema: $ref: '#/components/schemas/CallForwardingPut' /telephony/config/people/me/settings/callPickupGroup: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallPickupGroupSettingsGet' example: groupName: Business Agents Call Pickup memberList: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU type: PEOPLE firstName: John lastName: Doe departmentName: Electric directNumber: '+19075551234' extension: '1234' email: abc@gmail.com '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 My Call Pickup Group Settings operationId: getMyCallPickupGroupSettings description: 'Get Call Pickup Group Settings for the authenticated user. Call pickup group enables a user to answer any ringing line within their pickup group. A call pickup group is an administrator-defined set of users within a location, to which the call pickup feature applies. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: [] /telephony/config/people/me/settings/secondaryLines/{lineownerId}/callPickupGroup: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallPickupGroupSettingsGet' example: groupName: Business Agents Call Pickup memberList: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU type: PEOPLE firstName: John lastName: Doe departmentName: Electric directNumber: '+19075551234' extension: '1234' email: abc@gmail.com '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 My Secondary Line Owner Call Pickup Group Settings operationId: getMySecondaryLinesCallPickupGroupSettings description: 'Get Call Pickup Group Settings for the secondary line owner of the authenticated user. Note that the secondary line information is only available for the authenticated user. Call pickup group enables a user to answer any ringing line within their pickup group. A call pickup group is an administrator-defined set of users within a location, to which the call pickup feature applies. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: - name: lineownerId in: path description: Unique identifier for the secondary line owner (applicable only for Virtual Lines). required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU schema: type: string /telephony/config/people/me/settings/callPark: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UserCallParkSettingsGetResponseObject' example: groupName: technical support - cards - customer 1 memberList: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU type: PEOPLE firstName: John lastName: Doe displayName: John Doe - id: Y2lzY29zcGFyazovL3VzL1BMQUNFLzgzYjQ0OTIyLWZlOWYtMTFlYi1hNGI4LTMzNjI3YmVkNjdiNQ type: PLACE displayName: Jack Hughes - id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85M2I0NDkyMi1mZTlmLTExZWItYTRiOC0zMzYyN2JlZDY3YjY type: VIRTUAL_LINE firstName: Smith lastName: Bob displayName: Bob Smith '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 My Call Park Settings operationId: getMyCallParkSettings description: 'Get details of call park settings associated with the authenticated user. Call Park allows call recipients to place a call on hold so that it can be retrieved from another device. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: [] /telephony/config/people/me/settings/secondaryLines/{lineownerId}/callPark: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UserCallParkSettingsGetResponseObject' example: groupName: technical support - cards - customer 1 memberList: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU type: PEOPLE firstName: John lastName: Doe displayName: John Doe - id: Y2lzY29zcGFyazovL3VzL1BMQUNFLzgzYjQ0OTIyLWZlOWYtMTFlYi1hNGI4LTMzNjI3YmVkNjdiNQ type: PLACE displayName: Jack Hughes - id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85M2I0NDkyMi1mZTlmLTExZWItYTRiOC0zMzYyN2JlZDY3YjY type: VIRTUAL_LINE firstName: Smith lastName: Bob displayName: Bob Smith '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 My Secondary Line Owner Call Park Settings operationId: getMySecondaryLinesCallParkSettings description: 'Get details of call park settings for the secondary line owner of the authenticated user. Note that the secondary line information is only available for the authenticated user. Call Park allows call recipients to place a call on hold so that it can be retrieved from another device. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: - name: lineownerId in: path description: Unique identifier for the secondary line owner (applicable only for Virtual Lines). required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU schema: type: string /telephony/config/people/me/settings/voicemail: 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: modifyMyVoicemailSettings 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. 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 user auth token with a scope of `spark-admin:people_write`.' tags: - Call Settings For Me parameters: [] 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' 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 audioFile: name: customGreeting.wav mediaType: WAV sendUnansweredCalls: enabled: false greeting: DEFAULT greetingUploaded: true numberOfRings: 3 systemMaxNumberOfRings: 20 audioFile: name: customGreeting.wav mediaType: WAV 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: getMyVoicemailSettings 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. 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 user auth token with a scope of `spark-admin:people_read`.' tags: - Call Settings For Me parameters: [] /telephony/config/people/me/settings/secondaryLines/{lineownerId}/voicemail: 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 My Secondary Line Owner's Voicemail Settings operationId: modifyMySecondaryLinesVoicemailSettings description: 'Update voicemail settings associated with a secondary line owner of the authenticated user. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via voicemail. 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 user auth token with a scope of `spark-admin:people_write`.' tags: - Call Settings For Me parameters: - name: lineownerId in: path description: Unique identifier for the secondary line owner (applicable only for Virtual Lines). required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU 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' 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: Get My Secondary Line Owner's Voicemail Settings operationId: getMySecondaryLinesVoicemailSettings description: 'GET voicemail settings for a secondary line of the authenticated user. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via voicemail. 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 user auth token with a scope of `spark-admin:people_read`.' tags: - Call Settings For Me parameters: - name: lineownerId in: path description: Unique identifier for the secondary line owner (applicable only for Virtual Lines). required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU schema: type: string /telephony/config/people/me/settings/callBlock: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UserBlockGetResponseObject' example: numbers: - id: KzE4OTc2NTQzMjE1 phoneNumber: '+18976543215' - id: KzE4OTc2NTQzMzE1 phoneNumber: '+18976543315' - id: KzE4OTc2NTQzNDE1 phoneNumber: '+18976543415' - id: KzE5OTc2NTQzNDE1 phoneNumber: '+19976543415' '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 My Call Block Settings operationId: getMyCallBlockSettings description: 'Get details of call block settings associated with the authenticated user. Call block settings allow you to get the User Call Block Number List. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: [] /telephony/config/people/me/settings/callBlock/numbers: post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id properties: id: type: string description: Unique identifier for the phone number. example: id: Y2lzY29zcGFyazovL3VzL1BIT05FX05VTUJFUi9LekU1TnpnNU5EWTJOelkz '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 phone number to user's Call Block List operationId: addPhoneNumberToMyCallBlockList description: 'Add a phone number to the call block list for the authenticated user. Call block settings allow you to get the User Call Block Number List. This API requires a user auth token with a scope of `spark:telephony_config_write`.' tags: - Call Settings For Me parameters: [] requestBody: content: application/json: example: phoneNumber: '+19075552859' schema: $ref: '#/components/schemas/CallBlockNumberPost' /telephony/config/people/me/settings/callBlock/numbers/{phoneNumberId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/UserBlockStateGetResponseObject' example: blockCallsEnabled: 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 My Call Block State For Specific Number operationId: getMyCallBlockStateForASpecificNumber description: 'Get call block state details for a specific number associated with the authenticated user. Call block settings allow you to get the User Call Block Number List. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: - name: phoneNumberId in: path description: Unique identifier of the phone number. required: true example: Y2lzY29zcGFyazovL3VzL1BIT05FX05VTUJFUi9LekU0T1RjMk5UUXpNekUx schema: type: string 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 User Call Block Number operationId: deleteMyCallBlockNumber description: 'Delete call block number settings associated with the authenticated user. Call block settings allow you to delete a number from the User Call Block Number List. This API requires a user auth token with a scope of `spark-admin:people_write`.' tags: - Call Settings For Me parameters: - name: phoneNumberId in: path description: Unique identifier of the phone number. required: true example: Y2lzY29zcGFyazovL3VzL1BIT05FX05VTUJFUi9LekU0T1RjMk5UUXpNekUx schema: type: string /telephony/config/people/me/settings/monitoring: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/MonitoringSettingsGetResponseObject' example: callParkNotificationEnabled: true monitoredElements: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85M2JjZWQ2Mi1lYWRmLTQ0MGItYThiYi03ZWQ5ZWEwNzExMTg lastName: Nelson firstName: John displayName: John Nelson type: PEOPLE email: john.nelson@gmail.com extension: '50003' esn: '50003' locationName: San Francisco locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFiNDIzN2U4LWE2MDYtNGM5Ni1iMDZmLTYzMmU5N2FjZmQxNg - id: Y2lzY29zcGFyazovL3VzL0NBTExfUEFSS19FWFRFTlNJT04vNDk1ZTgxMTEtY2U4My00ZTc5LWJjOTAtODM2OWQxZjY0NTQ2 displayName: Dallas-Test type: CALL_PARK_EXTENSION extension: '10082' locationName: San Francisco locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFiNDIzN2U4LWE2MDYtNGM5Ni1iMDZmLTYzMmU5N2FjZmQxNg - id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS9mZTg5NmVmMC1iYTk3LTQ3NGYtOTMwZS03ODQxYzUwMjFhNDU= displayName: TXS16 ConfRoom1 type: PLACE email: fe896ef0-ba97-474f-930e-7841c5021a45@csg1test.room.wbx2.com directNumber: '+15594015485' locationName: San Francisco locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFiNDIzN2U4LWE2MDYtNGM5Ni1iMDZmLTYzMmU5N2FjZmQxNg '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 My Monitoring Settings operationId: getMyMonitoringSettings description: 'Retrieves the monitoring settings of the logged in person, which shows specified people, places, virtual lines or call park extensions 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 user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: [] /telephony/config/people/me/settings/queues: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallQueueSettingsGetResponseObject' example: agentACDState: AVAILABLE queues: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85M2JjZWQ2Mi1lYWRmLTQ0MGItYThiYi03ZWQ5ZWEwNzExMTg hasCxEssentials: true available: true skillLevel: 1 phoneNumber: '+18555550101' extension: '50001' allowLogOffEnabled: false - id: Y2lzY29zcGFyazovL3VzL0NBTExfUEFSS19FWFRFTlNJT04vNDk1ZTgxMTEtY2U4My00ZTc5LWJjOTAtODM2OWQxZjY0NTQ2 hasCxEssentials: false available: false extension: '50002' allowLogOffEnabled: 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 My Call Center Settings operationId: getMyCallCenterSettings description: 'Retrieves the call center settings and list of all call centers the logged in user belongs to. Calls from the Call Centers are routed to agents based on configuration. An agent can be assigned to one or more call queues and can be managed by supervisors. The user must have the call center service assigned. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: [] 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 My Call Center Settings operationId: modifyMyCallCenterSettings description: 'Modify the call center settings and availability for an agent in one or more call centers to which the logged in user belongs. Calls from the Call Centers are routed to agents based on configuration. An agent can be assigned to one or more call queues and can be managed by supervisors. Contains a list specifying the desired availability status of one or more call centers. This API requires a user auth token with a scope of `spark:telephony_config_write`.' tags: - Call Settings For Me parameters: [] requestBody: content: application/json: example: agentACDState: AVAILABLE queues: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85M2JjZWQ2Mi1lYWRmLTQ0MGItYThiYi03ZWQ5ZWEwNzExMTg available: true - id: Y2lzY29zcGFyazovL3VzL0NBTExfUEFSS19FWFRFTlNJT04vNDk1ZTgxMTEtY2U4My00ZTc5LWJjOTAtODM2OWQxZjY0NTQ2 available: false schema: $ref: '#/components/schemas/CallQueueSettingsPut' /telephony/config/people/me/settings/secondaryLines/{lineownerId}/queues: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallQueueSettingsGetResponseObject' example: agentACDState: AVAILABLE queues: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85M2JjZWQ2Mi1lYWRmLTQ0MGItYThiYi03ZWQ5ZWEwNzExMTg hasCxEssentials: true available: true skillLevel: 1 phoneNumber: '+18555550101' extension: '50001' allowLogOffEnabled: false - id: Y2lzY29zcGFyazovL3VzL0NBTExfUEFSS19FWFRFTlNJT04vNDk1ZTgxMTEtY2U4My00ZTc5LWJjOTAtODM2OWQxZjY0NTQ2 hasCxEssentials: false available: false extension: '50002' allowLogOffEnabled: 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 My Secondary Line Owner's Call Center Settings operationId: getMySecondaryLinesCallCenterSettings description: 'Retrieves the call center settings and list of all call centers associated with a secondary line of the authenticated user. Note that an authenticated user can only retrieve information for their configured secondary lines. Calls from the Call Centers are routed to agents based on configuration. An agent can be assigned to one or more call queues and can be managed by supervisors. The secondary line must have the call center service assigned. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: - name: lineownerId in: path description: Unique identifier for the secondary line owner (applicable only for Virtual Lines). required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU 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 My Secondary Line Owner's Call Center Settings operationId: modifyMySecondaryLinesCallCenterSettings description: 'Modify the call center settings and availability for an agent in one or more call centers associated with a secondary line owner of the authenticated user. Note that an authenticated user can only modify information for their configured secondary lines. Calls from the Call Centers are routed to agents based on configuration. An agent can be assigned to one or more call queues and can be managed by supervisors. Contains a list specifying the desired availability status of one or more call centers. This API requires a user auth token with a scope of `spark:telephony_config_write`.' tags: - Call Settings For Me parameters: - name: lineownerId in: path description: Unique identifier for the secondary line owner (applicable only for Virtual Lines). required: true example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU schema: type: string requestBody: content: application/json: example: agentACDState: AVAILABLE queues: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85M2JjZWQ2Mi1lYWRmLTQ0MGItYThiYi03ZWQ5ZWEwNzExMTg available: true - id: Y2lzY29zcGFyazovL3VzL0NBTExfUEFSS19FWFRFTlNJT04vNDk1ZTgxMTEtY2U4My00ZTc5LWJjOTAtODM2OWQxZjY0NTQ2 available: false schema: $ref: '#/components/schemas/CallQueueSettingsPut' /telephony/config/people/me/settings/callCaptions: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetUserCallCaptionsObject' example: userClosedCaptionsEnabled: true userTranscriptsEnabled: 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 my call captions settings operationId: getMyCallCaptionsSettings description: 'Retrieve the effective call captions settings of the authenticated user. **NOTE**: The call captions feature is not supported for Webex Calling Standard users or users assigned to locations in India. The call caption feature allows the customer to enable and manage closed captions and transcript functionality (rolling caption panel) in Webex Calling, without requiring the user to escalate the call to a meeting. This API requires a user auth token with a scope of `spark:telephony_config_read`.' tags: - Call Settings For Me parameters: [] components: schemas: 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. AgentACDStateType: type: string example: AVAILABLE enum: - SIGN_IN - SIGN_OUT - AVAILABLE - UNAVAILABLE - WRAP_UP description: " * `SIGN_IN` - Agent has signed in.\n * `SIGN_OUT` - Agent has signed out.\n * `AVAILABLE` - Agent is available.\n * `UNAVAILABLE` - Agent is unavailable.\n * `WRAP_UP` - Agent has wrapped up.\n" UserDNDWebexGoOverridePatch: type: object description: Request Payload to update the "Mobile User Aware" override setting for Do Not Disturb feature. properties: enabled: type: boolean example: true description: True if the "Mobile User Aware" override setting for Do Not Disturb feature is enabled. CallPickupGroupMember: type: object description: Represents a member of a call pickup group. example: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU type: PEOPLE firstName: John lastName: Doe departmentName: Electric directNumber: '+19075551234' extension: '1234' email: abc@gmail.com required: - id - type - firstName - lastName - departmentName - email properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU description: Unique identifier for the member. type: $ref: '#/components/schemas/MemberType' firstName: type: string example: John description: First name of the member. lastName: type: string example: Doe description: Last name of the member. departmentName: type: string example: Electric description: Department name of the member. directNumber: type: string example: '+19075551234' description: Direct number of the member. extension: type: string example: '1234' description: Extension of the member. email: type: string example: abc@gmail.com description: Email address of the member. UserCallRecordingGetResponseObject: type: object description: Response object for the user call recording settings. example: enabled: true vendor: id: Y2lzY29zcGFyazovL3VzL1JFQ09SRElOR19WRU5ET1IvZmVjYjYzNGUtYzMyZS00ZWJmLThlYzMtMmVhYjk3Y2IyNjNk name: ITFDual loginUrl: https://www.itfdualportal.com recordingMode: On Demand pauseResumeNotifyMethod: Beep announcementEnabled: true warningToneEnabled: false warningToneDuration: 70 required: - enabled - vendor - recordingMode properties: enabled: type: boolean example: true description: Indicates whether Call Recording is enabled for the user or not. vendor: type: object description: List of available vendors and their details. required: - id - name - loginUrl properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1JFQ09SRElOR19WRU5ET1IvZmVjYjYzNGUtYzMyZS00ZWJmLThlYzMtMmVhYjk3Y2IyNjNk description: Unique identifier of a vendor. name: type: string example: Dubber description: Name of a call recording vendor. loginUrl: type: string example: https://wxc-us.dubber.net/login?sso=webex description: Login URL of the vendor. recordingMode: $ref: '#/components/schemas/RecordingModeType' pauseResumeNotifyMethod: $ref: '#/components/schemas/PauseResumeNotifyMethodType' announcementEnabled: type: boolean example: true description: If `true`, an announcement is played when call recording starts. warningToneEnabled: type: boolean description: If `true`, a warning tone is played when call recording starts. warningToneDuration: type: number example: 70 description: Duration of the warning tone in seconds. Duration can be configured between 10 and 1800 seconds. UserNumber: type: object description: Details of a phone number associated with the user. example: directNumber: '+441234222304' enterprise: '832731599' extension: '31599' routingPrefix: '8327' esn: '832731599' primary: true required: - directNumber - enterprise - extension - routingPrefix - esn - primary properties: directNumber: type: string example: '+441234222304' description: Direct number of the user. enterprise: type: string example: '832731599' description: Enterprise number of the user. This always combines the location routing prefix with the user's extension, and is only present when both are present. That is, the location has a routing prefix and the user has an extension. extension: type: string example: '31599' description: Extension of the user. This is always the user's extension, only present if the user has an extension. routingPrefix: type: string example: '8327' description: Routing prefix of the user. esn: type: string example: '832731599' description: Enterprise Significant Number. This combines the location routing prefix and extension when both are set, and only the extension when the location routing prefix is not set. if the extension is not set, the esn is not present. primary: type: boolean example: true description: Indicates if the number is primary or alternate number. endpoints: type: object required: - id - type - name properties: id: type: string example: Y2lzY29z... description: Unique identifier for the endpoint. type: $ref: '#/components/schemas/DeviceType' description: Enumeration that indicates if the endpoint is of type `DEVICE` or `APPLICATION`. name: type: string example: Cisco 8865 (Phone in reception area) description: The `name` field in the response is calculated using device tag. Admins have the ability to set tags for devices. If a `name=` tag is set, for example “name=home phone“, then the `` is included in the `name` field of the API response. In this example “home phone”. ServicesEnum: type: string example: Authentication enum: - Anonymous Call Rejection - Authentication - Call Forwarding Always - Call Forwarding Busy - Call Forwarding No Answer - Call Notify - Calling Line ID Delivery Blocking - Do Not Disturb - Intercept User - Last Number Redial - Priority Alert - Call Return - Selective Call Acceptance - Call Forwarding Selective - Selective Call Rejection - Simultaneous Ring Personal - Voice Messaging User - Alternate Numbers - Shared Call Appearance 35 - Speed Dial 100 - Directed Call Pickup - Directed Call Pickup with Barge-in - External Calling Line ID Delivery - Internal Calling Line ID Delivery - Call Waiting - Barge-in Exempt - Push to Talk - Basic Call Logs - Hoteling Host - Hoteling Guest - Multiple Call Arrangement - Busy Lamp Field - Three-Way Call - Call Transfer - Privacy - Fax Messaging - N-Way Call - Call Forwarding Not Reachable - Connected Line Identification Presentation - Connected Line Identification Restriction - BroadWorks Anywhere - Music On Hold User - Call Center Monitoring - BroadWorks Mobility - Call Recording - Executive - Client License 17 - Client License 18 - Flexible Seating Guest - Personal Assistant - Sequential Ring - Call Block description: " * `Anonymous Call Rejection` - When enabled, blocks all incoming calls from unidentified or blocked caller IDs.\n * `Authentication` - Requires the user to enter a password before making a call.\n * `Call Forwarding Always` - Forwards all incoming calls to another number.\n * `Call Forwarding Busy` - Forwards incoming calls to another number when the user is on another call.\n * `Call Forwarding No Answer` - Forwards incoming calls to another number when the user does not answer.\n * `Call Notify` - Notifies the user of incoming calls.\n * `Calling Line ID Delivery Blocking` - Blocks the delivery of the user's caller ID to the recipient.\n * `Do Not Disturb` - Blocks all incoming calls.\n * `Intercept User` - Allows the user to intercept another user's calls.\n * `Last Number Redial` - Redials the last number called.\n * `Priority Alert` - Alerts the user of incoming calls with a distinctive ring.\n * `Call Return` - Returns the last call received.\n * `Selective Call Acceptance` - Accepts only calls from a list of pre-approved numbers.\n * `Call Forwarding Selective` - Forwards calls from a list of pre-approved numbers.\n * `Selective Call Rejection` - Rejects calls from a list of pre-approved numbers.\n * `Simultaneous Ring Personal` - Rings multiple numbers at the same time.\n * `Voice Messaging User` - Allows the user to access voicemail.\n * `Alternate Numbers` - Allows the user to have multiple numbers.\n * `Shared Call Appearance 35` - Allows the user to share a call appearance with another user.\n * `Speed Dial 100` - Allows the user to dial a number by pressing a single key.\n * `Directed Call Pickup` - Allows the user to pick up a call directed to another user.\n * `Directed Call Pickup with Barge-in` - Allows the user to pick up a call directed to another user and join the call.\n * `External Calling Line ID Delivery` - Displays the caller's ID on the user's phone.\n * `Internal Calling Line ID Delivery` - Displays the caller's ID on the user's phone.\n * `Call Waiting` - Alerts the user of incoming calls when they are on another call.\n * `Barge-in Exempt` - Prevents other users from barging in on the user's calls.\n * `Push to Talk` - Allows the user to push a button to talk.\n * `Basic Call Logs` - Logs the user's call history.\n * `Hoteling Host` - Allows the user to host a hoteling session.\n * `Hoteling Guest` - Allows the user to join a hoteling session.\n * `Multiple Call Arrangement` - Allows the user to have multiple calls at the same time.\n * `Busy Lamp Field` - Allows the user to monitor the status of another user's phone.\n * `Three-Way Call` - Allows the user to have a three-way call.\n * `Call Transfer` - Allows the user to transfer a call.\n * `Privacy` - Allows the user to keep their number private.\n * `Fax Messaging` - Allows the user to send and receive faxes.\n * `N-Way Call` - Allows the user to have an N-way call.\n * `Call Forwarding Not Reachable` - Forwards calls when the user is not reachable.\n * `Connected Line Identification Presentation` - Displays the caller's ID on the user's phone.\n * `Connected Line Identification Restriction` - Prevents the caller's ID from being displayed on the user's phone.\n * `BroadWorks Anywhere` - Allows the user to make calls from any phone.\n * `Music On Hold User` - Allows the user to listen to music while on hold.\n * `Call Center Monitoring` - Allows the user to monitor a call center.\n * `BroadWorks Mobility` - Allows the user to use BroadWorks Mobility.\n * `Call Recording` - Allows the user to record calls.\n * `Executive` - Allows the user to have an executive assistant.\n * `Client License 17` - Allows the user to use client license 17.\n * `Client License 18` - Allows the user to use client license 18.\n * `Flexible Seating Guest` - Allows the user to be a flexible seating guest.\n * `Personal Assistant` - Allows the user to have a personal assistant.\n * `Sequential Ring` - Allows the user to have a sequential ring.\n * `Call Block` - Allows the user to block calls.\n" Assistant: type: object description: Details of an executive assistant. example: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU firstName: doe lastName: John phoneNumber: +91-6557765419 extension: '10079' optInEnabled: true location: name: Bangalore id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzMGMzYTNlLTA3Y2EtNDNmOS1iZjE4LTZlZGM2OGE1Y2Y3Yg required: - id - optInEnabled - location properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU description: Unique identifier of the assistant. firstName: type: string example: doe description: Unicode first name of the assistant. Is null if not available or if name is a single '.' or '-'. lastName: type: string example: John description: Unicode last name of the assistant. Is null if not available or if name is a single '.' or '-'. directNumber: type: string example: +91-6557765419 description: Direct number of the assistant. extension: type: string example: '10079' description: Extension number of the assistant. optInEnabled: type: boolean example: true description: If `true`, the assistant has opted in to handle calls for the executive. If `false`, the assistant has not opted in. location: $ref: '#/components/schemas/Location' DeviceType: type: string enum: - DEVICE - APPLICATION description: " * `DEVICE` - The endpoint is a device.\n * `APPLICATION` - The endpoint is a application.\n" FeatureAccessCode: type: object description: Details of a feature access code configured for services that are assigned to the authenticated user. example: name: Call Forwarding Busy Interrogation code: '*67*' alternateCode: '*18' required: - name - code properties: name: type: string example: Call Forwarding Busy Interrogation description: Feature Access Code name. code: type: string example: '*67*' description: Feature Access Code. alternateCode: type: string example: '*18' description: Alternate Code for the Feature Access Code. SecondaryLine: type: object description: Details of a secondary line associated with the endpoint. example: id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS82NDhjYjBkMC1kODU2LTQzNzQtYmI4My0zNWFhNTIxZDhiZmI memberType: VIRTUAL_LINE required: - id - memberType properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS82NDhjYjBkMC1kODU2LTQzNzQtYmI4My0zNWFhNTIxZDhiZmI description: Unique identifier for the member. memberType: $ref: '#/components/schemas/MemberType' HostObject: type: object description: '`HOTDESKING_GUEST` endpoints include the `host` element when the user has an active hotdesking session on a host.' required: - id - type - name - autoAndForcedAnswerEnabled properties: id: type: string example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS85MGQyMmM0Yy0wMGI3LTQ4YzAtYjUwNi0yM2UwY2E2MTlkYmM description: Unique identifier of the endpoint. type: $ref: '#/components/schemas/EndpointType' name: type: string example: Webex Go Device description: Name of the endpoint. autoAndForcedAnswerEnabled: type: boolean example: true description: If `true`, the endpoint can be remotely controlled, allowing actions such as mute, hold, resume and answer. ownerId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNTlkYzFkOC00NjdkLTRhNGUtOTRlNi1jOTYyZjEyMmY5YWM description: Unique identifier of the endpoint owner. ownerType: $ref: '#/components/schemas/MemberType' secondaryLines: type: array items: $ref: '#/components/schemas/SecondaryLine' description: List of secondary lines. The secondary line information is not returned for the endpoint owned by an entity other than the authenticated user. UserDevice: type: object description: Details of a device associated with the user. example: description: [] model: DMS Cisco 8865 mac: '110723241134' primaryOwner: true type: PRIMARY owner: lastName: Mac firstName: Jone type: PEOPLE activationState: ACTIVATED required: - description - model - mac - primaryOwner - type - owner - activationState properties: description: type: array items: type: string example: '[]' description: A tag used to describe the device. description: Comma separated array of tags used to describe device. model: type: string example: DMS Cisco 8865 description: Identifier for device model. mac: type: string example: '110723241134' description: MAC address of the device. primaryOwner: type: boolean example: true description: Indicates whether the person or the workspace is the owner of the device, and points to a primary Line/Port of the device. type: $ref: '#/components/schemas/DeviceTypeObject' owner: $ref: '#/components/schemas/OwnerObject' activationState: $ref: '#/components/schemas/DeviceActivationState' CallBlockNumberPost: type: object description: Request object for adding a phone number to the user's call block list. example: phoneNumber: '+19075552859' required: - phoneNumber properties: phoneNumber: type: string example: '+12025551212' description: Phone number which is blocked by user. PauseResumeNotifyMethodType: type: string enum: - Beep - Play Announcement description: " * `Beep` - A beep is played when call recording is paused or resumed.\n * `Play Announcement` - An announcement is played when call recording is paused or resumed.\n" ExecutiveAvailableAssistantsGet: type: object example: assistants: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU firstName: doe lastName: John directNumber: +91-6557765419 extension: '10079' properties: assistants: type: array items: $ref: '#/components/schemas/AvailableAssistant' description: List of people available for assignment as executive assistants. Location: type: object description: Details of the location for the assigned assistant. example: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzMGMzYTNlLTA3Y2EtNDNmOS1iZjE4LTZlZGM2OGE1Y2Y3Yg name: Bangalore required: - name - id properties: name: type: string example: Bangalore description: Name of the location. id: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzMGMzYTNlLTA3Y2EtNDNmOS1iZjE4LTZlZGM2OGE1Y2Y3Yg description: Unique identifier of the location. Executive: type: object description: Details of an executive for whom the assistant can manage calls. example: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZWQzNDg0MS0yZTkwLTQ4OGEtYmVmZi1iNTk0OTA1ODFkNWM firstName: John lastName: Doe directNumber: +91-6557765419 extension: '10079' optInEnabled: true required: - id - directNumber - extension - optInEnabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZWQzNDg0MS0yZTkwLTQ4OGEtYmVmZi1iNTk0OTA1ODFkNWM description: Unique identifier of the executive. firstName: type: string example: John description: Unicode first name of the executive. Is null if not available or if the name is a single ‘.’ or ‘-’. lastName: type: string example: Doe description: Unicode last name of the executive. Is null if not available or if the name is a single ‘.’ or ‘-’. directNumber: type: string example: '+916557765419' description: Direct number of the executive. extension: type: string example: '10079' description: Extension number of the executive. optInEnabled: type: boolean example: true description: If `true`, the assistant has opted in to handle calls for the executive. MonitoredElementUser: type: object required: - id - firstName - lastName - displayName - type - email - numbers - location - locationId properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80NDVkMzMzMC1mNjE3LTExZWItOWQyZS01NzViODE3ZGE2NmE description: ID of person or workspace. firstName: type: string example: John description: First name of person or workspace. lastName: type: string example: Brown description: Last name of person or workspace. displayName: type: string example: John Brown description: Display name of person or workspace. type: type: string enum: - PEOPLE - PLACE description: "Type of the person or workspace.\n * `PEOPLE` - Object is a user.\n * `PLACE` - Object is a workspace.\n" email: type: string example: john.brown@gmail.com description: Email of the person or workspace. numbers: type: array items: $ref: '#/components/schemas/UserNumberItem' description: The list of phone numbers containing only the primary number for the monitored person, workspace. location: type: string example: Alaska description: Name of location for call park. locationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1 description: ID of the location for call park. CallQueueSettingsPut: type: object description: Request body for modifying call center settings and availability for an agent in one or more call centers. example: agentACDState: AVAILABLE queues: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85M2JjZWQ2Mi1lYWRmLTQ0MGItYThiYi03ZWQ5ZWEwNzExMTg available: true - id: Y2lzY29zcGFyazovL3VzL0NBTExfUEFSS19FWFRFTlNJT04vNDk1ZTgxMTEtY2U4My00ZTc5LWJjOTAtODM2OWQxZjY0NTQ2 available: false properties: agentACDState: $ref: '#/components/schemas/AgentACDStateType' queues: type: array items: $ref: '#/components/schemas/CallQueuePut' description: Indicates a list of call centers the agent has joined or may join. CallQueueGet: type: object description: Details of a call queue that the agent has joined or may join. example: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85M2JjZWQ2Mi1lYWRmLTQ0MGItYThiYi03ZWQ5ZWEwNzExMTg hasCxEssentials: true available: true skillLevel: 1 phoneNumber: '+18555550101' extension: '50001' allowLogOffEnabled: false required: - id - allowLogOffEnabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85M2JjZWQ2Mi1lYWRmLTQ0MGItYThiYi03ZWQ5ZWEwNzExMTg description: Unique call queue identifier. hasCxEssentials: type: boolean example: true description: Indicates if the call queue is `normal` or `CxEssentials`. available: type: boolean example: true description: When `true` it indicates agent has joined the call center. skillLevel: type: number example: 1 description: Call center skill level. phoneNumber: type: string example: '+18555550101' description: Call center phone number. extension: type: string example: '50001' description: Call center extension. allowLogOffEnabled: type: boolean example: false description: Determines whether a queue can be joined or not. OwnerObject: type: object description: Details of the owner of the device. example: lastName: Mac firstName: Jone type: PEOPLE required: - lastName - firstName - type properties: lastName: type: string example: user description: First name of device owner. firstName: type: string example: user1 description: Last name of device owner. type: $ref: '#/components/schemas/MemberType' CallerIdSettingsPut: type: object description: Request Payload to update caller ID settings. properties: callingLineIdDeliveryBlockingEnabled: type: boolean example: true description: If `true`, the user's name and phone number are not shown to people they call. connectedLineIdentificationRestrictionEnabled: type: boolean description: If `true`, the user's name and phone number are not shown when receiving a call. 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. GetSingleNumberReachObject: type: object required: - enabled - numbers properties: enabled: type: boolean example: true description: A flag to enable or disable single Number Reach. alertAllNumbersForClickToDialCallsEnabled: type: boolean description: Flag to enable alerting single number reach numbers for click to dial calls. numbers: type: array items: type: object required: - id - phoneNumber - enabled - name - doNotForwardCallsEnabled - answerConfirmationEnabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1NJTkdMRV9OVU1CRVJfUkVBQ0gvS3pFM01ERXhOVFU0TVRZNQ description: ID of Single number reach. Note that this ID contains base64 encoded phoneNumber data and can change if the phone number is modified. phoneNumber: type: string example: '+17011558169' description: The phone number that will ring when a call is received. The number should be in E.164 format. enabled: type: boolean example: true description: A flag to enable or disable this single Number Reach phone number. name: type: string example: myNumber description: Name of the single number reach phone number entry. doNotForwardCallsEnabled: type: boolean description: If enabled, the call forwarding settings of provided phone Number will not be applied. answerConfirmationEnabled: type: boolean description: If enabled, the call recipient will be prompted to press a key before being connected. description: Array of single number reach number entries. ServiceObject: type: object description: Represents a list of services that are assigned to a user. example: services: - Anonymous Call Rejection - Call Forwarding Always - Call Forwarding Busy - Call Forwarding No Answer - Call Notify required: - services properties: services: type: array items: $ref: '#/components/schemas/ServicesEnum' description: The list of allowed services. CallPickupGroupSettingsGet: type: object description: Represents the call pickup group settings for a user. example: groupName: Business Agents Call Pickup memberList: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU type: PEOPLE firstName: John lastName: Doe departmentName: Electric directNumber: '+19075551234' extension: '1234' email: abc@gmail.com required: - groupName - memberList properties: groupName: type: string example: Business Agents Call Pickup description: Name of the call pickup group. memberList: type: array items: $ref: '#/components/schemas/CallPickupGroupMember' description: List of members in the call pickup group. LocationObject: type: object required: - id - name properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzZmQ1ZDMyLTRmYmItNGNjMS04ZTYxLTE0YTA1ZDhhMTIzMw description: Unique identifier of the location. name: type: string example: RCDN description: Name of the location. ModifyEndpointObject: type: object description: Request Payload to update an endpoint. example: mobilitySettings: alertingEnabled: true required: - mobilitySettings properties: mobilitySettings: type: object required: - alertingEnabled properties: alertingEnabled: type: boolean example: true description: If `true`, alerting is enabled for the endpoint. description: Mobility settings of the endpoint. MonitoredElementCallParkExtension: type: object required: - id - name - extension - location - locationId properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80NDVkMzMzMC1mNjE3LTExZWItOWQyZS01NzViODE3ZGE2NmE description: ID of call park extension. name: type: string example: CPE1 description: Name of call park extension. extension: type: string example: '8080' description: Extension of call park extension. routingPrefix: type: string example: '1234' description: Routing prefix of location. esn: type: string example: '12348080' description: Routing prefix + extension of a person or workspace. location: type: string example: Alaska description: Name of location for call park extension. locationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1 description: ID of location for call park extension. preferredAnswerEndpointInformation: type: object description: Response object for the preferred answer endpoint information. example: endpoints: - id: Y2lzY29z... type: DEVICE name: Cisco 8865 (Phone in reception area) isPreferredAnswerEndpoint: false - id: Y2lzY29b... type: APPLICATION name: Webex Desktop Application isPreferredAnswerEndpoint: true required: - endpoints properties: endpoints: type: array items: $ref: '#/components/schemas/endpoints' description: Array of endpoints available to the person. ExecutiveAssistantSettingsGet: type: object description: Settings for an executive assistant. example: forwardFilteredCallsEnabled: true forwardToPhoneNumber: '+14155551234' executives: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZWQzNDg0MS0yZTkwLTQ4OGEtYmVmZi1iNTk0OTA1ODFkNWM firstName: John lastName: Doe directNumber: +91-6557765419 extension: '10079' optInEnabled: true required: - forwardFilteredCallsEnabled properties: forwardFilteredCallsEnabled: type: boolean example: true description: If `true`, filtered calls to assistant are forwarded to the `forwardToPhoneNumber`. forwardToPhoneNumber: type: string example: '6822234354' description: Phone number to forward calls to when `forwardFilteredCallsEnabled` is set to `true`. executives: type: array items: $ref: '#/components/schemas/Executive' description: List of executives for whom person is assigned as assistant. UserDNDWebexGoOverrideGet: type: object description: Response object for the "Mobile User Aware" override setting for Do Not Disturb feature. example: enabled: true required: - enabled properties: enabled: type: boolean example: true description: True if the "Mobile User Aware" override setting for Do Not Disturb feature is enabled. ExecutiveAssistantSettingsPut: type: object description: Request Payload to update settings for an executive assistant. example: forwardFilteredCallsEnabled: true forwardToPhoneNumber: '+19075552860' executives: - personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZWQzNDg0MS0yZTkwLTQ4OGEtYmVmZi1iNTk0OTA1ODFkNWM optInEnabled: true properties: forwardFilteredCallsEnabled: type: boolean example: true description: If `true`, filtered calls to assistant are forwarded to the `forwardToPhoneNumber`. forwardToPhoneNumber: type: string example: '+19075552860' description: Phone number to forward the filtered calls to. Mandatory if `forwardFilteredCallsEnabled` is set to true. executives: type: array items: $ref: '#/components/schemas/ExecutivePut' description: List of executives. SelectedCallerIdSettingsPut: type: object description: Request Payload to update selected caller ID settings. required: - selected properties: selected: type: object required: - type properties: type: $ref: '#/components/schemas/CallerIdType' id: type: string example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvNmU1NTVjZDAtNjM0MS00MmI4LWEyMWMtZTc1ZjIxNDQ4Mjc1 description: Unique identifier of the selected caller ID (HuntGroup / CallQueue) config. Required only when setting `CALL_QUEUE` or `HUNT_GROUP` caller IDs. directNumber: type: string example: '+19075552859' description: Direct number of the selected caller ID. Required only when setting ADDITIONAL_CLID as the selected caller ID. description: Selected caller ID settings. EndpointType: type: string enum: - CALLING_DEVICE - APPLICATION - HOTDESKING_GUEST description: " * `CALLING_DEVICE` - Endpoint is a calling device.\n * `APPLICATION` - Endpoint is an application.\n * `HOTDESKING_GUEST` - Endpoint is a hotdesking guest.\n" MemberType: type: string enum: - PEOPLE - PLACE description: " * `PEOPLE` - Indicates the associated member is a person.\n * `PLACE` - Indicates the associated member is a workspace.\n" MonitoringSettingsGetResponseObject: type: object description: Response object containing the monitoring settings for the logged in person. example: callParkNotificationEnabled: true monitoredElements: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85M2JjZWQ2Mi1lYWRmLTQ0MGItYThiYi03ZWQ5ZWEwNzExMTg lastName: Nelson firstName: John displayName: John Nelson type: PEOPLE email: john.nelson@gmail.com extension: '50003' esn: '50003' locationName: San Francisco locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFiNDIzN2U4LWE2MDYtNGM5Ni1iMDZmLTYzMmU5N2FjZmQxNg - id: Y2lzY29zcGFyazovL3VzL0NBTExfUEFSS19FWFRFTlNJT04vNDk1ZTgxMTEtY2U4My00ZTc5LWJjOTAtODM2OWQxZjY0NTQ2 displayName: Dallas-Test type: CALL_PARK_EXTENSION extension: '10082' locationName: San Francisco locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFiNDIzN2U4LWE2MDYtNGM5Ni1iMDZmLTYzMmU5N2FjZmQxNg - id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS9mZTg5NmVmMC1iYTk3LTQ3NGYtOTMwZS03ODQxYzUwMjFhNDU= displayName: TXS16 ConfRoom1 type: PLACE email: fe896ef0-ba97-474f-930e-7841c5021a45@csg1test.room.wbx2.com directNumber: '+15594015485' locationName: San Francisco locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFiNDIzN2U4LWE2MDYtNGM5Ni1iMDZmLTYzMmU5N2FjZmQxNg required: - callParkNotificationEnabled - monitoredElements properties: callParkNotificationEnabled: type: boolean example: true description: Call park notification is enabled or disabled. Only applies to monitored users, workspaces, and virtual lines. Does not apply to call park extensions. monitoredElements: type: array items: $ref: '#/components/schemas/MonitoredElementItem' description: Settings of monitored elements which can be person, place, virtual line or call park extension. UserProfileGetResponseObject: type: object description: User profile details for the authenticated user. example: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYWZiM2JhYi1hN2UxLTQ1ZGUtYmYzZS1kOWUxMzkxYzU0Yjk lastName: Doe firstName: John email: john.doe@gmail.com announcementLanguage: English locationDialingCode: '8327' supportMobility: false emergencyCallBackNumber: '+16232992720' phoneNumbers: - directNumber: '+441234222304' enterprise: '832731599' extension: '31599' routingPrefix: '8327' esn: '832731599' primary: true - directNumber: '+441234200015' enterprise: '832731587' extension: '31587' routingPrefix: '8327' esn: '832731587' primary: false devices: - description: [] model: DMS Cisco 8865 mac: '110723241134' primaryOwner: true type: PRIMARY owner: lastName: Mac firstName: Jone type: PEOPLE activationState: ACTIVATED location: name: Brampton address: address1: mclean address2: mclean city: mclean state: GB-BGE postalCode: '112233' country: GB receptionistUrl: https://cisco.receptionist.cloud callingHostUrl: https://var-int.broadcloudpbx.net attendantConsoleUrl: https://cisco.receptionist.cloud required: - id - lastName - firstName - email - announcementLanguage - locationDialingCode - supportMobility - emergencyCallBackNumber - phoneNumbers - devices - location - receptionistUrl - callingHostUrl - attendantConsoleUrl properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYWZiM2JhYi1hN2UxLTQ1ZGUtYmYzZS1kOWUxMzkxYzU0Yjk description: Unique identifier of the user. lastName: type: string example: John description: Last name of the user. firstName: type: string example: Doe description: First name of the user. email: type: string example: John.doe@gmail.com' description: The email addresses of the person. announcementLanguage: type: string example: English description: Language for announcements. locationDialingCode: type: string example: '8327' description: Dialing code for the user's location. supportMobility: type: boolean description: If `true`, the user supports mobility. emergencyCallBackNumber: type: string example: '+16232992720' description: Emergency callback number for the user. phoneNumbers: type: array items: $ref: '#/components/schemas/UserNumber' description: List of numbers associated with the user. devices: type: array items: $ref: '#/components/schemas/UserDevice' description: List of devices associated with the user. location: $ref: '#/components/schemas/LocationObject' receptionistUrl: type: string example: https://cisco.receptionist.cloud description: URL for the receptionist console. callingHostUrl: type: string example: https://var-int.broadcloudpbx.net description: URL for the calling host. attendantConsoleUrl: type: string example: https://cisco.receptionist.cloud description: URL for the attendant console. RecordingModeType: type: string enum: - Always - Never - On Demand - Always with Pause/Resume - On Demand with User Initiated Start description: " * `Always` - Call recording is always enabled.\n * `Never` - Call recording is never enabled.\n * `On Demand` - Call recording is started and stopped manually by the user.\n * `Always with Pause/Resume` - Call recording is always enabled with the ability to pause and resume.\n * `On Demand with User Initiated Start` - Call recording is started manually by the user.\n" ExecutiveAssignedAssistantsPatchRequestObject: type: object description: Request object for updating executive assigned assistants. example: allowOptInOutEnabled: false assistantIds: - Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mM2ZjMDFlOC1iZjM3LTQyMDgtOThjZS1iMzdlYWEwYTVlY2U - Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMzRmNjdhNS1kYTFiLTQxYzUtODBkNS03ZDFmZTY3ZTE5ZTY properties: allowOptInOutEnabled: type: boolean description: If `true`, the executive can allow assistants to opt in or out of managing calls. assistantIds: type: array items: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mM2ZjMDFlOC1iZjM3LTQyMDgtOThjZS1iMzdlYWEwYTVlY2U description: Unique identifier of the assistant. description: List of unique identifiers for the assistants. ExecutivePut: type: object description: Details of an executive for whom the assistant can manage calls. example: personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZWQzNDg0MS0yZTkwLTQ4OGEtYmVmZi1iNTk0OTA1ODFkNWM optInEnabled: true required: - personId - optInEnabled properties: personId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZWQzNDg0MS0yZTkwLTQ4OGEtYmVmZi1iNTk0OTA1ODFkNWM description: Unique identifier of the executive. optInEnabled: type: boolean example: true description: If `true`, the assistant has opted in to handle calls for the executive. CallerIdType: type: string enum: - DEFAULT_CLID - ADDITIONAL_CLID - CALL_QUEUE - HUNT_GROUP description: " * `DEFAULT_CLID` - Caller ID is the default configured caller ID.\n * `ADDITIONAL_CLID` - Caller ID is an additional external caller ID phone number available for the user.\n * `CALL_QUEUE` - Caller ID is associated with a call queue.\n * `HUNT_GROUP` - Caller ID is associated with a hunt group.\n" AvailableAssistant: type: object description: Details of person available to be assigned as executive assistant. example: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU firstName: doe lastName: John directNumber: +91-6557765419 extension: '10079' required: - id properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU description: Unique identifier of the person. firstName: type: string example: doe description: Unicode first name of the person. Is null if not available or if name is a single '.' or '-'. lastName: type: string example: John description: Unicode last name of the person. Is null if not available or if name is a single '.' or '-'. directNumber: type: string example: +91-6557765419 description: Direct number of the person. extension: type: string example: '10079' description: Extension number of the person. SingleNumberReachNumber: type: object description: Represents a phone number configured for Single Number Reach. example: phoneNumber: '+19075552859' name: John enabled: true doNotForwardCallsEnabled: true answerConfirmationEnabled: false required: - phoneNumber - name - enabled - doNotForwardCallsEnabled - answerConfirmationEnabled properties: phoneNumber: type: string example: '+19075552859' description: Phone number. name: type: string example: John description: Name associated with the phone number. enabled: type: boolean example: true description: If `true`, the phone number is enabled. doNotForwardCallsEnabled: type: boolean example: true description: If `true`, calls are not forwarded. answerConfirmationEnabled: type: boolean description: If `true`, answer confirmation is enabled. FeatureAccessCodeListGetObject: type: object description: Response object for the list of feature access codes. example: featureAccessCodeList: - name: Call Forwarding Busy Interrogation code: '*67*' alternateCode: '*18' - name: Cancel Call Waiting code: '*70' - name: Call Waiting Interrogation code: '*53*' alternateCode: '*38' required: - featureAccessCodeList properties: featureAccessCodeList: type: array items: $ref: '#/components/schemas/FeatureAccessCode' description: List of feature access codes. MonitoredElementItem: type: object properties: callparkextension: $ref: '#/components/schemas/MonitoredElementCallParkExtension' description: Monitored Call Park extension. member: $ref: '#/components/schemas/MonitoredElementUser' description: Monitored member for this workspace. UserCallParkSettingsGetResponseObject: type: object description: Represents the call park settings for a user. example: groupName: technical support - cards - customer 1 memberList: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU type: PEOPLE firstName: John lastName: Doe displayName: John Doe - id: Y2lzY29zcGFyazovL3VzL1BMQUNFLzgzYjQ0OTIyLWZlOWYtMTFlYi1hNGI4LTMzNjI3YmVkNjdiNQ type: PLACE displayName: Jack Hughes - id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85M2I0NDkyMi1mZTlmLTExZWItYTRiOC0zMzYyN2JlZDY3YjY type: VIRTUAL_LINE firstName: Smith lastName: Bob displayName: Bob Smith required: - groupName - memberList properties: groupName: type: string example: technical support - cards - customer 1 description: Unique name for the call park. The maximum length is 80.. memberList: type: array items: $ref: '#/components/schemas/CallParkMember' description: List of members in the call park group. UserSingleNumberReachPatchRequestObject: type: object description: Represents a request to update Single Number Reach settings for a user. example: alertAllLocationsForClickToDialCallsEnabled: true properties: alertAllLocationsForClickToDialCallsEnabled: type: boolean example: true description: If `true`, all locations will be alerted for click-to-dial calls. SelectedCallerIdSettingsGet: type: object description: Response object for the selected caller ID settings. example: selected: type: CALL_QUEUE id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNmU1NTVjZDAtNjM0MS00MmI4LWEyMWMtZTc1ZjIxNDQ4Mjc1 name: Call Queue DND directNumber: '+19075552859' extension: '10079' required: - selected properties: selected: type: object required: - type properties: type: $ref: '#/components/schemas/CallerIdType' id: type: string example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNmU1NTVjZDAtNjM0MS00MmI4LWEyMWMtZTc1ZjIxNDQ4Mjc1 description: Unique identifier of the selected caller ID config. Set for `CALL_QUEUE` & `HUNT_GROUP` caller IDs. name: type: string example: Call Queue DND description: Name of the selected caller ID. directNumber: type: string example: '+19075552859' description: Direct number of the selected caller ID. extension: type: string example: '10079' description: Extension of the selected caller ID. description: Selected caller ID settings. UserNumberItem: type: object required: - primary properties: external: type: string example: '+19075552859' description: Phone number of person or workspace. Either `phoneNumber` or `extension` is mandatory. extension: type: string example: '8080' description: Extension of person or workspace. Either `phoneNumber` or `extension` is mandatory. routingPrefix: type: string example: '1234' description: Routing prefix of location. esn: type: string example: '12348080' description: Routing prefix + extension of a person or workspace. primary: type: boolean example: true description: Flag to indicate primary phone. tollFreeNumber: type: boolean example: true description: Flag to indicate toll free number. CallQueuePut: type: object description: Request body for modifying call center within queues settings for a user. example: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85M2JjZWQ2Mi1lYWRmLTQ0MGItYThiYi03ZWQ5ZWEwNzExMTg available: true required: - id properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85M2JjZWQ2Mi1lYWRmLTQ0MGItYThiYi03ZWQ5ZWEwNzExMTg description: Unique call queue identifier. available: type: boolean example: true description: When `true`, the agent has joined the call center. CallQueueSettingsGetResponseObject: type: object description: Response object containing the call center settings and list of all call centers the logged in user belongs to. example: agentACDState: AVAILABLE queues: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85M2JjZWQ2Mi1lYWRmLTQ0MGItYThiYi03ZWQ5ZWEwNzExMTg hasCxEssentials: true available: true skillLevel: 1 phoneNumber: '+18555550101' extension: '50002' allowLogOffEnabled: false - id: Y2lzY29zcGFyazovL3VzL0NBTExfUEFSS19FWFRFTlNJT04vNDk1ZTgxMTEtY2U4My00ZTc5LWJjOTAtODM2OWQxZjY0NTQ2 hasCxEssentials: false available: false extension: '50001' allowLogOffEnabled: true properties: agentACDState: $ref: '#/components/schemas/AgentACDStateType' queues: type: array items: $ref: '#/components/schemas/CallQueueGet' description: Indicates a list of call centers the agent has joined or may join. CallerIdSettingsGet: type: object description: Response object for the caller ID settings. example: callingLineIdDeliveryBlockingEnabled: false connectedLineIdentificationRestrictionEnabled: false required: - callingLineIdDeliveryBlockingEnabled - connectedLineIdentificationRestrictionEnabled properties: callingLineIdDeliveryBlockingEnabled: type: boolean example: true description: If `true`, the user's name and phone number are not shown to people they call. connectedLineIdentificationRestrictionEnabled: type: boolean description: If `true`, the user's name and phone number are not shown when receiving a call. 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. DeviceTypeObject: type: string enum: - PRIMARY - SHARED_CALL_APPEARANCE - MOBILITY description: " * `PRIMARY` - Primary line for the user.\n * `SHARED_CALL_APPEARANCE` - Shared line for the user. A shared line allows users to receive and place calls to and from another user's extension, using their own device.\n * `MOBILITY` - Device is a shared line.\n" GetUserCallCaptionsObject: type: object required: - userClosedCaptionsEnabled - userTranscriptsEnabled - locationClosedCaptionsEnabled - locationTranscriptsEnabled - useLocationSettingsEnabled properties: userClosedCaptionsEnabled: type: boolean example: true description: User-level closed captions are enabled or disabled. userTranscriptsEnabled: type: boolean example: true description: User-level transcripts are enabled or disabled. locationClosedCaptionsEnabled: type: boolean example: true description: Location closed captions are enabled or disabled. If `useOrgSettingsEnabled` is `true`, these are organization-level settings. Otherwise, location-level settings are used. locationTranscriptsEnabled: type: boolean example: true description: Location transcripts are enabled or disabled. If `useOrgSettingsEnabled` is `true`, these are organization-level settings. Otherwise, location-level settings are used. useLocationSettingsEnabled: type: boolean example: true description: If `useLocationSettingsEnabled` is `true`, location settings will control the user's closed captions and transcripts. Otherwise, user-level settings are used. PostNumberForSingleReachNumber: type: object description: Represents a request to add a phone number for Single Number Reach. example: phoneNumber: '+19075552859' name: John enabled: true doNotForwardCallsEnabled: true answerConfirmationEnabled: false required: - phoneNumber - name - enabled properties: phoneNumber: type: string example: '+19075552859' description: Phone number. name: type: string example: John description: Name associated with the phone number. enabled: type: boolean example: true description: If `true`, the phone number is enabled. doNotForwardCallsEnabled: type: boolean example: true description: Note that this setting attempts to prevent the Single Number Reach (SNR) destination from forwarding the call. The SNR destination may or may not respect the indication provided hence, it may still be forwarded, and this setting has no impact on the user's own forwarding services. answerConfirmationEnabled: type: boolean description: If `true`, answer confirmation is enabled. The default value is `false`. AvailableCallerIdSettingsGet: type: object description: Response object for the available caller ID settings. example: availableCallerIds: - type: HUNT_GROUP id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvNmU1NTVjZDAtNjM0MS00MmI4LWEyMWMtZTc1ZjIxNDQ4Mjc5 name: Hunt Group directNumber: '+19075552860' extension: '10079' required: - availableCallerIds properties: availableCallerIds: type: array items: $ref: '#/components/schemas/availableCallerIds' description: A List of available caller IDs. Endpoint: type: object description: 'Details of an endpoint associated with the authenticated user. Endpoints are devices, applications, or hotdesking guest profiles. Endpoints can be owned by an authenticated user or have the user as a secondary line.' example: id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS85MGQyMmM0Yy0wMGI3LTQ4YzAtYjUwNi0yM2UwY2E2MTlkYmM= type: CALLING_DEVICE name: Webex Go Device autoAndForcedAnswerEnabled: false ownerId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNTlkYzFkOC00NjdkLTRhNGUtOTRlNi1jOTYyZjEyMmY5YWM ownerType: PEOPLE mobilitySettings: phoneNumber: '+13374831660' alertingEnabled: false required: - id - type - name - autoAndForcedAnswerEnabled - ownerId - ownerType properties: id: type: string example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS85MGQyMmM0Yy0wMGI3LTQ4YzAtYjUwNi0yM2UwY2E2MTlkYmM description: Unique identifier of the endpoint. type: $ref: '#/components/schemas/EndpointType' name: type: string example: Webex Go Device description: Display name of the endpoint. autoAndForcedAnswerEnabled: type: boolean example: true description: If `true`, the endpoint can be remotely controlled, allowing actions such as mute, hold, resume and answer. ownerId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNTlkYzFkOC00NjdkLTRhNGUtOTRlNi1jOTYyZjEyMmY5YWM description: Unique identifier of the endpoint owner. ownerType: $ref: '#/components/schemas/MemberType' secondaryLines: type: array items: $ref: '#/components/schemas/SecondaryLine' description: List of secondary lines. The secondary line information is not returned for the endpoint owned by an entity other than the authenticated user. mobilitySettings: type: object required: - phoneNumber - alertingEnabled properties: phoneNumber: type: string example: '+13374831660' description: Phone number of the mobile device endpoint. alertingEnabled: type: boolean description: If `true`, alerting is enabled for the endpoint. description: Mobility settings of the endpoint. host: $ref: '#/components/schemas/HostObject' CallParkMember: type: object description: Represents a member of a call park group. example: id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85M2I0NDkyMi1mZTlmLTExZWItYTRiOC0zMzYyN2JlZDY3YjY type: VIRTUAL_LINE firstName: Smith lastName: Bob displayName: Smith Bob required: - id - type - displayName properties: id: type: string example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS85MGQyMmM0Yy0wMGI3LTQ4YzAtYjUwNi0yM2UwY2E2MTlkYmM description: Unique identifier of the member. type: $ref: '#/components/schemas/MemberType' firstName: type: string example: doe description: First name of the member. lastName: type: string example: John description: Last name of the member. displayName: type: string example: John Doe description: Display name of the member. availableCallerIds: type: object description: Details of an available caller ID. required: - type - name properties: type: $ref: '#/components/schemas/CallerIdType' id: type: string example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvNmU1NTVjZDAtNjM0MS00MmI4LWEyMWMtZTc1ZjIxNDQ4Mjc5 description: Unique identifier of the available caller ID. name: type: string example: Hunt Group description: Name of the available caller ID. directNumber: type: string example: '+19075552860' description: Direct number of the available caller ID. extension: type: string example: '10079' description: Extension of the available caller ID. UserBlockGetResponseObject: type: object description: Response object containing the list of blocked phone numbers for a user. example: numbers: - id: KzE4OTc2NTQzMjE1 phoneNumber: '+18976543215' - id: KzE4OTc2NTQzMzE1 phoneNumber: '+18976543315' - id: KzE4OTc2NTQzNDE1 phoneNumber: '+18976543415' - id: KzE5OTc2NTQzNDE1 phoneNumber: '+19976543415' required: - numbers properties: numbers: type: array items: $ref: '#/components/schemas/Numbers' description: Numbers for the call block list. preferredAnswerEndpoint: type: object description: Details of the preferred answer endpoint. example: id: Y2lzY29z... type: DEVICE name: Cisco 8865 (Phone in reception area) required: - id - type - name properties: id: type: string example: Y2lzY29z... description: Unique identifier for the endpoint. type: $ref: '#/components/schemas/DeviceType' name: type: string example: Cisco 8865 (Phone in reception area) description: The name field is either set to `Webex Desktop Application` or consists of the device model followed by the device tag in parentheses. For example, when the name is `Cisco 8865 (Phone in reception area)`, `Cisco 8865` is the device model and `Phone in reception area` is the device tag. ExecutiveAssignedAssistantsGet: type: object description: Response object for the executive assigned assistants. example: assistants: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZTU1NWNkMC02MzQxLTQyYjgtYTIxYy1lNzVmMjE0NDgyNzU firstName: doe lastName: John directNumber: +91-6557765419 extension: '10079' optInEnabled: true location: name: Bangalore id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzMGMzYTNlLTA3Y2EtNDNmOS1iZjE4LTZlZGM2OGE1Y2Y3Yg properties: assistants: type: array items: $ref: '#/components/schemas/Assistant' description: List of assigned executive assistants. 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. DeviceActivationState: type: string enum: - ACTIVATING - ACTIVATED - DEACTIVATED description: " * `ACTIVATING` - Device is activating using an activation code.\n * `ACTIVATED` - Device has been activated using an activation code.\n * `DEACTIVATED` - Device has not been activated using an activation code.\n" Numbers: type: object description: Phone number details in the call block list. example: id: KzE5OTc2NTQzNDE1 phoneNumber: '+19976543415' required: - id - phoneNumber properties: id: type: string example: KzEyMDI1NTUxMjEy description: Unique identifier of the phone number. phoneNumber: type: string example: '+12025551212' description: Phone number which is blocked by user. EndpointIdType: type: object required: - preferredAnswerEndpointId properties: preferredAnswerEndpointId: type: string example: Y2lzY29z... description: Person’s preferred answer endpoint. nullable: true UserBlockStateGetResponseObject: type: object description: Response object containing the call block state for a specific phone number. example: blockCallsEnabled: true required: - blockCallsEnabled properties: blockCallsEnabled: type: boolean description: Returns true if number is found in user call block list. EndpointListGetObject: type: object description: Response object for the list of endpoints. example: endpoints: - id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS85MGQyMmM0Yy0wMGI3LTQ4YzAtYjUwNi0yM2UwY2E2MTlkYmM= type: CALLING_DEVICE name: Webex Go Device autoAndForcedAnswerEnabled: false ownerId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNTlkYzFkOC00NjdkLTRhNGUtOTRlNi1jOTYyZjEyMmY5YWM ownerType: PEOPLE mobilitySettings: phoneNumber: '+13374831660' alertingEnabled: false - id: Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OLzIyNjBkMDYxLWViNDUtNDJhMi05MmY3LWFkZDMyMzRiYzI0Yw type: APPLICATION name: Webex Tablet Application autoAndForcedAnswerEnabled: false ownerId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNTlkYzFkOC00NjdkLTRhNGUtOTRlNi1jOTYyZjEyMmY5YWM ownerType: PEOPLE secondaryLines: - id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS82NDhjYjBkMC1kODU2LTQzNzQtYmI4My0zNWFhNTIxZDhiZmI memberType: VIRTUAL_LINE - id: Y2lzY29zcGFyazovL3VzL0hPVERFU0tJTkdfR1VFU1QvN2FmYTFlNWMtOTFiYS00NzRkLWEzODMtZTAyMDgxZDU3YmE5 type: HOTDESKING_GUEST name: Cisco HotDesking autoAndForcedAnswerEnabled: false ownerId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kNTlkYzFkOC00NjdkLTRhNGUtOTRlNi1jOTYyZjEyMmY5YWM ownerType: PEOPLE secondaryLines: - id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS82NDhjYjBkMC1kODU2LTQzNzQtYmI4My0zNWFhNTIxZDhiZmI memberType: VIRTUAL_LINE host: id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS9lMTRhNTFlMC1mM2Q1LTQzNzktOWM2OC1hNWFiY2Y1M2E5MTY= type: CALLING_DEVICE name: Cisco 8861 autoAndForcedAnswerEnabled: false ownerId: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8zNDU1MDQ1YS0xN2UyLTQxNzEtOGMwYy02ZWVkMDgwNjM5ZDI= ownerType: PLACE secondaryLines: - id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS9iNmYwNzQyNS1lYjgyLTQzMDEtOWRlNy04YWI3NTFjM2ZhZDQ memberType: VIRTUAL_LINE required: - endpoints properties: endpoints: type: array items: $ref: '#/components/schemas/Endpoint' description: List of endpoints. 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