openapi: 3.2.0 info: title: Webex Cloud Calling AI Receptionist API version: 1.0.0 description: The Webex Cloud Calling APIs enable comprehensive management of cloud-based calling services, including user provisioning, device assignment, call routing, feature configuration, and number management. These APIs facilitate integration with enterprise directories, automation of telephony workflows, and centralized management of global calling infrastructure. Use cases include automated onboarding, self-service portals, integration with CRM/ERP systems, and real-time monitoring of call quality and usage. x-provenance: method: harvested authored_by: Cisco Webex harvested_by: API Evangelist harvested_on: '2026-08-19' first_party: true note: Published by Cisco. Retrieved unmodified except for this x-provenance block. provider_published: true x-evidence: - type: source url: https://github.com/webex/webex-openapi-specs/blob/main/public-spec/webex-cloud-calling.json - type: raw url: https://raw.githubusercontent.com/webex/webex-openapi-specs/main/public-spec/webex-cloud-calling.json tags: - name: AI Receptionist description: ' APIs for retrieving AI Receptionist sessions and conversational transcripts. Restricted to organization Full Administrators (CI role `id_full_admin`).' paths: /telephony/config/aiReceptionists: get: summary: List AI Receptionists operationId: listAiReceptionists description: 'Get list of AI Receptionists. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls to people or services. These APIs let administrators manage AI receptionist resources across organizations and locations. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - AI Receptionist parameters: - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE - name: max in: query description: 'Maximum number of items returned in the response. Default: 2000.' example: 100 schema: type: integer minimum: 1 maximum: 2000 example: 100 - name: start in: query description: Zero-based offset for pagination. example: 0 schema: type: integer minimum: 0 example: 0 - name: locationId in: query description: Location identifier. If not specified, returns AI receptionists from all locations. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgyMjI4MWVkLWUyMmItMTYxNi1hOTYyLTExYTY2OTExYTY2OQ schema: type: string minLength: 1 maxLength: 200 - name: name in: query description: Search AI receptionists by name (contains match). example: Shine Healthcare schema: type: string minLength: 1 maxLength: 30 example: Shine Healthcare - name: phoneNumber in: query description: Search (Contains) based on number or extension. Search cannot be performed based on esn. example: '+1350434' schema: type: string minLength: 1 maxLength: 23 example: '+1350434' responses: '200': description: OK headers: Link: schema: type: string content: application/json: schema: $ref: '#/components/schemas/AiReceptionistListResponse' example: aiReceptionists: - id: Y2lzY29zcGFyazovL3VzL0FJX1JFQ0VQVElPTklTVC82MDEyNGU1MC03MWNkLTQ2N2QtODkzZS1mMGY5MDc0YWYyYjc name: Shine Healthcare Clinic phoneNumber: '+13504342182' extension: '42182' routingPrefix: '1234' esn: '123442182' location: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgyMjI4MWVkLWUyMmItMTYxNi1hOTYyLTExYTY2OTExYTY2OQ name: San Jose '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/aiReceptionists/actions/validateCountry/invoke: post: summary: Validate Country for AI Receptionist operationId: validateAiReceptionistCountry description: 'Validates if country passed in the request supports AI Receptionist. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - AI Receptionist parameters: - name: orgId in: query description: Optional; target organization ID, otherwise defaults to token's org. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ValidateCountryRequest' example: countryCode: US locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1 responses: '204': description: No 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.' /telephony/config/aiReceptionists/templates: get: summary: List AI Receptionist Templates operationId: listAiReceptionistTemplates description: 'Get AI Receptionist template list. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Templates help standardize greetings, goals, and guidelines. Returns all templates in a single response. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - AI Receptionist parameters: - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AiReceptionistTemplateListResponse' example: defaultTransparencyMessage: Hi, I’m an AI receptionist. This interaction may be recorded and transcribed for troubleshooting purposes. templates: - id: Y2lzY29zcGFyazovL3VzL1RFTVBMQVRFL2EyYjNjNDU2LTc4OTAtMTIzNC01Njc4LTkwYWJjZGVmMTIzNA name: Clinic '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/aiReceptionists/templates/{templateId}: get: summary: Get AI Receptionist Template Details operationId: getAiReceptionistTemplate description: 'Get AI Receptionist template details. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Use templates to define goals, messages, and guidelines. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - AI Receptionist parameters: - name: templateId in: path required: true description: Template Id. example: Y2lzY29zcGFyazovL3VzL1RFTVBMQVRFL2EyYjNjNDU2LTc4OTAtMTIzNC01Njc4LTkwYWJjZGVmMTIzNA schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AiReceptionistTemplate' example: id: Y2lzY29zcGFyazovL3VzL1RFTVBMQVRFL2EyYjNjNDU2LTc4OTAtMTIzNC01Njc4LTkwYWJjZGVmMTIzNA name: Clinic goal: As an AI receptionist for Shine Healthcare Clinic, your role is to help callers with necessary information regarding our services. welcomeMessage: Hello I am your AI Receptionist. How can I help you today? guideline: '1. Role Definition: You are a friendly assistant 2. Context: User can only book or cancel appointment' defaultTransparencyMessage: Hi, I'm an AI receptionist. This interaction may be recorded and transcribed for troubleshooting purposes. '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/locations/{locationId}/aiReceptionists/actions/validate/invoke: post: summary: Validate AI Receptionist operationId: validateAiReceptionist description: 'Validates AI Receptionist name at location level and max limit at org level. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - AI Receptionist parameters: - name: locationId in: path required: true description: Location ID. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgyMjI4MWVkLWUyMmItMTYxNi1hOTYyLTExYTY2OTExYTY2OQ schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier, defaults to the token's org if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ValidateAiReceptionistRequest' example: name: Shine Healthcare Clinic responses: '204': description: No 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.' /telephony/config/locations/{locationId}/aiReceptionists/availableNumbers: get: summary: List Available Numbers for AI Receptionist operationId: listAiReceptionistAvailableNumbers description: 'List and search numbers that can be assigned as AI Receptionist number. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Numbers listed here can be assigned to an AI receptionist at a location. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - AI Receptionist parameters: - name: locationId in: path required: true description: Location ID. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgyMjI4MWVkLWUyMmItMTYxNi1hOTYyLTExYTY2OTExYTY2OQ schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to the token's org Id if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE - name: max in: query description: 'Maximum number of items returned in the response. Default: 2000.' example: 100 schema: type: integer minimum: 1 maximum: 2000 example: 100 - name: start in: query description: Record offset. example: 0 schema: type: integer minimum: 0 example: 0 - name: phoneNumber in: query description: Search (Contains) based on number or extension. Search cannot be performed based on esn. example: '+1213456' schema: type: string minLength: 1 maxLength: 20 example: '+1213456' responses: '200': description: OK headers: Link: schema: type: string content: application/json: schema: $ref: '#/components/schemas/AvailableNumbersListResponse' example: phoneNumbers: - phoneNumber: '+12134567895' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: 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/locations/{locationId}/aiReceptionists: post: summary: Create an AI Receptionist operationId: createAiReceptionist description: 'Create a new AI Receptionist for a location. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls to people or services. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - AI Receptionist parameters: - name: locationId in: path required: true description: Location ID. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgyMjI4MWVkLWUyMmItMTYxNi1hOTYyLTExYTY2OTExYTY2OQ schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAiReceptionistRequest' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/CreateAiReceptionistResponse' '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/locations/{locationId}/aiReceptionists/{aiReceptionistId}: get: summary: Get AI Receptionist Details operationId: getAiReceptionist description: 'Get AI Receptionist details. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls to people or services. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - AI Receptionist parameters: - name: locationId in: path required: true description: Location ID. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgyMjI4MWVkLWUyMmItMTYxNi1hOTYyLTExYTY2OTExYTY2OQ schema: type: string minLength: 1 maxLength: 200 - name: aiReceptionistId in: path required: true description: Unique identifier for the AI Receptionist. example: Y2lzY29zcGFyazovL3VzL0FJX1JFQ0VQVElPTklTVC82MDEyNGU1MC03MWNkLTQ2N2QtODkzZS1mMGY5MDc0YWYyYjc schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AiReceptionistResponse' '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.' put: summary: Update an AI Receptionist operationId: updateAiReceptionist description: 'Update an AI Receptionist. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls to people or services. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - AI Receptionist parameters: - name: locationId in: path required: true description: Location ID. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgyMjI4MWVkLWUyMmItMTYxNi1hOTYyLTExYTY2OTExYTY2OQ schema: type: string minLength: 1 maxLength: 200 - name: aiReceptionistId in: path required: true description: Unique identifier for the AI Receptionist. example: Y2lzY29zcGFyazovL3VzL0FJX1JFQ0VQVElPTklTVC82MDEyNGU1MC03MWNkLTQ2N2QtODkzZS1mMGY5MDc0YWYyYjc schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAiReceptionistRequest' responses: '204': description: No 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.' delete: summary: Delete an AI Receptionist operationId: deleteAiReceptionist description: 'Delete an AI Receptionist. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls to people or services. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - AI Receptionist parameters: - name: locationId in: path required: true description: Location ID. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgyMjI4MWVkLWUyMmItMTYxNi1hOTYyLTExYTY2OTExYTY2OQ schema: type: string minLength: 1 maxLength: 200 - name: aiReceptionistId in: path required: true description: Unique identifier for the AI Receptionist. example: Y2lzY29zcGFyazovL3VzL0FJX1JFQ0VQVElPTklTVC82MDEyNGU1MC03MWNkLTQ2N2QtODkzZS1mMGY5MDc0YWYyYjc schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE responses: '204': description: No 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.' /telephony/config/locations/{locationId}/aiReceptionists/voices: get: summary: Get AI Receptionist Voices operationId: getAiReceptionistVoices description: 'Get list of available AI Receptionist voices. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. This API returns the available voice options that can be configured for an AI Receptionist. The response returns all available engines and voices; no pagination is required. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - AI Receptionist parameters: - name: locationId in: path required: true description: Location ID. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgyMjI4MWVkLWUyMmItMTYxNi1hOTYyLTExYTY2OTExYTY2OQ schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AiReceptionistVoicesResponse' example: aiEngines: - name: PRO voices: - language: English languageCode: en-US displayName: en-US-Maria isDefault: false gender: FEMALE - name: PRO_US voices: - language: English languageCode: en-US displayName: en-US-Jess isDefault: true gender: FEMALE '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/locations/{locationId}/aiReceptionists/{aiReceptionistId}/intents: get: summary: List AI Receptionist Intents operationId: listAiReceptionistIntents description: 'Get list of AI Receptionist Intents. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Intents represent call-handling behaviors such as transfers. Returns all intents in a single response. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - AI Receptionist parameters: - name: locationId in: path required: true description: Location ID. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgyMjI4MWVkLWUyMmItMTYxNi1hOTYyLTExYTY2OTExYTY2OQ schema: type: string minLength: 1 maxLength: 200 - name: aiReceptionistId in: path required: true description: Unique identifier for the AI Receptionist. example: Y2lzY29zcGFyazovL3VzL0FJX1JFQ0VQVElPTklTVC82MDEyNGU1MC03MWNkLTQ2N2QtODkzZS1mMGY5MDc0YWYyYjc schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AiReceptionistIntentListResponse' example: intents: - id: Y2lzY29zcGFyazovL3VzL0lOVEVOVC8xMjM0NTY3OC05MGFiLWNkZWYtMTIzNC01Njc4OTBhYmNkZWY name: Transfer to Support transferTo: contactType: RESOURCE_GROUP contactId: Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQL2Y0MWNkMDUxLTgxN2YtNGQ4MS1hMWNlLTBmZDM5YzFlN2I5Zg name: RS Call Queue phoneNumber: '+4765241628' '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.' post: summary: Create AI Receptionist Intent operationId: createAiReceptionistIntent description: 'Create a new AI Receptionist Intent. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Intents represent call-handling behaviors such as transfers. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - AI Receptionist parameters: - name: locationId in: path required: true description: Location ID. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgyMjI4MWVkLWUyMmItMTYxNi1hOTYyLTExYTY2OTExYTY2OQ schema: type: string minLength: 1 maxLength: 200 - name: aiReceptionistId in: path required: true description: Unique identifier for the AI Receptionist. example: Y2lzY29zcGFyazovL3VzL0FJX1JFQ0VQVElPTklTVC82MDEyNGU1MC03MWNkLTQ2N2QtODkzZS1mMGY5MDc0YWYyYjc schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAiReceptionistIntentRequest' example: name: Physical Therapy description: Connect the caller to knowledgeable representative if they seek assistance with Physical Therapy transferTo: contactType: PEOPLE contactId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNDFjZDA1MS04MTdmLTRkODEtYTFjZS0wZmQzOWMxZTdiOWY phoneNumber: '+4765241628' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/CreateAiReceptionistIntentResponse' example: id: Y2lzY29zcGFyazovL3VzL0lOVEVOVC82OGVhZTIyNDQ3NDZiZDJlMjJiZGY2ODY '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/locations/{locationId}/aiReceptionists/{aiReceptionistId}/intents/{intentId}: get: summary: Get AI Receptionist Intent operationId: getAiReceptionistIntent description: 'Get details of a specific AI Receptionist Intent. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Intents represent call-handling behaviors such as transfers. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - AI Receptionist parameters: - name: locationId in: path required: true description: Location ID. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgyMjI4MWVkLWUyMmItMTYxNi1hOTYyLTExYTY2OTExYTY2OQ schema: type: string minLength: 1 maxLength: 200 - name: aiReceptionistId in: path required: true description: Unique identifier for the AI Receptionist. example: Y2lzY29zcGFyazovL3VzL0FJX1JFQ0VQVElPTklTVC82MDEyNGU1MC03MWNkLTQ2N2QtODkzZS1mMGY5MDc0YWYyYjc schema: type: string minLength: 1 maxLength: 200 - name: intentId in: path required: true description: Unique identifier for a specific AI Receptionist intent within a given location and AI Receptionist instance. example: Y2lzY29zcGFyazovL3VzL0lOVEVOVC82OGVhZTIyNDQ3NDZiZDJlMjJiZGY2ODY schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AiReceptionistIntentDetails' example: id: Y2lzY29zcGFyazovL3VzL0lOVEVOVC82OGVhZTIyNDQ3NDZiZDJlMjJiZGY2ODY name: Physical Therapy description: Connect the caller to knowledgeable representative if they seek assistance with Physical Therapy transferTo: contactType: PEOPLE contactId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNDFjZDA1MS04MTdmLTRkODEtYTFjZS0wZmQzOWMxZTdiOWY name: John Doe phoneNumber: '+4765241628' '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.' put: summary: Modify AI Receptionist Intent operationId: modifyAiReceptionistIntent description: 'Modify an existing AI Receptionist Intent. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Intents represent call-handling behaviors such as transfers. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - AI Receptionist parameters: - name: locationId in: path required: true description: Location ID. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgyMjI4MWVkLWUyMmItMTYxNi1hOTYyLTExYTY2OTExYTY2OQ schema: type: string minLength: 1 maxLength: 200 - name: aiReceptionistId in: path required: true description: Unique identifier for the AI Receptionist. example: Y2lzY29zcGFyazovL3VzL0FJX1JFQ0VQVElPTklTVC82MDEyNGU1MC03MWNkLTQ2N2QtODkzZS1mMGY5MDc0YWYyYjc schema: type: string minLength: 1 maxLength: 200 - name: intentId in: path required: true description: Unique identifier for a specific AI Receptionist intent within a given location and AI Receptionist instance. example: Y2lzY29zcGFyazovL3VzL0lOVEVOVC82OGVhZTIyNDQ3NDZiZDJlMjJiZGY2ODY schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ModifyAiReceptionistIntentRequest' example: name: For Physical Therapy description: Connect the caller to knowledgeable representative if they seek assistance with Physical Therapy transferTo: contactType: PEOPLE contactId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNDFjZDA1MS04MTdmLTRkODEtYTFjZS0wZmQzOWMxZTdiOWY phoneNumber: '+4765241628' responses: '204': description: No 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.' delete: summary: Delete AI Receptionist Intent operationId: deleteAiReceptionistIntent description: 'Delete an AI Receptionist Intent. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Intents represent call-handling behaviors such as transfers. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - AI Receptionist parameters: - name: locationId in: path required: true description: Location ID. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgyMjI4MWVkLWUyMmItMTYxNi1hOTYyLTExYTY2OTExYTY2OQ schema: type: string minLength: 1 maxLength: 200 - name: aiReceptionistId in: path required: true description: Unique identifier for the AI Receptionist. example: Y2lzY29zcGFyazovL3VzL0FJX1JFQ0VQVElPTklTVC82MDEyNGU1MC03MWNkLTQ2N2QtODkzZS1mMGY5MDc0YWYyYjc schema: type: string minLength: 1 maxLength: 200 - name: intentId in: path required: true description: Unique identifier for a specific AI Receptionist intent within a given location and AI Receptionist instance. example: Y2lzY29zcGFyazovL3VzL0lOVEVOVC82OGVhZTIyNDQ3NDZiZDJlMjJiZGY2ODY schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE responses: '204': description: No 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.' /telephony/config/knowledgeBases: get: summary: List Knowledge Bases operationId: listKnowledgeBases description: 'Get list of Knowledge Bases for an organization. Knowledge Bases are repositories of information that AI Receptionists use to answer caller queries. This API returns all knowledge bases available in the organization. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - AI Receptionist parameters: - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 - name: max in: query description: 'Maximum number of items returned in the response. Default: 100.' example: 10 schema: type: integer minimum: 1 maximum: 100 - name: start in: query description: Zero-based offset for pagination. example: 0 schema: type: integer minimum: 0 - name: name in: query description: Search knowledge bases by name (contains match). example: Healthcare schema: type: string minLength: 1 maxLength: 100 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/KnowledgeBaseListResponse' example: knowledgeBases: - id: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw name: Shree HealthCare Clinic KB description: A centralized repository of medical and administrative information for Shree Health Care Clinic. documentsCount: 5 filesCount: 3 filesSize: 210 createdAt: '2024-08-16T18:30:20.882Z' updatedAt: '2024-08-16T18:30:20.882Z' mappedBots: - id: Y2lzY29zcGFyazovL3VzL0FJX1JFQ0VQVElPTklTVC8wNWViZTUzZS02YTg5LTRkMTktYmIzYi0xNmJhZDU4OWRhNmE connectedAt: '2024-08-16T18:30:20.882Z' agentId: Y2lzY29zcGFyazovL3VzL0FJX0FHRU5ULzY5YmFhZDIwOGUzOWUyMGE0ZTNkNjEwNA name: AIR P Test '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.' post: summary: Create a Knowledge Base operationId: createKnowledgeBase description: 'Create a new Knowledge Base for an organization. Knowledge Bases are repositories of information that AI Receptionists use to answer caller queries. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - AI Receptionist parameters: - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateKnowledgeBaseRequest' example: name: Shree HealthCare Clinic KB description: A centralized repository of medical and administrative information for Shree Health Care Clinic. responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/CreateKnowledgeBaseResponse' example: id: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw '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/knowledgeBases/{knowledgeBaseId}: get: summary: Get Knowledge Base Details operationId: getKnowledgeBase description: 'Get details of a specific Knowledge Base. Knowledge Bases are repositories of information that AI Receptionists use to answer caller queries. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - AI Receptionist parameters: - name: knowledgeBaseId in: path required: true description: Unique identifier for the Knowledge Base. example: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/KnowledgeBaseDetails' example: id: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw name: Shree HealthCare Clinic KB description: A centralized repository of medical and administrative information for Shree Health Care Clinic. documentsCount: 5 filesCount: 3 filesSize: 210 createdAt: '2024-08-16T18:30:20.882Z' updatedAt: '2024-08-16T18:30:20.882Z' mappedBots: - id: Y2lzY29zcGFyazovL3VzL0FJX1JFQ0VQVElPTklTVC8wNWViZTUzZS02YTg5LTRkMTktYmIzYi0xNmJhZDU4OWRhNmE connectedAt: '2024-08-16T18:30:20.882Z' agentId: Y2lzY29zcGFyazovL3VzL0FJX0FHRU5ULzY5YmFhZDIwOGUzOWUyMGE0ZTNkNjEwNA name: AIR P Test '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.' put: summary: Modify a Knowledge Base operationId: updateKnowledgeBase description: 'Modify an existing Knowledge Base. Knowledge Bases are repositories of information that AI Receptionists use to answer caller queries. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - AI Receptionist parameters: - name: knowledgeBaseId in: path required: true description: Unique identifier for the Knowledge Base. example: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateKnowledgeBaseRequest' example: name: Shree HealthCare Clinic KB Updated description: Updated description for the knowledge base. responses: '204': description: No 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.' delete: summary: Delete a Knowledge Base operationId: deleteKnowledgeBase description: 'Delete a Knowledge Base. Knowledge Bases are repositories of information that AI Receptionists use to answer caller queries. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - AI Receptionist parameters: - name: knowledgeBaseId in: path required: true description: Unique identifier for the Knowledge Base. example: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 responses: '204': description: No 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.' /telephony/config/knowledgeBases/{knowledgeBaseId}/documents: get: summary: List Knowledge Base Documents operationId: listKnowledgeBaseDocuments description: 'Get list of documents in a Knowledge Base. Documents are files uploaded to a Knowledge Base that AI Receptionists use to answer caller queries. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - AI Receptionist parameters: - name: knowledgeBaseId in: path required: true description: Unique identifier for the Knowledge Base. example: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 - name: max in: query description: 'Maximum number of items returned in the response. Default: 100.' example: 10 schema: type: integer minimum: 1 maximum: 100 - name: start in: query description: Zero-based offset for pagination. example: 0 schema: type: integer minimum: 0 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/KnowledgeBaseDocumentListResponse' example: documents: - id: Y2lzY29zcGFyazovL3VzL0tCX0RPQ1VNRU5ULzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw knowledgeBaseId: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw name: FAQ Document content: This document contains frequently asked questions. description: Company FAQ fileName: FAQ.pdf fileSize: 1024 knowledgeType: file status: success createdAt: '2024-08-16T18:30:20.882Z' updatedAt: '2024-08-16T18:30:20.882Z' '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.' post: summary: Create Knowledge Base Document operationId: createKnowledgeBaseDocument description: 'Create a new document in a Knowledge Base. Documents are content entries in a Knowledge Base that AI Receptionists use to answer caller queries. This API creates a document with specified name and content. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - AI Receptionist parameters: - name: knowledgeBaseId in: path required: true description: Unique identifier for the Knowledge Base. example: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateKnowledgeBaseDocumentRequest' example: name: Company FAQ content: This document contains frequently asked questions about our company services. responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/CreateKnowledgeBaseDocumentResponse' example: id: Y2lzY29zcGFyazovL3VzL0tCX0RPQ1VNRU5ULzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw '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.' '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).' /telephony/config/knowledgeBases/{knowledgeBaseId}/documents/actions/upload/invoke: post: summary: Upload Knowledge Base Document operationId: uploadKnowledgeBaseDocument description: 'Upload a document to a Knowledge Base. Documents are files uploaded to a Knowledge Base that AI Receptionists use to answer caller queries. Supported file types include PDF, TXT, DOCX, XLSX, XLS, and CSV. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`. **WARNING:** This API is not callable using the developer portal web interface due to the lack of support for multipart POST. This API can be utilized using other tools that support multipart POST, such as Postman.' tags: - AI Receptionist parameters: - name: knowledgeBaseId in: path required: true description: Unique identifier for the Knowledge Base. example: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/UploadKnowledgeBaseDocumentRequest' encoding: file: contentType: application/pdf, text/plain, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-excel, text/csv responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/UploadKnowledgeBaseDocumentResponse' example: id: Y2lzY29zcGFyazovL3VzL0tCX0RPQ1VNRU5ULzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw '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/knowledgeBases/{knowledgeBaseId}/documents/{documentId}: get: summary: Get Knowledge Base Document Details operationId: getKnowledgeBaseDocument description: 'Get details of a specific document in a Knowledge Base. Documents are content entries in a Knowledge Base that AI Receptionists use to answer caller queries. This API returns document metadata including name, content, status, and timestamps. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - AI Receptionist parameters: - name: knowledgeBaseId in: path required: true description: Unique identifier for the Knowledge Base. example: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw schema: type: string minLength: 1 maxLength: 200 - name: documentId in: path required: true description: Unique identifier for the document. example: Y2lzY29zcGFyazovL3VzL0tCX0RPQ1VNRU5ULzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/KnowledgeBaseDocumentDetails' example: id: Y2lzY29zcGFyazovL3VzL0tCX0RPQ1VNRU5ULzY5ZWViYWZmOWQyNzU0ZGI2NGUwNjZiMA knowledgeBaseId: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5ZWViNzE5MGRlMDAyZWZiZTA0MTU1ZA name: AIReceptionistChangesDoc content: AIReceptionistChangesDoc description: '' fileName: '' fileSize: 210 knowledgeType: article status: success createdAt: '2024-08-16T18:30:20.882Z' updatedAt: '2024-08-16T18:30:20.882Z' '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.' '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).' put: summary: Modify Knowledge Base Document operationId: updateKnowledgeBaseDocument description: 'Modify a document in a Knowledge Base. Documents are content entries in a Knowledge Base that AI Receptionists use to answer caller queries. This API allows updating the name and content of an existing document. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - AI Receptionist parameters: - name: knowledgeBaseId in: path required: true description: Unique identifier for the Knowledge Base. example: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw schema: type: string minLength: 1 maxLength: 200 - name: documentId in: path required: true description: Unique identifier for the document. example: Y2lzY29zcGFyazovL3VzL0tCX0RPQ1VNRU5ULzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateKnowledgeBaseDocumentRequest' example: name: Updated FAQ Document content: This is the updated content for the FAQ document. responses: '204': description: No 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.' '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).' delete: summary: Delete Knowledge Base Document operationId: deleteKnowledgeBaseDocument description: 'Delete a document from a Knowledge Base. Documents are files uploaded to a Knowledge Base that AI Receptionists use to answer caller queries. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - AI Receptionist parameters: - name: knowledgeBaseId in: path required: true description: Unique identifier for the Knowledge Base. example: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw schema: type: string minLength: 1 maxLength: 200 - name: documentId in: path required: true description: Unique identifier for the document. example: Y2lzY29zcGFyazovL3VzL0tCX0RPQ1VNRU5ULzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 responses: '204': description: No 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.' /telephony/config/knowledgeBases/{knowledgeBaseId}/documents/{documentId}/actions/download/invoke: post: summary: Download Knowledge Base Document operationId: downloadKnowledgeBaseDocument description: 'Download a document from a Knowledge Base. Documents are files uploaded to a Knowledge Base that AI Receptionists use to answer caller queries. The response contains the file content with appropriate Content-Type and Content-Disposition headers. This API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`. **WARNING:** This API is not callable using the developer portal web interface due to the lack of support for binary file downloads. This API can be utilized using other tools that support binary responses, such as Postman or curl.' tags: - AI Receptionist parameters: - name: knowledgeBaseId in: path required: true description: Unique identifier for the Knowledge Base. example: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw schema: type: string minLength: 1 maxLength: 200 - name: documentId in: path required: true description: Unique identifier for the document. example: Y2lzY29zcGFyazovL3VzL0tCX0RPQ1VNRU5ULzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw schema: type: string minLength: 1 maxLength: 200 - name: orgId in: query description: Optional target organization identifier. Defaults to token's organization if not provided. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string minLength: 1 maxLength: 200 responses: '200': description: OK - File content returned headers: Content-Type: description: The MIME type of the document (e.g., application/pdf, text/plain) schema: type: string Content-Disposition: description: attachment; filename="" schema: type: string Content-Length: description: Size of the file in bytes schema: type: integer content: application/octet-stream: schema: type: string format: binary '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.' components: schemas: AiReceptionistTemplateSummary: type: object required: - id - name properties: id: type: string description: Unique identifier for the AI receptionist template. example: Y2lzY29zcGFyazovL3VzL1RFTVBMQVRFL2EyYjNjNDU2LTc4OTAtMTIzNC01Njc4LTkwYWJjZGVmMTIzNA name: type: string description: Name of the AI Receptionist template. example: Clinic UpdateKnowledgeBaseDocumentRequest: type: object minProperties: 1 properties: name: type: string minLength: 1 maxLength: 64 description: The display name assigned to the Knowledge Base document. Used to identify the document across the platform. example: Updated FAQ Document content: type: string description: The content of the document. example: This is the updated content for the FAQ document. example: name: Updated FAQ Document content: This is the updated content for the FAQ document. CreateKnowledgeBaseDocumentResponse: type: object required: - id properties: id: type: string description: Unique identifier of the newly created document. example: Y2lzY29zcGFyazovL3VzL0tCX0RPQ1VNRU5ULzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw example: id: Y2lzY29zcGFyazovL3VzL0tCX0RPQ1VNRU5ULzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw AiReceptionistLocation: type: object required: - id - name properties: id: type: string description: Unique identifier for the location of the AI receptionist. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgyMjI4MWVkLWUyMmItMTYxNi1hOTYyLTExYTY2OTExYTY2OQ name: type: string description: Location name of AI Receptionist. example: San Jose example: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgyMjI4MWVkLWUyMmItMTYxNi1hOTYyLTExYTY2OTExYTY2OQ name: San Jose AlternateNumber: type: object properties: phoneNumber: type: string minLength: 1 maxLength: 23 description: Alternate phone number. example: '+12147691003' tollFreeNumber: type: boolean description: Flag to indicate if the number is toll free number example: false ringPattern: type: string description: 'Ring pattern for the alternate number: - `NORMAL` - Standard ring pattern. - `LONG_LONG` - Two long rings. - `SHORT_SHORT_LONG` - Two short rings followed by one long ring. - `SHORT_LONG_SHORT` - Short, long, short ring pattern.' enum: - NORMAL - LONG_LONG - SHORT_SHORT_LONG - SHORT_LONG_SHORT example: LONG_LONG AiReceptionistResponse: type: object required: - id - name - enabled - intentCount properties: id: type: string description: AI Receptionist ID encoded using the Resource Type. example: Y2lzY29zcGFyazovL3VzL0FJX1JFQ0VQVElPTklTVC82MDEyNGU1MC03MWNkLTQ2N2QtODkzZS1mMGY5MDc0YWYyYjc name: type: string description: Name of the AI Receptionist. This has to be unique across location example: Shine Healthcare Clinic enabled: type: boolean description: Flag to indicate AI receptionist is enabled or not. When disabled, incoming calls to this AI receptionist will not be answered. example: true phoneNumber: type: string description: Phone number of the AI Receptionist. Either phoneNumber or extension is mandatory. At least one is required. example: '+13504342182' extension: type: string description: Extension of the AI Receptionist. Either phoneNumber or extension is mandatory. At least one is required. example: '2182' routingPrefix: type: string description: Routing prefix of location. example: '2345' esn: type: string description: Routing prefix + extension of the AI Receptionist. If the location has no routing prefix, this will only be the extension. If the AI Receptionist has no extension, this field will not be present. example: '23452182' alternateNumbers: type: array description: List of alternate phone numbers assigned to the AI Receptionist. items: $ref: '#/components/schemas/AlternateNumber' directLineCallerIdName: description: Direct line caller ID name configuration allOf: - $ref: '#/components/schemas/DirectLineCallerIdName' dialByName: type: string description: A dial by name used for AI Receptionist name dialing. Characters of `%`, `+`, `\`, `"` and Unicode characters are not allowed. example: Shine Healthcare defaultAction: description: Default action configuration for the AI Receptionist allOf: - $ref: '#/components/schemas/DefaultAction' aiAgent: description: AI Agent configuration allOf: - $ref: '#/components/schemas/AiAgent' intentCount: type: integer description: Number of intents configured for this AI Receptionist example: 5 example: id: Y2lzY29zcGFyazovL3VzL0FJX1JFQ0VQVElPTklTVC82MDEyNGU1MC03MWNkLTQ2N2QtODkzZS1mMGY5MDc0YWYyYjc name: Shine Healthcare Clinic enabled: true phoneNumber: '+13504342182' extension: '2182' routingPrefix: '2345' esn: '23452182' alternateNumbers: - phoneNumber: '+12147691003' tollFreeNumber: false ringPattern: LONG_LONG directLineCallerIdName: directLineCallerIdNameSelection: CUSTOM_NAME customName: Shine Clinic dialByName: Shine Healthcare defaultAction: actionType: PLAY_MESSAGE_AND_DISCONNECT audioMessageSelection: CUSTOM audioFile: id: Y2lzY29zcGFyazovL3VzL0FVRElPX0ZJTEUvYTJiM2M0NTYtNzg5MC0xMjM0LTU2NzgtOTBhYmNkZWYxMjM0 fileName: greeting.wav mediaFileType: WAV level: ORGANIZATION isTextToSpeech: false aiAgent: agentId: Y2lzY29zcGFyazovL3VzL0FJX0FHRU5ULzY4ZWFlMjI0NDc0NmJkMmUyMmJkZjY4Ng voice: aiEngine: PRO displayName: en-US-AvaMultilingualNeural language: English languageCode: en-US knowledgeBaseId: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFL2IzYzRkNTY3LTg5MDEtMjM0NS02Nzg5LTAxYmNkZWYyMzQ1Ng guidelines: goal: Assist callers with appointment scheduling welcomeMessage: Welcome to Shine Healthcare Clinic guideline: Be polite and professional transparencySettings: enabled: true message: Hi, I'm an AI receptionist. This interaction may be recorded and transcribed for troubleshooting purposes. intentCount: 5 CreateAiReceptionistIntentRequest: type: object required: - name - description - transferTo properties: name: type: string description: Name of the intent. minLength: 1 maxLength: 64 example: Physical Therapy description: type: string description: Description of the intent (Action). minLength: 1 maxLength: 1024 example: Connect the caller to knowledgeable representative if they seek assistance with Physical Therapy transferTo: $ref: '#/components/schemas/IntentTransferToRequest' CreateAiReceptionistResponse: type: object required: - id properties: id: type: string description: AI Receptionist ID encoded using the Resource Type. example: Y2lzY29zcGFyazovL3VzL0FJX1JFQ0VQVElPTklTVC82MDEyNGU1MC03MWNkLTQ2N2QtODkzZS1mMGY5MDc0YWYyYjc KnowledgeBaseSummary: type: object required: - id - name - documentsCount - filesCount - filesSize - createdAt - updatedAt properties: id: type: string description: Unique identifier of the Knowledge Base. example: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw name: type: string description: The display name assigned to the Knowledge Base. Used to identify the KB across the platform. example: Shree HealthCare Clinic KB description: type: string description: A human-readable description providing additional context about the purpose or contents of the Knowledge Base. example: A centralized repository of medical and administrative information for Shree Health Care Clinic. documentsCount: type: integer description: The total count of documents that have been uploaded or indexed into the Knowledge Base. example: 5 filesCount: type: integer description: The total count of files that have been uploaded to the Knowledge Base. example: 3 filesSize: type: integer format: int64 description: The cumulative size (in bytes) of all files stored in the Knowledge Base. example: 210 createdAt: type: string format: date-time description: Timestamp indicating when the Knowledge Base was originally created, in ISO 8601 format. example: '2024-08-16T18:30:20.882Z' updatedAt: type: string format: date-time description: Timestamp indicating when the Knowledge Base was last modified, in ISO 8601 format. example: '2024-08-16T18:30:20.882Z' mappedBots: type: array items: $ref: '#/components/schemas/KnowledgeBaseMappedBot' description: List of AI Receptionists that are currently associated with this Knowledge Base. KnowledgeBaseListResponse: type: object properties: knowledgeBases: type: array items: $ref: '#/components/schemas/KnowledgeBaseSummary' description: List of Knowledge Bases. example: knowledgeBases: - id: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw name: Shree HealthCare Clinic KB description: A centralized repository of medical and administrative information for Shree Health Care Clinic. documentsCount: 5 filesCount: 3 filesSize: 210 createdAt: '2024-08-16T18:30:20.882Z' updatedAt: '2024-08-16T18:30:20.882Z' mappedBots: - id: Y2lzY29zcGFyazovL3VzL0FJX1JFQ0VQVElPTklTVC8wNWViZTUzZS02YTg5LTRkMTktYmIzYi0xNmJhZDU4OWRhNmE connectedAt: '2024-08-16T18:30:20.882Z' agentId: Y2lzY29zcGFyazovL3VzL0FJX0FHRU5ULzY5YmFhZDIwOGUzOWUyMGE0ZTNkNjEwNA name: AIR P Test UploadKnowledgeBaseDocumentRequest: type: object required: - file properties: file: type: string format: binary description: 'The document file to upload. Supported file types: PDF, TXT, DOCX, XLSX, XLS, CSV. Maximum file size: 10MB.' UpdateAiGuidelines: type: object properties: goal: type: string maxLength: 5096 description: Goal of the AI Receptionist. The combined length of `goal` and `guideline` must not exceed 5096 characters. example: As an AI receptionist for Shine Healthcare Clinic, your role is to help callers with necessary information regarding our services. welcomeMessage: type: string maxLength: 1000 description: Welcome message to be played before the call handling. example: Hello I am your AI Receptionist. How can I help you today? guideline: type: string maxLength: 5096 description: Guidelines to AI Receptionist to follow. This includes information like Identity, role definition, context, behavior etc.. The combined length of `goal` and `guideline` must not exceed 5096 characters. example: '1. Role Definition: You are a friendly assistant 2. Context: User can only book or cancel appointment' AiReceptionistTemplateListResponse: type: object required: - defaultTransparencyMessage properties: defaultTransparencyMessage: type: string description: Default transparency disclosure message for AI Receptionist. This message explicitly informs callers they are interacting with an AI system, ensuring compliance with EU AI Act transparency obligations for Limited Risk AI systems. example: Hi, I’m an AI receptionist. This interaction may be recorded and transcribed for troubleshooting purposes. templates: type: array items: $ref: '#/components/schemas/AiReceptionistTemplateSummary' description: List of AI Receptionist templates. example: - id: Y2lzY29zcGFyazovL3VzL1RFTVBMQVRFL2EyYjNjNDU2LTc4OTAtMTIzNC01Njc4LTkwYWJjZGVmMTIzNA name: Clinic example: defaultTransparencyMessage: Hi, I’m an AI receptionist. This interaction may be recorded and transcribed for troubleshooting purposes. templates: - id: Y2lzY29zcGFyazovL3VzL1RFTVBMQVRFL2EyYjNjNDU2LTc4OTAtMTIzNC01Njc4LTkwYWJjZGVmMTIzNA name: Clinic CreateAiAgent: type: object required: - voice - knowledgeBaseId - guidelines properties: voice: description: Voice configuration for the AI Agent allOf: - $ref: '#/components/schemas/CreateAiVoice' knowledgeBaseId: type: string description: Unique identifier for the Knowledge Base used by the AI Agent to answer caller queries. example: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFL2IzYzRkNTY3LTg5MDEtMjM0NS02Nzg5LTAxYmNkZWYyMzQ1Ng guidelines: description: AI Agent guidelines allOf: - $ref: '#/components/schemas/CreateAiGuidelines' transparencySettings: description: Transparency settings for AI Receptionist. Configures disclosure messages to inform callers they are interacting with an AI system, ensuring compliance with EU AI Act transparency obligations. allOf: - $ref: '#/components/schemas/TransparencySettings' AiReceptionist: type: object required: - id - name - location properties: id: type: string description: Unique identifier for the AI receptionist. example: Y2lzY29zcGFyazovL3VzL0FJX1JFQ0VQVElPTklTVC82MDEyNGU1MC03MWNkLTQ2N2QtODkzZS1mMGY5MDc0YWYyYjc name: type: string description: Name of the AI receptionist. Must be unique within a location. example: Shine Healthcare Clinic phoneNumber: type: string description: Phone number of the AI receptionist in E.164 format. example: '+13504342182' extension: type: string description: Extension of the AI Receptionist. example: '42182' routingPrefix: type: string description: Routing prefix of location. example: '1234' esn: type: string description: Routing prefix + extension of the AI Receptionist. If the location has no routing prefix, this will only be the extension. If the AI Receptionist has no extension, this field will not be present. example: '123442182' location: description: Location of the AI Receptionist. allOf: - $ref: '#/components/schemas/AiReceptionistLocation' AiReceptionistIntent: type: object required: - id - name - transferTo properties: id: type: string description: Unique identifier of the intent. example: Y2lzY29zcGFyazovL3VzL0lOVEVOVC8xMjM0NTY3OC05MGFiLWNkZWYtMTIzNC01Njc4OTBhYmNkZWY name: type: string description: Name of the intent. example: Transfer to Support transferTo: description: Transfer destination for the intent. allOf: - $ref: '#/components/schemas/IntentTransferTo' example: contactType: RESOURCE_GROUP contactId: Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQL2Y0MWNkMDUxLTgxN2YtNGQ4MS1hMWNlLTBmZDM5YzFlN2I5Zg name: RS Call Queue phoneNumber: '+4765241628' AiEngine: type: object required: - name - voices properties: name: type: string description: 'AI engine name. - PRO — Available in all supported countries. - PRO_US — Available in the United States only.' enum: - PRO - PRO_US example: PRO voices: type: array items: $ref: '#/components/schemas/Voice' description: List of available voices for this AI engine. TransparencySettingsResponse: type: object required: - enabled properties: enabled: type: boolean description: Flag to enable or disable transparency disclosure for AI Receptionist. example: true message: type: string description: Custom transparency message to inform callers they are interacting with an AI system. example: Hi, I'm an AI receptionist. This interaction may be recorded and transcribed for troubleshooting purposes. AiGuidelines: type: object properties: goal: type: string minLength: 1 maxLength: 5096 description: Goal for the AI Agent. The combined length of `goal` and `guideline` must not exceed 5096 characters. example: Assist callers with appointment scheduling welcomeMessage: type: string minLength: 1 maxLength: 1000 description: Welcome message for callers example: Welcome to Shine Healthcare Clinic guideline: type: string minLength: 1 maxLength: 5096 description: Additional guidelines for the AI Agent. The combined length of `goal` and `guideline` must not exceed 5096 characters. example: Be polite and professional IntentTransferTo: type: object required: - contactType properties: contactType: type: string description: 'Type of transfer destination. - PEOPLE - A person in the organization. - RESOURCE_GROUP - A group resource such as a call queue or hunt group. - CONTACT - An organization contact. - PHONE_NUMBER - A raw phone number or extension.' enum: - PEOPLE - RESOURCE_GROUP - CONTACT - PHONE_NUMBER example: RESOURCE_GROUP contactId: type: string description: Unique identifier for the transfer destination, encoded using the resource type indicated by contactType (PEOPLE, RESOURCE_GROUP, or CONTACT). Not required when contactType is PHONE_NUMBER. example: Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQL2Y0MWNkMDUxLTgxN2YtNGQ4MS1hMWNlLTBmZDM5YzFlN2I5Zg name: type: string description: Name of the calling service or contact. example: RS Call Queue phoneNumber: type: string description: Phone number of calling service or contact. example: '+4765241628' CreateKnowledgeBaseDocumentRequest: type: object required: - name - content properties: name: type: string minLength: 1 maxLength: 64 description: The display name assigned to the Knowledge Base document. Used to identify the document across the platform. example: Company FAQ content: type: string description: The content of the document. example: This document contains frequently asked questions about our company services. example: name: Company FAQ content: This document contains frequently asked questions about our company services. UpdateKnowledgeBaseRequest: type: object minProperties: 1 properties: name: type: string minLength: 1 maxLength: 64 description: The display name assigned to the Knowledge Base. Used to identify the KB across the platform. example: Shree HealthCare Clinic KB Updated description: type: string maxLength: 500 description: A human-readable description providing additional context about the purpose or contents of the Knowledge Base. example: Updated description for the knowledge base. example: name: Shree HealthCare Clinic KB Updated description: Updated description for the knowledge base. AvailableNumber: type: object required: - phoneNumber - state - isMainNumber - telephonyType - tollFreeNumber - isServiceNumber properties: phoneNumber: type: string description: Phone number available for assignment in E.164 format. example: '+12134567895' state: type: string description: 'State of the phone number. - ACTIVE - Number is available to be assigned. - INACTIVE - Number is not available for assignment.' enum: - ACTIVE - INACTIVE example: ACTIVE isMainNumber: type: boolean description: Flag to indicate if the number is the main number for the location. example: false telephonyType: type: string description: 'Defines the number type. - PSTN_NUMBER - Public switched telephone network number.' enum: - PSTN_NUMBER example: PSTN_NUMBER tollFreeNumber: type: boolean description: Flag to indicate if the number is toll free. example: false isServiceNumber: type: boolean description: Flag to indicate if the number is Service Number. example: false UpdateAiVoice: type: object properties: aiEngine: type: string description: 'AI engine name. - `PRO` — Available in all supported countries. - `PRO_US` — Available in the United States only.' enum: - PRO - PRO_US example: PRO displayName: type: string description: Display name of the AI Receptionist voice. example: en-US-Jennifer language: type: string description: Voice language name example: English languageCode: type: string description: Voice language locale in BCP 47 format example: en-US TransparencySettings: type: object required: - enabled properties: enabled: type: boolean description: Flag to enable or disable transparency disclosure for AI Receptionist. example: true message: type: string description: Custom transparency message to inform callers they are interacting with an AI system. example: Hi, I'm an AI receptionist. This interaction may be recorded and transcribed for troubleshooting purposes. disableReason: type: string description: Reason for disabling transparency disclosure. example: Organization operates outside EU jurisdiction TransferTo: type: object properties: contactType: type: string description: 'Type of contact for the transfer target: - `PEOPLE` - A person in the organization. - `RESOURCE_GROUP` - A group resource such as a call queue or hunt group. - `CONTACT` - An organization contact. - `PHONE_NUMBER` - A raw phone number or extension.' enum: - PEOPLE - RESOURCE_GROUP - CONTACT - PHONE_NUMBER example: PEOPLE contactId: type: string description: Identifier of the contact to transfer to. Not applicable when contactType is PHONE_NUMBER meaning contactId is not sent in request for PHONE_NUMBER. example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9hYmNkZWYxMi0zNDU2LTc4OTAtYWJjZC1lZjEyMzQ1Njc4OTA phoneNumber: type: string description: Phone number to transfer the call to. example: '+14085550000' UploadKnowledgeBaseDocumentResponse: type: object required: - id properties: id: type: string description: Unique identifier of the newly uploaded document. example: Y2lzY29zcGFyazovL3VzL0tCX0RPQ1VNRU5ULzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw example: id: Y2lzY29zcGFyazovL3VzL0tCX0RPQ1VNRU5ULzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw KnowledgeBaseDocumentDetails: type: object required: - id - knowledgeBaseId - name - content - fileSize - knowledgeType - status - createdAt - updatedAt properties: id: type: string description: Unique identifier for the document. example: Y2lzY29zcGFyazovL3VzL0tCX0RPQ1VNRU5ULzY5ZWViYWZmOWQyNzU0ZGI2NGUwNjZiMA knowledgeBaseId: type: string description: Unique identifier for the Knowledge Base this document belongs to. example: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5ZWViNzE5MGRlMDAyZWZiZTA0MTU1ZA name: type: string description: Name of the document. example: AIReceptionistChangesDoc content: type: string description: Content of the document. example: AIReceptionistChangesDoc description: type: string description: Description of the document. example: '' fileName: type: string description: Original file name if the document was uploaded as a file. example: '' fileSize: type: integer format: int64 description: Size of the document in bytes. example: 210 knowledgeType: type: string description: 'Type of knowledge content. - `article` - Text-based content created directly via API. - `file` - Content uploaded as a document file.' enum: - article - file example: article status: type: string description: 'Processing status of the document. - `pending` - Document is waiting to be processed. - `processing` - Document is currently being indexed. - `success` - Document has been successfully indexed and is available for queries. - `failed` - Document processing failed.' enum: - pending - processing - success - failed example: success createdAt: type: string format: date-time description: Timestamp indicating when the document was created, in ISO 8601 format. example: '2024-08-16T18:30:20.882Z' updatedAt: type: string format: date-time description: Timestamp indicating when the document was last modified, in ISO 8601 format. example: '2024-08-16T18:30:20.882Z' example: id: Y2lzY29zcGFyazovL3VzL0tCX0RPQ1VNRU5ULzY5ZWViYWZmOWQyNzU0ZGI2NGUwNjZiMA knowledgeBaseId: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5ZWViNzE5MGRlMDAyZWZiZTA0MTU1ZA name: AIReceptionistChangesDoc content: AIReceptionistChangesDoc description: '' fileName: '' fileSize: 210 knowledgeType: article status: success createdAt: '2024-08-16T18:30:20.882Z' updatedAt: '2024-08-16T18:30:20.882Z' AiReceptionistTemplate: type: object required: - id - name - welcomeMessage properties: id: type: string description: Unique identifier for the AI receptionist template. example: Y2lzY29zcGFyazovL3VzL1RFTVBMQVRFL2EyYjNjNDU2LTc4OTAtMTIzNC01Njc4LTkwYWJjZGVmMTIzNA name: type: string description: Name of the AI Receptionist template. example: Clinic goal: type: string description: Goal of the AI Receptionist. example: As an AI receptionist for Shine Healthcare Clinic, your role is to help callers with necessary information regarding our services. welcomeMessage: type: string description: Welcome message to be played before the call handling. example: Hello I am your AI Receptionist. How can I help you today? guideline: type: string description: Guidelines for the AI receptionist to follow. This includes information like identity, role definition, context, behavior, etc. example: '1. Role Definition: You are a friendly assistant 2. Context: User can only book or cancel appointment' defaultTransparencyMessage: type: string description: Default transparency disclosure message for AI Receptionist. This message explicitly informs callers they are interacting with an AI system, ensuring compliance with EU AI Act transparency obligations for Limited Risk AI systems. example: Hi, I'm an AI receptionist. This interaction may be recorded and transcribed for troubleshooting purposes. example: id: Y2lzY29zcGFyazovL3VzL1RFTVBMQVRFL2EyYjNjNDU2LTc4OTAtMTIzNC01Njc4LTkwYWJjZGVmMTIzNA name: Clinic goal: As an AI receptionist for Shine Healthcare Clinic, your role is to help callers with necessary information regarding our services. welcomeMessage: Hello I am your AI Receptionist. How can I help you today? guideline: '1. Role Definition: You are a friendly assistant 2. Context: User can only book or cancel appointment' defaultTransparencyMessage: Hi, I'm an AI receptionist. This interaction may be recorded and transcribed for troubleshooting purposes. IntentTransferToRequest: type: object description: Transfer destination configuration for the intent. required: - contactType properties: contactType: type: string description: 'Contact type. - PEOPLE - A person in the organization. - RESOURCE_GROUP - A group resource such as a call queue or hunt group. - CONTACT - An organization contact. - PHONE_NUMBER - A raw phone number or extension.' enum: - PEOPLE - RESOURCE_GROUP - CONTACT - PHONE_NUMBER example: PEOPLE contactId: type: string description: Unique identifier for the transfer destination, encoded using the resource type indicated by contactType (PEOPLE, RESOURCE_GROUP, or CONTACT). Not required when contactType is PHONE_NUMBER. example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNDFjZDA1MS04MTdmLTRkODEtYTFjZS0wZmQzOWMxZTdiOWY phoneNumber: type: string description: Phone number for intent transfer. example: '+4765241628' DefaultAction: type: object required: - actionType properties: actionType: type: string description: 'Default action to be performed when a call is received: - `PLAY_MESSAGE_AND_DISCONNECT` - Play an audio message and disconnect the call. - `TRANSFER_TO_OPERATOR` - Transfer the call to an operator.' enum: - PLAY_MESSAGE_AND_DISCONNECT - TRANSFER_TO_OPERATOR example: PLAY_MESSAGE_AND_DISCONNECT audioMessageSelection: type: string description: 'Announcement type to be played. Mandatory if actionType is `PLAY_MESSAGE_AND_DISCONNECT`: - `DEFAULT` - Use the system default audio message. - `CUSTOM` - Use a custom uploaded audio file.' enum: - DEFAULT - CUSTOM example: CUSTOM audioFile: description: Audio file details. Mandatory if audioMessageSelection is CUSTOM. allOf: - $ref: '#/components/schemas/AudioFile' transferToNumber: type: string description: Transfer to number. Mandatory if actionType is `TRANSFER_TO_OPERATOR`. example: '+13504342182' transferTo: description: Transfer target configuration. Alternative to transferToNumber allOf: - $ref: '#/components/schemas/TransferTo' AiVoice: type: object properties: aiEngine: type: string description: 'AI engine name. - `PRO` — Available in all supported countries. - `PRO_US` — Available in the United States only.' enum: - PRO - PRO_US example: PRO displayName: type: string description: Display name of the voice example: en-US-AvaMultilingualNeural language: type: string description: Voice language name example: English languageCode: type: string description: Voice language locale in BCP 47 format example: en-US CreateDefaultAction: type: object required: - actionType properties: actionType: type: string description: 'Default action to be played when call is first received: - `PLAY_MESSAGE_AND_DISCONNECT` - Play an audio message and disconnect the call. - `TRANSFER_TO_OPERATOR` - Transfer the call to an operator.' enum: - PLAY_MESSAGE_AND_DISCONNECT - TRANSFER_TO_OPERATOR example: PLAY_MESSAGE_AND_DISCONNECT audioMessageSelection: type: string description: 'Announcement type to be played. Mandatory if actionType is `PLAY_MESSAGE_AND_DISCONNECT`: - `DEFAULT` - Use the system default audio message. - `CUSTOM` - Use a custom uploaded audio file.' enum: - DEFAULT - CUSTOM example: CUSTOM audioFileId: type: string description: Audio message file ID which is already uploaded. Mandatory if audioMessageSelection is CUSTOM example: Y2lzY29zcGFyazovL3VzL0FVRElPX0ZJTEUvYWY3ZTU0YTktZTk3My00ZDVjLWJmZmUtMTAzMDNjMTJiZmNm transferToNumber: type: string minLength: 1 maxLength: 30 description: Phone number or extension to transfer call to. Mandatory if actionType is `TRANSFER_TO_OPERATOR`. example: '+4765241628' transferTo: description: Transfer target configuration. Alternative to transferToNumber allOf: - $ref: '#/components/schemas/TransferTo' IntentTransferToDetails: type: object description: Transfer destination details for the intent. required: - contactType properties: contactType: type: string description: 'Contact type. - PEOPLE - A person in the organization. - RESOURCE_GROUP - A group resource such as a call queue or hunt group. - CONTACT - An organization contact. - PHONE_NUMBER - A raw phone number or extension.' enum: - PEOPLE - RESOURCE_GROUP - CONTACT - PHONE_NUMBER example: PEOPLE contactId: type: string description: Unique identifier for the transfer destination, encoded using the resource type indicated by contactType (PEOPLE, RESOURCE_GROUP, or CONTACT). Not required when contactType is PHONE_NUMBER. example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNDFjZDA1MS04MTdmLTRkODEtYTFjZS0wZmQzOWMxZTdiOWY name: type: string description: Name of the calling service or contact. example: John Doe phoneNumber: type: string description: Phone number of calling service or contact. example: '+4765241628' CreateAiReceptionistRequest: type: object required: - name - enabled - defaultAction - aiAgent properties: name: type: string minLength: 1 maxLength: 128 description: Name of the AI Receptionist. This has to be unique across location. example: Shine Healthcare Clinic enabled: type: boolean description: Flag to indicate AI receptionist is enabled or not. When disabled, incoming calls to this AI receptionist will not be answered. example: true phoneNumber: type: string minLength: 1 maxLength: 23 description: Phone number of the AI Receptionist. Either phoneNumber or extension is mandatory. At least one is required. example: '+13504342182' extension: type: string minLength: 2 maxLength: 10 description: Extension of the AI Receptionist. Either phoneNumber or extension is mandatory. At least one is required. example: '2182' directLineCallerIdName: description: Direct line caller ID name configuration allOf: - $ref: '#/components/schemas/DirectLineCallerIdName' dialByName: type: string minLength: 1 maxLength: 128 description: A dial by name used for AI Receptionist name dialing. Characters of `%`, `+`, `\`, `"` and Unicode characters are not allowed. example: Shine Healthcare defaultAction: description: Default action configuration for the AI Receptionist allOf: - $ref: '#/components/schemas/CreateDefaultAction' aiAgent: description: AI Agent configuration allOf: - $ref: '#/components/schemas/CreateAiAgent' AiReceptionistVoicesResponse: type: object required: - aiEngines properties: aiEngines: type: array items: $ref: '#/components/schemas/AiEngine' description: List of AI engines with their available voices. example: - name: PRO voices: - language: English languageCode: en-US displayName: en-US-Maria isDefault: false gender: FEMALE ModifyAiReceptionistIntentRequest: type: object properties: name: type: string description: Name of the intent. minLength: 1 maxLength: 64 example: For Physical Therapy description: type: string description: Description of the intent (Action). minLength: 1 maxLength: 1024 example: Connect the caller to knowledgeable representative if they seek assistance with Physical Therapy transferTo: $ref: '#/components/schemas/IntentTransferToRequest' UpdateAlternateNumber: type: object properties: phoneNumber: type: string minLength: 1 maxLength: 23 description: Alternate phone number. example: '+12147691003' ringPattern: type: string description: 'Ring pattern for the alternate number: - `NORMAL` - Standard ring pattern. - `LONG_LONG` - Two long rings. - `SHORT_SHORT_LONG` - Two short rings followed by one long ring. - `SHORT_LONG_SHORT` - Short, long, short ring pattern.' enum: - NORMAL - LONG_LONG - SHORT_SHORT_LONG - SHORT_LONG_SHORT example: LONG_LONG Voice: type: object required: - language - languageCode - displayName - isDefault - gender properties: language: type: string description: Voice language. example: English languageCode: type: string description: Voice locale code. example: en-US displayName: type: string description: Voice display name. example: en-US-Jennifer isDefault: type: boolean description: Field to indicate default voice. example: true gender: type: string description: 'Voice gender. - MALE — Male voice. - FEMALE — Female voice.' enum: - MALE - FEMALE example: FEMALE KnowledgeBaseMappedBot: type: object required: - id - connectedAt - agentId - name properties: id: type: string description: Unique identifier for the AI Receptionist. example: Y2lzY29zcGFyazovL3VzL0FJX1JFQ0VQVElPTklTVC8wNWViZTUzZS02YTg5LTRkMTktYmIzYi0xNmJhZDU4OWRhNmE connectedAt: type: string format: date-time description: Timestamp indicating when the Knowledge Base was associated with the AI Receptionist, in ISO 8601 format. example: '2024-08-16T18:30:20.882Z' agentId: type: string description: Unique identifier for the AI agent associated with this receptionist. example: Y2lzY29zcGFyazovL3VzL0FJX0FHRU5ULzY5YmFhZDIwOGUzOWUyMGE0ZTNkNjEwNA name: type: string description: Name of the AI Receptionist (Bot). example: AIR P Test CreateAiVoice: type: object required: - aiEngine - displayName - language - languageCode properties: aiEngine: type: string description: 'AI engine name. - `PRO` — Available in all supported countries. - `PRO_US` — Available in the United States only.' enum: - PRO - PRO_US example: PRO displayName: type: string description: Display name of the AI Receptionist voice. example: en-US-Jennifer language: type: string description: Voice language name example: English languageCode: type: string description: Voice language locale in BCP 47 format example: en-US ValidateAiReceptionistRequest: type: object required: - name properties: name: type: string description: Name of the AI Receptionist. example: Shine Healthcare Clinic KnowledgeBaseDocumentListResponse: type: object properties: documents: type: array items: $ref: '#/components/schemas/KnowledgeBaseDocument' description: List of documents in the Knowledge Base. example: documents: - id: Y2lzY29zcGFyazovL3VzL0tCX0RPQ1VNRU5ULzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw knowledgeBaseId: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw name: FAQ Document content: This document contains frequently asked questions. description: Company FAQ fileName: FAQ.pdf fileSize: 1024 knowledgeType: file status: success createdAt: '2024-08-16T18:30:20.882Z' updatedAt: '2024-08-16T18:30:20.882Z' KnowledgeBaseDocument: type: object description: A knowledge base document retrieved during tool execution. properties: id: type: string description: Unique identifier of the knowledge base document. name: type: string description: Name or filename of the knowledge base document. score: type: number description: Relevance score of the document. text: type: string description: Extracted text content from the document. AiReceptionistIntentDetails: type: object required: - id - name - description - transferTo properties: id: type: string description: Unique identifier for a specific AI Receptionist intent within a given location and AI Receptionist instance. example: Y2lzY29zcGFyazovL3VzL0lOVEVOVC82OGVhZTIyNDQ3NDZiZDJlMjJiZGY2ODY name: type: string description: Name of the intent. example: Physical Therapy description: type: string description: Description of the intent (Action). example: Connect the caller to knowledgeable representative if they seek assistance with Physical Therapy transferTo: $ref: '#/components/schemas/IntentTransferToDetails' UpdateAiReceptionistRequest: type: object properties: name: type: string minLength: 1 maxLength: 128 description: Name of the AI Receptionist. This has to be unique across location. example: Shine Healthcare Clinic enabled: type: boolean description: Flag to indicate AI receptionist is enabled or not. When disabled, incoming calls to this AI receptionist will not be answered. example: true phoneNumber: type: string minLength: 1 maxLength: 23 description: Phone number of the AI Receptionist. Either phoneNumber or extension is mandatory. At least one is required. example: '+13504342182' extension: type: string minLength: 2 maxLength: 10 description: Extension of the AI Receptionist. Either phoneNumber or extension is mandatory. At least one is required. example: '2182' alternateNumbers: type: array description: List of alternate phone numbers to assign to the AI Receptionist. items: $ref: '#/components/schemas/UpdateAlternateNumber' directLineCallerIdName: description: Direct line caller ID name configuration allOf: - $ref: '#/components/schemas/DirectLineCallerIdName' dialByName: type: string minLength: 1 maxLength: 128 description: A dial by name used for AI Receptionist name dialing. Characters of `%`, `+`, `\`, `"` and Unicode characters are not allowed. example: Shine Healthcare defaultAction: description: Default action configuration for the AI Receptionist allOf: - $ref: '#/components/schemas/UpdateDefaultAction' aiAgent: description: AI Agent configuration allOf: - $ref: '#/components/schemas/UpdateAiAgent' CreateKnowledgeBaseResponse: type: object required: - id properties: id: type: string description: Unique identifier of the newly created Knowledge Base. example: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw example: id: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw ValidateCountryRequest: type: object required: - countryCode properties: countryCode: type: string description: Two letter country code of the location for which AI Receptionist needs to be validated. example: US locationId: type: string description: Location associated with the AI Receptionist. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgyMjI4MWVkLWUyMmItMTYxNi1hOTYyLTExYTY2OTExYTY2OQ example: countryCode: US locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgyMjI4MWVkLWUyMmItMTYxNi1hOTYyLTExYTY2OTExYTY2OQ AvailableNumbersListResponse: type: object properties: phoneNumbers: type: array items: $ref: '#/components/schemas/AvailableNumber' description: List of available phone numbers. example: - phoneNumber: '+12134567895' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false example: phoneNumbers: - phoneNumber: '+12134567895' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false UpdateDefaultAction: type: object properties: actionType: type: string description: 'Default action to be played when call is first received: - `PLAY_MESSAGE_AND_DISCONNECT` - Play an audio message and disconnect the call. - `TRANSFER_TO_OPERATOR` - Transfer the call to an operator.' enum: - PLAY_MESSAGE_AND_DISCONNECT - TRANSFER_TO_OPERATOR example: PLAY_MESSAGE_AND_DISCONNECT audioMessageSelection: type: string description: 'Announcement type to be played. Mandatory if actionType is `PLAY_MESSAGE_AND_DISCONNECT`: - `DEFAULT` - Use the system default audio message. - `CUSTOM` - Use a custom uploaded audio file.' enum: - DEFAULT - CUSTOM example: CUSTOM audioFileId: type: string description: Audio message file ID which is already uploaded. Mandatory if audioMessageSelection is CUSTOM example: Y2lzY29zcGFyazovL3VzL0FVRElPX0ZJTEUvYWY3ZTU0YTktZTk3My00ZDVjLWJmZmUtMTAzMDNjMTJiZmNm transferToNumber: type: string minLength: 1 maxLength: 30 description: Phone number or extension to transfer call to. Mandatory if actionType is `TRANSFER_TO_OPERATOR`. example: '+4765241628' transferTo: description: Transfer target configuration. Alternative to transferToNumber allOf: - $ref: '#/components/schemas/TransferTo' AiReceptionistListResponse: type: object properties: aiReceptionists: type: array items: $ref: '#/components/schemas/AiReceptionist' description: List of AI Receptionists. example: - id: Y2lzY29zcGFyazovL3VzL0FJX1JFQ0VQVElPTklTVC82MDEyNGU1MC03MWNkLTQ2N2QtODkzZS1mMGY5MDc0YWYyYjc name: Shine Healthcare Clinic phoneNumber: '+13504342182' extension: '42182' routingPrefix: '1234' esn: '123442182' location: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgyMjI4MWVkLWUyMmItMTYxNi1hOTYyLTExYTY2OTExYTY2OQ name: San Jose example: aiReceptionists: - id: Y2lzY29zcGFyazovL3VzL0FJX1JFQ0VQVElPTklTVC82MDEyNGU1MC03MWNkLTQ2N2QtODkzZS1mMGY5MDc0YWYyYjc name: Shine Healthcare Clinic phoneNumber: '+13504342182' extension: '42182' routingPrefix: '1234' esn: '123442182' location: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgyMjI4MWVkLWUyMmItMTYxNi1hOTYyLTExYTY2OTExYTY2OQ name: San Jose AudioFile: type: object properties: id: type: string description: Audio file ID example: Y2lzY29zcGFyazovL3VzL0FVRElPX0ZJTEUvYTJiM2M0NTYtNzg5MC0xMjM0LTU2NzgtOTBhYmNkZWYxMjM0 fileName: type: string description: Audio file name example: greeting.wav mediaFileType: type: string enum: - WAV description: 'Media file type. - `WAV` - WAV File Extension.' example: WAV level: type: string enum: - ORGANIZATION - LOCATION - ENTITY description: 'Level at which the audio file is stored and shared. - `ORGANIZATION` — File is shared across the entire organization. - `LOCATION` — File is scoped to a specific location. - `ENTITY` — File is scoped to a specific entity (e.g., AI Receptionist).' example: ORGANIZATION isTextToSpeech: type: boolean description: Flag indicating if this is a text-to-speech file example: false CreateAiGuidelines: type: object required: - welcomeMessage properties: goal: type: string maxLength: 5096 description: Goal of the AI Receptionist. The combined length of `goal` and `guideline` must not exceed 5096 characters. example: As an AI receptionist for Shine Healthcare Clinic, your role is to help callers with necessary information regarding our services. welcomeMessage: type: string maxLength: 1000 description: Welcome message to be played before the call handling. example: Hello I am your AI Receptionist. How can I help you today? guideline: type: string maxLength: 5096 description: Guidelines to AI Receptionist to follow. This includes information like Identity, role definition, context, behavior etc.. The combined length of `goal` and `guideline` must not exceed 5096 characters. example: '1. Role Definition: You are a friendly assistant 2. Context: User can only book or cancel appointment' DirectLineCallerIdName: type: object required: - directLineCallerIdNameSelection properties: directLineCallerIdNameSelection: type: string description: 'Field to indicate the option chosen to represent the Caller ID: - `DISPLAY_NAME` - Use the AI Receptionist display name as the caller ID. - `CUSTOM_NAME` - Use a custom name as the caller ID.' enum: - DISPLAY_NAME - CUSTOM_NAME example: CUSTOM_NAME customName: type: string minLength: 1 maxLength: 50 description: Carries the customized name when "CUSTOM_NAME" is the chosen option. It can be empty if it's not configured. example: Shine Clinic AiReceptionistIntentListResponse: type: object properties: intents: type: array items: $ref: '#/components/schemas/AiReceptionistIntent' description: List of AI Receptionist intents. example: - id: Y2lzY29zcGFyazovL3VzL0lOVEVOVC8xMjM0NTY3OC05MGFiLWNkZWYtMTIzNC01Njc4OTBhYmNkZWY name: Transfer to Support transferTo: contactType: RESOURCE_GROUP contactId: Y2lzY29zcGFyazovL3VzL1JFU09VUkNFX0dST1VQL2Y0MWNkMDUxLTgxN2YtNGQ4MS1hMWNlLTBmZDM5YzFlN2I5Zg name: RS Call Queue phoneNumber: '+4765241628' KnowledgeBaseDetails: type: object required: - id - name - documentsCount - filesCount - filesSize - createdAt - updatedAt properties: id: type: string description: Unique identifier of the Knowledge Base. example: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw name: type: string description: The display name assigned to the Knowledge Base. Used to identify the KB across the platform. example: Shree HealthCare Clinic KB description: type: string description: A human-readable description providing additional context about the purpose or contents of the Knowledge Base. example: A centralized repository of medical and administrative information for Shree Health Care Clinic. documentsCount: type: integer description: The total count of documents that have been uploaded or indexed into the Knowledge Base. example: 5 filesCount: type: integer description: The total count of files that have been uploaded to the Knowledge Base. example: 3 filesSize: type: integer format: int64 description: The cumulative size (in bytes) of all files stored in the Knowledge Base. example: 210 createdAt: type: string format: date-time description: Timestamp indicating when the Knowledge Base was originally created, in ISO 8601 format. example: '2024-08-16T18:30:20.882Z' updatedAt: type: string format: date-time description: Timestamp indicating when the Knowledge Base was last modified, in ISO 8601 format. example: '2024-08-16T18:30:20.882Z' mappedBots: type: array items: $ref: '#/components/schemas/KnowledgeBaseMappedBot' description: List of AI Receptionists that are currently associated with this Knowledge Base. example: id: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFLzY5YzNlY2NjZDc5MzYzZGM2ODliM2UyYw name: Shree HealthCare Clinic KB description: A centralized repository of medical and administrative information for Shree Health Care Clinic. documentsCount: 5 filesCount: 3 filesSize: 210 createdAt: '2024-08-16T18:30:20.882Z' updatedAt: '2024-08-16T18:30:20.882Z' mappedBots: - id: Y2lzY29zcGFyazovL3VzL0FJX1JFQ0VQVElPTklTVC8wNWViZTUzZS02YTg5LTRkMTktYmIzYi0xNmJhZDU4OWRhNmE connectedAt: '2024-08-16T18:30:20.882Z' agentId: Y2lzY29zcGFyazovL3VzL0FJX0FHRU5ULzY5YmFhZDIwOGUzOWUyMGE0ZTNkNjEwNA name: AIR P Test CreateAiReceptionistIntentResponse: type: object required: - id properties: id: type: string description: Unique identifier for a specific AI Receptionist intent within a given location and AI Receptionist instance. example: Y2lzY29zcGFyazovL3VzL0lOVEVOVC82OGVhZTIyNDQ3NDZiZDJlMjJiZGY2ODY UpdateAiAgent: type: object properties: voice: description: Voice configuration for the AI Agent allOf: - $ref: '#/components/schemas/UpdateAiVoice' knowledgeBaseId: type: string description: Unique identifier for the Knowledge Base used by the AI Agent to answer caller queries. example: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFL2IzYzRkNTY3LTg5MDEtMjM0NS02Nzg5LTAxYmNkZWYyMzQ1Ng guidelines: description: AI Agent guidelines allOf: - $ref: '#/components/schemas/UpdateAiGuidelines' transparencySettings: description: Transparency settings for AI Receptionist. Configures disclosure messages to inform callers they are interacting with an AI system, ensuring compliance with EU AI Act transparency obligations. allOf: - $ref: '#/components/schemas/TransparencySettings' CreateKnowledgeBaseRequest: type: object required: - name properties: name: type: string minLength: 1 maxLength: 64 description: The display name assigned to the Knowledge Base. Used to identify the KB across the platform. example: Shree HealthCare Clinic KB description: type: string maxLength: 500 description: A human-readable description providing additional context about the purpose or contents of the Knowledge Base. example: A centralized repository of medical and administrative information for Shree Health Care Clinic. example: name: Shree HealthCare Clinic KB description: A centralized repository of medical and administrative information for Shree Health Care Clinic. AiAgent: type: object properties: agentId: type: string description: AI Agent ID from Webex AI Agent Studio example: Y2lzY29zcGFyazovL3VzL0FJX0FHRU5ULzY4ZWFlMjI0NDc0NmJkMmUyMmJkZjY4Ng voice: description: Voice configuration for the AI Agent allOf: - $ref: '#/components/schemas/AiVoice' knowledgeBaseId: type: string description: Unique identifier for the Knowledge Base used by the AI Agent to answer caller queries. example: Y2lzY29zcGFyazovL3VzL0tOT1dMRURHRV9CQVNFL2IzYzRkNTY3LTg5MDEtMjM0NS02Nzg5LTAxYmNkZWYyMzQ1Ng guidelines: description: AI Agent guidelines allOf: - $ref: '#/components/schemas/AiGuidelines' transparencySettings: description: Transparency settings for AI Receptionist. Configures disclosure messages to inform callers they are interacting with an AI system, ensuring compliance with EU AI Act transparency obligations. allOf: - $ref: '#/components/schemas/TransparencySettingsResponse' 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: http description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN scheme: bearer bearerFormat: JWT