openapi: 3.0.0
info:
  title: Webex Admin Address Book Caller Reputation Provider API
  version: 1.0.0
  description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling.
tags:
- name: Caller Reputation Provider
paths:
  /telephony/config/serviceSettings/callerReputationProvider:
    get:
      responses:
        '200':
          description: Successful response with caller reputation provider settings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallerReputationProviderSettings'
              example:
                name: Acme Reputation Provider
                id: provider-123
                clientId: client-456
                enabled: true
                callBlockScoreThreshold: '0.7'
                callAllowScoreThreshold: '0.3'
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Get Caller Reputation Provider Service Settings
      operationId: getCallerReputationProviderSettings
      description: Retrieves the configuration and status of the caller reputation provider service for Webex Calling.
      tags:
      - Caller Reputation Provider
      parameters:
      - name: organizationId
        in: query
        description: Unique identifier for the organization.
        required: false
        schema:
          type: string
    put:
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Update Caller Reputation Provider Service Settings
      operationId: updateCallerReputationProviderSettings
      description: Updates the configuration of the caller reputation provider service for Webex Calling.
      tags:
      - Caller Reputation Provider
      parameters:
      - name: organizationId
        in: query
        description: Unique identifier for the organization.
        required: false
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallerReputationProviderSettingsUpdate'
            example:
              enabled: true
              id: provider-123
              name: Acme Reputation Provider
              clientId: client-456
              clientSecret: secret-789
              callBlockScoreThreshold: '0.7'
              callAllowScoreThreshold: '0.3'
  /telephony/config/serviceSettings/callerReputationProvider/status:
    get:
      responses:
        '200':
          description: Successful response with caller reputation provider status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallerReputationProviderStatus'
              example:
                id: provider-123
                status: CONNECTED
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Get Caller Reputation Provider Status
      operationId: getCallerReputationProviderStatus
      description: Retrieves the current status of the caller reputation provider integration for Webex Calling.
      tags:
      - Caller Reputation Provider
      parameters:
      - name: organizationId
        in: query
        description: Unique identifier for the organization.
        required: false
        schema:
          type: string
  /telephony/config/serviceSettings/callerReputationProvider/actions/unlock/invoke:
    post:
      responses:
        '200':
          description: Successful unlock of caller reputation provider.
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Unlock Caller Reputation Provider
      operationId: unlockCallerReputationProvider
      description: Unlocks the caller reputation provider for Webex Calling.
      tags:
      - Caller Reputation Provider
      parameters:
      - name: organizationId
        in: query
        description: Unique identifier for the organization.
        required: false
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallerReputationProviderUnlockRequest'
            example:
              id: provider-123
  /telephony/config/serviceSettings/callerReputationProvider/providers:
    get:
      responses:
        '200':
          description: Successful response with list of caller reputation providers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallerReputationProviderProvidersResponse'
              example:
                providers:
                - id: provider-123
                  enabled: true
                  name: Acme Reputation Provider
                  regions:
                  - id: region-1
                    name: US East
                    type: primary
                    visible: true
                    environmentType: production
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Get Caller Reputation Provider Providers
      operationId: getCallerReputationProviderProviders
      description: Retrieves the list of available caller reputation providers and their regions for Webex Calling.
      tags:
      - Caller Reputation Provider
      parameters:
      - name: organizationId
        in: query
        description: Unique identifier for the organization.
        required: false
        schema:
          type: string
