Webex

Cisco Webex is a comprehensive collaboration platform offering APIs for messaging, meetings, calling, devices, and contact center workflows. The Webex Developer Platform enables developers to build integrations, bots, embedded apps, and automations using REST APIs, SDKs, and webhooks. Webex supports OAuth 2.0 authentication and provides separate API surfaces for messaging, video conferencing, cloud calling, admin management, and more.

9 APIs 10 Features

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

APIs

Webex Messaging

Webex Messaging API for creating and managing rooms, messages, attachments, teams, memberships, and real-time collaboration. Supports text, markdown, file sharing, and webhook e...

Webex Meetings

Webex Meetings API for scheduling, managing, and reporting on video meetings. Provides endpoints for meeting lifecycle management, invitees, participants, recordings, transcript...

Webex Admin

Webex Admin API for managing organizations, users, licenses, locations, workspaces, devices, and organization settings. Provides administrative control over Webex deployments in...

Webex Cloud Calling

Webex Cloud Calling API with 633 endpoints for managing users, locations, call settings, hunt groups, auto-attendants, voicemail, call queues, and PSTN configurations for cloud-...

Webex Contact Center

Webex Contact Center API for managing customer service operations including agents, queues, routing strategies, skills, and reporting. Enables programmatic control of contact ce...

Webex Devices

Webex Device API for managing Webex hardware devices, workspaces, and device configurations. Includes endpoints for device inventory, activation, workspace assignments, and devi...

Webex Broadworks Calling

Webex Broadworks Calling API for managing BroadWorks subscriber provisioning and migration to Webex. Enables service providers to integrate BroadWorks telephony infrastructure w...

Webex for UCM

Webex for Unified CM (UCM) API for managing on-premises Cisco Unified Communications Manager integration with Webex cloud services. Supports hybrid calling configurations.

Webex Wholesale

Webex Wholesale API for service provider partners to provision and manage Webex Wholesale (RTM) customers and subscriptions at scale. Enables white-label Webex deployment workfl...

Collections

Webex Admin

OPEN

Pricing Plans

Webex Plans Pricing

3 plans

PLANS

Rate Limits

Webex Rate Limits

2 limits

RATE LIMITS

FinOps

Webex Finops

FINOPS

Features

Cisco Webex: hundreds of services across Collaboration

Detailed pricing: see https://www.webex.com/pricing/index.html

Service: Webex Meetings

Service: Webex Calling

Service: Webex Messaging

Service: Webex Events

Service: Webex Webinars

Service: Webex Contact Center

Service: Webex Connect (CPaaS)

Service: Free / Webex Plus / Webex Suite / Enterprise tiers

Use Cases

Collaboration Automation

Automate room creation, messaging workflows, and team management using the Messaging API.

Meeting Scheduling Integration

Integrate Webex meeting scheduling into CRM, calendar, or project management applications.

Custom Bot Development

Build intelligent chatbots that respond to user commands and integrate with business systems.

Contact Center Automation

Programmatically configure contact center queues, routing strategies, and agent assignments.

Unified Communications Administration

Automate user provisioning, license assignment, and calling configuration at scale.

Event-Driven Workflows

Use webhooks to trigger business workflows when messages are sent, meetings start, or rooms change.

Integrations

Salesforce

Webex for Salesforce integration for CRM-embedded collaboration.

Microsoft Teams

Interoperability integration between Webex and Microsoft Teams.

Slack

Webex integration with Slack for cross-platform notifications and workflows.

Jira

Webex App Hub integration with Atlassian Jira for project tracking.

ServiceNow

Webex integration with ServiceNow for IT service management workflows.

Google Workspace

Webex integration with Google Calendar and Gmail.

Event Specifications

API Governance Rules

Webex API Rules

29 rules · 9 errors 14 warnings 6 info

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Webex Wholesale
  version: 1.0.0