components:
  schemas:
    CallerReputationProviderSettingsUpdate:
      type: object
      properties:
        enabled:
          type: boolean
          description: Indicates if the caller reputation provider service is enabled. when set to true, all other fields are required except clientSecret.
          example: true
        id:
          type: string
          description: Unique identifier for the reputation provider.
          example: provider-123
        name:
          type: string
          description: Name of the reputation provider.
          example: Acme Reputation Provider
        clientId:
          type: string
          description: Client ID used for integration with the reputation provider.
          example: client-456
        clientSecret:
          type: string
          description: Client secret used for integration with the reputation provider.
          example: secret-789
        callBlockScoreThreshold:
          type: string
          description: Score threshold for blocking calls.
          example: '0.7'
        callAllowScoreThreshold:
          type: string
          description: Score threshold for allowing calls.
          example: '0.3'
      example:
        enabled: true
        id: provider-123
        name: Acme Reputation Provider
        clientId: client-456
        clientSecret: secret-789
        callBlockScoreThreshold: '0.7'
        callAllowScoreThreshold: '0.3'
    CallerReputationProviderSettings:
      type: object
      properties:
        name:
          type: string
          description: Name of the reputation provider.
          example: Acme Reputation Provider
        id:
          type: string
          description: Unique identifier for the reputation provider.
          example: provider-123
        clientId:
          type: string
          description: Client ID used for integration with the reputation provider.
          example: client-456
        enabled:
          type: boolean
          description: Indicates if the caller reputation provider service is enabled.
          example: true
        callBlockScoreThreshold:
          type: string
          description: Score threshold for blocking calls.
          example: '0.7'
        callAllowScoreThreshold:
          type: string
          description: Score threshold for allowing calls.
          example: '0.3'
      example:
        name: Acme Reputation Provider
        id: provider-123
        clientId: client-456
        enabled: true
        callBlockScoreThreshold: '0.7'
        callAllowScoreThreshold: '0.3'
    CallerReputationProviderProvidersResponse:
      type: object
      properties:
        providers:
          type: array
          items:
            $ref: '#/components/schemas/CallerReputationProviderProvider'
          description: List of caller reputation providers.
      example:
        providers:
        - id: provider-123
          enabled: true
          name: Acme Reputation Provider
          regions:
          - id: region-1
            name: US East
            type: primary
            visible: true
            environmentType: production
    CallerReputationProviderRegion:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the region.
          example: region-1
        name:
          type: string
          description: Name of the region.
          example: US East
        type:
          type: string
          description: Type of the region (e.g., primary, secondary).
          example: primary
        visible:
          type: boolean
          description: Indicates if the region is visible.
          example: true
        environmentType:
          type: string
          description: Environment type of the region (e.g., production, staging).
          example: production
      example:
        id: region-1
        name: US East
        type: primary
        visible: true
        environmentType: production
    CallerReputationProviderStatus:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the reputation provider.
          example: provider-123
        status:
          $ref: '#/components/schemas/CallerReputationProviderStatusEnum'
      required:
      - id
      - status
      example:
        id: provider-123
        status: CONNECTED
    CallerReputationProviderUnlockRequest:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the reputation provider.
          example: provider-123
      required:
      - id
      example:
        id: provider-123
    CallerReputationProviderProvider:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the provider.
          example: provider-123
        enabled:
          type: boolean
          description: Indicates if the provider is enabled.
          example: true
        name:
          type: string
          description: Name of the provider.
          example: Acme Reputation Provider
        regions:
          type: array
          items:
            $ref: '#/components/schemas/CallerReputationProviderRegion'
          description: List of regions for the provider.
      example:
        id: provider-123
        enabled: true
        name: Acme Reputation Provider
        regions:
        - id: region-1
          name: US East
          type: primary
          visible: true
          environmentType: production
    CallerReputationProviderStatusEnum:
      type: string
      enum:
      - NOT_CONNECTED
      - CONNECTING
      - CONNECTED
      - ACTIVE
      - EXPIRED
      - AUTH_FAILED
      - PROVIDER_DISABLED
      description: "Status of the caller reputation provider integration.\n\n * `NOT_CONNECTED` - Provider is not connected.\n * `CONNECTING` - Provider is in the process of connecting.\n * `CONNECTED` - Provider is connected.\n * `ACTIVE` - Provider is active and operational.\n * `EXPIRED` - Provider's session or token has expired.\n * `AUTH_FAILED` - Authentication with the provider failed.\n * `PROVIDER_DISABLED` - Provider is disabled.\n"
      example: CONNECTED
  securitySchemes:
    oauth2:
      flows:
        authorizationCode:
          authorizationUrl: /
          scopes: {}
          tokenUrl: /
      type: oauth2
    bearer-key:
      type: http
      description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN
      scheme: bearer
      bearerFormat: JWT
    bearerAuth:
      type: oauth2
      description: OAuth 2.0 Bearer token authentication
      flows:
        authorizationCode:
          authorizationUrl: https://webexapis.com/v1/authorize
          tokenUrl: https://webexapis.com/v1/access_token
          scopes:
            spark:applications_token: Create access tokens for Service Apps