items:
- info:
    name: Wholesale Billing Reports
    type: folder
  items:
  - info:
      name: List Wholesale Billing Reports
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/wholesale/billing/reports'
      params:
      - name: billingStartDate
        value: '2020-05-21'
        type: query
        description: Only include billing reports having this billing `startDate`.
      - name: billingEndDate
        value: '2020-05-30'
        type: query
        description: Only include billing reports having this billing `endDate`.
      - name: type
        value: PARTNER
        type: query
        description: Only include reports of this type.
      - name: sortBy
        value: billingStartDate
        type: query
        description: Sort the reports.
      - name: status
        value: COMPLETED
        type: query
        description: The status of the billing report
      - name: max
        value: '10'
        type: query
        description: Limit the maximum number of reports returned in the response, up to 100 per page. Refer to the [Pagination](/docs/basics#pagination)
          section of [Webex REST API Basics](/docs/api/basics).
      - name: subPartnerOrgId
        value: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi81MmNmNTc2ZC02MGE4LTQwN2EtYjIyYy00NjdjNTE1OTE5MDg
        type: query
        description: The Organization ID of the sub partner on Cisco Webex.
    docs: Search for associated wholesale billing reconciliation reports.
  - info:
      name: Create a Wholesale Billing Report
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/wholesale/billing/reports'
      body:
        type: json
        data: '{}'
    docs: Generate a wholesale billing reconciliation report.
  - info:
      name: Get a Wholesale Billing Report
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/wholesale/billing/reports/:id'
      params:
      - name: id
        value: Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2ZhOA
        type: path
        description: A unique identifier for the report being requested.
    docs: Retrieve a specific wholesale billing reconciliation report.
  - info:
      name: Delete a Wholesale Billing Report
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/wholesale/billing/reports/:id'
      params:
      - name: id
        value: Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2ZhOA
        type: path
        description: A unique report ID that corresponds to a billing report.
    docs: Delete a monthly reconciliation report by report ID.
- info:
    name: Wholesale Provisioning
    type: folder
  items:
  - info:
      name: List Wholesale Customers
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/wholesale/customers'
      params:
      - name: externalId
        value: c1677a16-557a-4fb4-b48f-24adde57ec99
        type: query
        description: Customer external ID.
      - name: orgId
        value: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi81MmNmNTc2ZC02MGE4LTQwN2EtYjIyYy00NjdjNTE1OTE5MDg
        type: query
        description: The encoded Organization ID for the customer.
      - name: status
        value: provisioned_with_errors
        type: query
        description: Customer API status.
      - name: offset
        value: '10'
        type: query
        description: Offset value for implementing pagination.
      - name: max
        value: '10'
        type: query
        description: The maximum number of customers returned in the response.
      - name: onBehalfOfSubPartnerOrgId
        value: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=
        type: query
        description: The encoded organization ID for the sub partner.
    docs: Return a list of wholesale customers. There are a number of filter options, which can be combined in a single request.
  - info:
      name: Provision a Wholesale Customer
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/wholesale/customers'
      params:
      - name: onBehalfOfSubPartnerOrgId
        value: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=
        type: query
        description: The encoded organization ID for the sub partner.
      body:
        type: json
        data: '{}'
    docs: 'Provision a Wholesale customer for Cisco Webex services.


      This API will allow a Service Provider to map the Wholesale customer and assign the required licenses and entitlements
      for Webex, Calling and Meetings.


      The Wholesale customer provisioning is asynchronous and thus a background task is created when this endpoint is invoked.


      **packages Note:**


      * `cisco_calling_plan` is dependent on: `common_area_calling`, `webex_calling`, `webex_suite`, `webex_voice`, `cx_essentials`,
      `webex_calling_stand'
  - info:
      name: Get a Wholesale Customer
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/wholesale/customers/:customerId'
      params:
      - name: customerId
        value: Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4
        type: path
        description: A unique identifier for the customer in question.
      - name: onBehalfOfSubPartnerOrgId
        value: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=
        type: query
        description: The encoded organization ID for the sub partner.
      - name: includePackageLicenseInfo
        value: 'true'
        type: query
        description: If specified as true, a list of licenseIds will be returned for all provisioned packages
    docs: Retrieves details of a provisioned Wholesale customer on Cisco Webex.
  - info:
      name: Update a Wholesale Customer
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/wholesale/customers/:customerId'
      params:
      - name: customerId
        value: Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4
        type: path
        description: A unique identifier for the customer to be updated.
      - name: onBehalfOfSubPartnerOrgId
        value: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=
        type: query
        description: The encoded organization ID for the sub partner.
      body:
        type: json
        data: '{}'
    docs: "Updates certain details of a provisioned Wholesale customer for Cisco Webex services.\n\nThe Wholesale customer\
      \ provisioning is asynchronous and thus a background task is created when this endpoint is invoked.\n\n**packages Note:**\n\
      \n* `cisco_calling_plan` is dependent on: `common_area_calling`, `webex_calling`, `webex_suite`, `webex_voice`, `cx_essentials`,\
      \ `webex_calling_standard`\n\n* `attendant_console` is dependent on: `webex_calling`, `webex_suite`, `cx_essentials`\n\
      \n<div>\n        <Callout type='i"
  - info:
      name: Remove a Wholesale Customer
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/wholesale/customers/:customerId'
      params:
      - name: customerId
        value: Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4
        type: path
        description: A unique identifier for the customer in question.
      - name: onBehalfOfSubPartnerOrgId
        value: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=
        type: query
        description: The encoded organization ID for the sub partner.
    docs: Removes the mapping between a Wholesale Customer and a Cisco Webex organization..
  - info:
      name: Precheck a Wholesale Customer Provisioning
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/wholesale/customers/validate'
      params:
      - name: onBehalfOfSubPartnerOrgId
        value: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=
        type: query
        description: The encoded organization ID for the sub partner.
      body:
        type: json
        data: '{}'
    docs: 'Allows the Partner sales team to verify likely success of provisioning a Wholesale customer.


      **packages Note:**


      * `cisco_calling_plan` is dependent on: `common_area_calling`, `webex_calling`, `webex_suite`, `webex_voice`, `cx_essentials`,
      `webex_calling_standard`


      * `attendant_console` is dependent on: `webex_calling`, `webex_suite`, `cx_essentials`


      <div>

      <Callout type=''info''>

      The Prerequisite for using this API is to have `wxc-wholesale` entitlement or `webex-wholesale-partner-testing` setti'
  - info:
      name: List Wholesale Sub-partners
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/wholesale/subPartners'
      params:
      - name: provisioningState
        value: active
        type: query
        description: Status to filter sub-partners based on provisioning state.
      - name: offset
        value: '10'
        type: query
        description: Offset value for implementing pagination.
      - name: max
        value: '10'
        type: query
        description: The maximum number of sub-partners returned in the response.
    docs: Lists all of the associated sub-partners. There are a number of filter and pagination options that can be combined
      in a single request.
  - info:
      name: List Wholesale Subscribers
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/wholesale/subscribers'
      params:
      - name: max
        value: '10'
        type: query
        description: Limit the maximum number of subscribers returned in the search response, up to 100 per page. Refer to
          the [Pagination](/docs/basics#pagination) section of [Webex REST API Basics](/docs/api/basics).
      - name: offset
        value: '4'
        type: query
        description: Offset value to implement [pagination](/docs/basics#pagination).
      - name: customerId
        value: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
        type: query
        description: Wholesale customer ID.
      - name: personId
        value: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
        type: query
        description: The person ID of the subscriber used in the [/v1/people API](/docs/api/v1/people).
      - name: externalCustomerId
        value: c1677a16-557a-4fb4-b48f-24adde57ec99
        type: query
        description: Customer external ID.
      - name: email
        value: john.anderson@acme.com
        type: query
        description: The email address of the subscriber.
      - name: status
        value: provisioned
        type: query
        description: The provisioning status of the subscriber.
      - name: after
        value: '1579046400245'
        type: query
        description: Only include subscribers created after this date and time. Epoch time (in milliseconds) preferred, but
          ISO 8601 date format also accepted.
      - name: lastStatusChange
        value: '1579046400245'
        type: query
        description: Only include subscribers with a provisioning status change after this date and time. Epoch time (in milliseconds)
          preferred, but ISO 8601 date format also accepted.
      - name: sortBy
        value: userCreationTimestamp
        type: query
        description: Supported `sortBy` attributes are `created` and `lastStatusChange`. Default is `created`.
      - name: sortOrder
        value: ASC
        type: query
        description: Sort by `ASC` (ascending) or `DESC` (descending).
      - name: onBehalfOfSubPartnerOrgId
        value: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=
        type: query
        description: The encoded organization ID for the sub partner.
    docs: Allows a Service Provider to search for their associated subscribers. There are a number of filter options, which
      can be combined in a single request.
  - info:
      name: Provision a Wholesale Subscriber
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/wholesale/subscribers'
      params:
      - name: onBehalfOfSubPartnerOrgId
        value: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=
        type: query
        description: The encoded organization ID for the sub partner.
      body:
        type: json
        data: '{}'
    docs: 'Provision a new Wholesale subscriber for Cisco Webex services.


      This API allows a Service Provider to map the Wholesale subscriber to a Cisco Webex Wholesale customer and assign the
      required licenses and entitlements for Webex, Calling and Meetings.


      **Note:**


      * If this subscriber is an existing Webex Calling entitled user, the `locationId`, `primaryPhoneNumber` and `extension`
      are optional and if provided are ignored.


      **packages Note:**


      * `attendant_console` is dependent on: `webex_calling`,'
  - info:
      name: Get a Wholesale Subscriber
      type: http
    http:
      method: GET
      url: '{{baseUrl}}/wholesale/subscribers/:subscriberId'
      params:
      - name: subscriberId
        value: Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk
        type: path
        description: A unique identifier for the subscriber in question.
      - name: onBehalfOfSubPartnerOrgId
        value: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=
        type: query
        description: The encoded organization ID for the sub partner.
    docs: Retrieves details of a provisioned Wholesale subscriber on Cisco Webex.
  - info:
      name: Update a Wholesale Subscriber
      type: http
    http:
      method: PUT
      url: '{{baseUrl}}/wholesale/subscribers/:subscriberId'
      params:
      - name: subscriberId
        value: Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk
        type: path
        description: A unique identifier for the subscriber in question.
      - name: onBehalfOfSubPartnerOrgId
        value: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=
        type: query
        description: The encoded organization ID for the sub partner.
      body:
        type: json
        data: '{}'
    docs: 'Updates certain details of a provisioned Wholesale subscriber.


      **Note:**


      * The `provisioningParameters` attributes should only be supplied when changing from the webex_meetings package to any
      calling-enabled package.


      * Even in that scenario, if this subscriber is an existing Webex Calling entitled user, these attributes are optional
      and if provided are ignored.


      **packages Note:**


      * `attendant_console` is dependent on: `webex_calling`, `webex_suite`, `cx_essentials`


      <div>

      <Callout type=''inf'
  - info:
      name: Remove a Wholesale Subscriber
      type: http
    http:
      method: DELETE
      url: '{{baseUrl}}/wholesale/subscribers/:subscriberId'
      params:
      - name: subscriberId
        value: Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk
        type: path
        description: A unique identifier for the subscriber in question.
      - name: onBehalfOfSubPartnerOrgId
        value: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=
        type: query
        description: The encoded organization ID for the sub partner.
    docs: Removes the mapping between Wholesale Subscriber and a Webex user.
  - info:
      name: Precheck a Wholesale Subscriber Provisioning
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/wholesale/subscribers/validate'
      params:
      - name: onBehalfOfSubPartnerOrgId
        value: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=
        type: query
        description: The encoded organization ID for the sub partner.
      body:
        type: json
        data: '{}'
    docs: 'Allows the Partner sales team to verify likely success of provisioning a wholesale subscriber.

      **packages Note:**


      * `attendant_console` is dependent on: `webex_calling`, `webex_suite`, `cx_essentials`


      <div>

      <Callout type=''info''>

      The Prerequisite for using this API is to have `wxc-wholesale` entitlement or `webex-wholesale-partner-testing` setting
      enabled for the Partner Organization. The Provisioning Precheck APIs supports three variants of Wholesale Subscriber
      Provisioning Precheck Requests. '
  - info:
      name: Send Consent User Move Email to Pending Wholesale Subscribers
      type: http
    http:
      method: POST
      url: '{{baseUrl}}/subscribers/:subscriberId/emails/consentMove'
      params:
      - name: subscriberId
        value: Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk
        type: path
        description: A unique identifier for the subscriber in question.
      - name: onBehalfOfSubPartnerOrgId
        value: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=
        type: query
        description: The encoded organization ID for the sub partner.
    docs: Allows a Service Provider to send the user consent move email to a subscriber who is currently in `pending_user_migration`
      state.
bundled: true