openapi: 3.0.0
info:
title: Webex Admin Address Book Events 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: Events
paths:
/events:
get:
responses:
'200':
description: OK
headers:
Link:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/EventCollectionResponse'
example:
items:
- id: Y2lzY29zcGFyazovL3VzL0VWRU5UL2JiY2ViMWFkLTQzZjEtM2I1OC05MTQ3LWYxNGJiMGM0ZDE1NAo
resource: messages
type: created
appId: 'null'
actorId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
orgId: OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh
created: '2016-05-16T21:34:59.324Z'
data:
id: Y2lzY29zcGFyazovL3VzL01FU1NBR0UvOTJkYjNiZTAtNDNiZC0xMWU2LThhZTktZGQ1YjNkZmM1NjVk
roomId: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
roomType: group
orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jZTg2MWZiYS02ZTJmLTQ5ZjktOWE4NC1iMzU0MDA4ZmFjOWU
text: 'PROJECT UPDATE - A new project plan has been published on Box: http://box.com/s/lf5vj. The PM for this project is Mike C. and the Engineering Manager is Jane W.'
personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
personEmail: matt@example.com
meetingId: 16ce696f75844d24b2d4fab04b4419af_I_183979003076423608
creatorId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82YWE2ZGE5OS0xYzdlLTQ4MWItODY3YS03MWY2NTIwNDk0MzM
transcriptionEnabled: 'yes'
recordingEnabled: 'yes'
hasPostMeetingsChat: 'yes'
corelationId: fdda8613-d34b-424c-8c6a-44ff2e19379c
callType: SIP_ENTERPRISE
userId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZjEwMTU1NC04ZGJjLTQyMmUtOGEzZC1kYTk1YTI3NWZlNzU
userType: User
callDirection: ORIGINTATING
isCallAnswered: 'true'
callDurationSeconds: '192'
callStartTime: '2023-02-08T06:12:43.976Z'
callAnswerTime: '2023-02-08T06:12:47.012Z'
callTransferTime: '2023-02-08T06:15:19.112Z'
callingNumber: '910481234'
callingLineId: '211'
calledNumber: '4089671221'
calledLineId: '219'
dialedDigits: '123'
callRedirectingNumber: ''
callRedirectedReason: ''
created: '2016-05-16T21:34:59.324Z'
type: direct
breakoutSessionId: d66a4a90-4f50-11ef-bc94-f5c71646dc71
recipients:
- personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9lOGYwOTIwOC00ZjUxLTExZWYtOTQ4My1iYTA3NjE2MzY4NmQ
personEmail: johndoe@simplistic.com
guestDisplayName: John Wayne
guestEmail: jwayne@mailinator.com
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
'405':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
'410':
description: 'Gone: The requested resource is no longer available.'
'415':
description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
'423':
description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
'428':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
'500':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
summary: List Events
operationId: List Events
description: 'List events in your organization. Several query parameters are available to filter the events returned in the response.
Long result sets will be split into [pages](/docs/basics#pagination).'
tags:
- Events
parameters:
- name: resource
in: query
description: List events with a specific resource type.
example: messages
schema:
type: string
enum:
- attachmentActions
- businessTexts
- call_records
- convergedRecordings
- file_transcodings
- files
- meetingMessages
- meetings
- meetingTranscripts
- memberships
- messages
- rooms
- tabs
- name: type
in: query
description: List events with a specific event type.
example: created
schema:
type: string
enum:
- created
- updated
- deleted
- ended
- name: actorId
in: query
description: List events performed by this person, by person ID.
example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80MDNlZmUwNy02Yzc3LTQyY2UtOWI4NC1lZjhjYzY1ZDA4NDI
schema:
type: string
- name: from
in: query
description: List events which occurred after a specific date and time.
example: '2018-01-01T00:00:00.000Z'
schema:
type: string
- name: to
in: query
description: List events that occurred before a specific date and time. If not specified, events up to the present time will be listed. Cannot be set to a future date relative to the current time.
example: '2018-01-02T00:00:00.000Z'
schema:
type: string
- name: max
in: query
description: Limit the maximum number of events in the response. Value must be between 1 and 1000, inclusive.
example: '100'
schema:
type: number
default: 100
- name: serviceType
in: query
description: List events for a specific service type. This parameter is only applicable and mandatory when resource is set to `convergedRecordings`.
example: calling
schema:
type: string
enum:
- calling
/events/{eventId}:
get:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Event'
example:
id: Y2lzY29zcGFyazovL3VzL0VWRU5UL2JiY2ViMWFkLTQzZjEtM2I1OC05MTQ3LWYxNGJiMGM0ZDE1NAo
resource: messages
type: created
appId: 'null'
actorId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
orgId: OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh
created: '2016-05-16T21:34:59.324Z'
data:
id: Y2lzY29zcGFyazovL3VzL01FU1NBR0UvOTJkYjNiZTAtNDNiZC0xMWU2LThhZTktZGQ1YjNkZmM1NjVk
roomId: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
roomType: group
orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jZTg2MWZiYS02ZTJmLTQ5ZjktOWE4NC1iMzU0MDA4ZmFjOWU
text: 'PROJECT UPDATE - A new project plan has been published on Box: http://box.com/s/lf5vj. The PM for this project is Mike C. and the Engineering Manager is Jane W.'
personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
personEmail: matt@example.com
meetingId: 16ce696f75844d24b2d4fab04b4419af_I_183979003076423608
creatorId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82YWE2ZGE5OS0xYzdlLTQ4MWItODY3YS03MWY2NTIwNDk0MzM
transcriptionEnabled: 'yes'
recordingEnabled: 'yes'
hasPostMeetingsChat: 'yes'
corelationId: fdda8613-d34b-424c-8c6a-44ff2e19379c
callType: SIP_ENTERPRISE
userId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZjEwMTU1NC04ZGJjLTQyMmUtOGEzZC1kYTk1YTI3NWZlNzU
userType: User
callDirection: ORIGINTATING
isCallAnswered: 'true'
callDurationSeconds: '192'
callStartTime: '2023-02-08T06:12:43.976Z'
callAnswerTime: '2023-02-08T06:12:47.012Z'
callTransferTime: '2023-02-08T06:15:19.112Z'
callingNumber: '910481234'
callingLineId: '211'
calledNumber: '4089671221'
calledLineId: '219'
dialedDigits: '123'
callRedirectingNumber: ''
callRedirectedReason: ''
created: '2016-05-16T21:34:59.324Z'
type: direct
breakoutSessionId: d66a4a90-4f50-11ef-bc94-f5c71646dc71
recipients:
- personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9lOGYwOTIwOC00ZjUxLTExZWYtOTQ4My1iYTA3NjE2MzY4NmQ
personEmail: johndoe@simplistic.com
guestDisplayName: John Wayne
guestEmail: jwayne@mailinator.com
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
'405':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
'410':
description: 'Gone: The requested resource is no longer available.'
'415':
description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
'423':
description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
'428':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
'500':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
summary: Get Event Details
operationId: Get Event Details
description: 'Shows details for an event, by event ID.
Specify the event ID in the `eventId` parameter in the URI.'
tags:
- Events
parameters:
- name: eventId
in: path
description: The unique identifier for the event.
required: true
example: Y2lzY29zcGFyazovL3VzL0VWRU5UL2JiY2ViMWFkLTQzZjEtM2I1OC05MTQ3LWYxNGJiMGM0ZDE1NAo
schema:
type: string
components:
schemas:
EventResourceEnum:
type: string
enum:
- attachmentActions
- businessTexts
- call_records
- convergedRecordings
- file_transcodings
- files
- meetingMessages
- meetings
- meetingTranscripts
- memberships
- messages
- rooms
- tabs
description: " * `attachmentActions` - State changed on a card attachment\n * `businessTexts` - A user sent or received a SMS message\n * `call_records` - A Webex call was made to/from a user\n * `convergedRecordings` - A Webex call was recorded for a user\n * `file_transcodings` - State change on a file preview\n * `files` - State changed on a file download\n * `meetingMessages` - State changed on a meeting message, i.e. message exchanged as part of a meeting\n * `meetings` - State change on a meeting ( here combined with type = 'ended' )\n * `meetingTranscripts` - State change on a automatic transcript resource for Webex Assistant\n * `memberships` - State changed on a memberships resource\n * `messages` - State changed on a messages resource\n * `rooms` - State changed on a space classification\n * `tabs` - State changed on a room tabs in a space\n"
Event:
type: object
required:
- id
- resource
- type
- actorId
- orgId
- created
- data
properties:
id:
type: string
example: Y2lzY29zcGFyazovL3VzL0VWRU5UL2JiY2ViMWFkLTQzZjEtM2I1OC05MTQ3LWYxNGJiMGM0ZDE1NAo
description: The unique identifier for the event.
resource:
$ref: '#/components/schemas/EventResourceEnum'
description: The type of resource in the event.
type:
$ref: '#/components/schemas/EventTypeEnum'
description: The action which took place in the event.
appId:
type: string
example: 'null'
description: The ID of the application for the event.
actorId:
type: string
example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
description: The ID of the person who performed the action.
orgId:
type: string
example: OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh
description: The ID of the organization for the event.
created:
type: string
example: '2016-05-16T21:34:59.324Z'
description: The date and time of the event.
data:
type: object
properties:
id:
type: string
example: Y2lzY29zcGFyazovL3VzL01FU1NBR0UvOTJkYjNiZTAtNDNiZC0xMWU2LThhZTktZGQ1YjNkZmM1NjVk
roomId:
type: string
example: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
roomType:
type: string
example: group
orgId:
type: string
example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jZTg2MWZiYS02ZTJmLTQ5ZjktOWE4NC1iMzU0MDA4ZmFjOWU
text:
type: string
example: 'PROJECT UPDATE - A new project plan has been published on Box: http://box.com/s/lf5vj. The PM for this project is Mike C. and the Engineering Manager is Jane W.'
personId:
type: string
example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
personEmail:
type: string
example: matt@example.com
meetingId:
type: string
example: 16ce696f75844d24b2d4fab04b4419af_I_183979003076423608
creatorId:
type: string
example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82YWE2ZGE5OS0xYzdlLTQ4MWItODY3YS03MWY2NTIwNDk0MzM
host:
type: object
properties: {}
description: The meeting's host data.
attendees:
type: array
items: {}
description: Common Identity (CI) authenticated meeting attendees.
transcriptionEnabled:
type: string
example: 'yes'
description: Indicates whether or not the Voice Assistant was enabled during the meeting. If `true` a transcript should be available a couple minutes after the meeting ended at the [meetingTranscripts resource](/docs/api/v1/meeting-transcripts).
recordingEnabled:
type: string
example: 'yes'
description: Indicates if recording was enabled for all or parts of the meeting. If `true` a recording should be available shortly after the meeting ended at the [recordings resource](/docs/api/v1/recordings).
hasPostMeetingsChat:
type: string
example: 'yes'
description: Indicates if chat messages were exchanged during the meeting in the meetings client (not the unified client). If `true` these messages can be accessed by a compliance officer at the [postMeetingsChat](/docs/api/v1/meetings-chat) resource. Meetings chat collection must be custom enabled.
corelationId:
type: string
example: fdda8613-d34b-424c-8c6a-44ff2e19379c
description: Telephony; The corelation id.
callType:
type: string
example: SIP_ENTERPRISE
description: Telephony; call types (examples `VIDEO_DIALIN`,`VIDEO_DIALOUT`,`CASCADE`,`HYBRID_CASCADE`,`PSTN_SIP`,`PSTN_DIALIN`,`PSTN_DIALOUT`,`PSTN_ONLY_DIALIN`,`PSTN_ONLY_DIALOUT`,`H323`,`H323_IP`,`SIP_ENTERPRISE`,`SIP_MOBILE`,`SIP_NATIONAL`,`SIP_INTERNATIONAL`,`SIP_EMERGENCY`,`SIP_OPERATOR`,`SIP_SHORTCODE`,`SIP_TOLLFREE`,`SIP_PREMIUM`,`SIP_URI`,`SIP_INBOUND`,`UNKNOWN`,`ZTM`,`SIP_MEETING`).
userId:
type: string
example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZjEwMTU1NC04ZGJjLTQyMmUtOGEzZC1kYTk1YTI3NWZlNzU
description: Telephony; user id of the CDR owner.
userType:
type: string
example: User
description: Telephony; The type of user (`User`,`Anchor`,`AutomatedAttendantBasic`,`AutomatedAttendantStandard`,`AutomatedAttendantVideo`,`BroadworksAnywhere`,`CallCenterBasic`,`CallCenterPremium`,`CallCenterStandard`,`CollaborateBridge`,`ContactCenterAdaptor`,`FindMeFollowMe`,`FlexibleSeatingHost`,`GroupCall`,`GroupPaging`,`HuntGroup`,`LocalGateway`,`MeetMeConference`,`Place`,`RoutePoint`,`SystemVoicePortal`,`VoiceMailGroup`,`VoiceMailRetrieval`,`VoiceXML`,`VirtualLine`,`Unknown`).
callDirection:
type: string
example: ORIGINTATING
description: Telephony; `ORIGINATING` or `TERMINATING`.
isCallAnswered:
type: string
example: 'true'
description: Telephony; indicates if the call was answered.
callDurationSeconds:
type: string
example: '192'
description: Telephony; duration of call in seconds.
callStartTime:
type: string
example: '2023-02-08T06:12:43.976Z'
description: Telephony; ISO 8601.
callAnswerTime:
type: string
example: '2023-02-08T06:12:47.012Z'
description: Telephony; ISO 8601.
callTransferTime:
type: string
example: '2023-02-08T06:15:19.112Z'
description: Telephony; ISO 8601.
callingNumber:
type: string
example: '910481234'
description: Telephony; originating number.
callingLineId:
type: string
example: '211'
description: Telephony.
calledNumber:
type: string
example: '4089671221'
description: Telephony; destination number.
calledLineId:
type: string
example: '219'
description: Telephony
dialedDigits:
type: string
example: '123'
description: Telephony
callRedirectingNumber:
type: string
description: Telephony
callRedirectedReason:
type: string
description: Telephony
created:
type: string
example: '2016-05-16T21:34:59.324Z'
type:
type: string
example: direct
description: Message type `direct` or `group` message.
breakoutSessionId:
type: string
example: d66a4a90-4f50-11ef-bc94-f5c71646dc71
description: The breakout session Id in cases where the action happened in a meeting's brakout session, for example a `meetingMessage`.
recipients:
type: array
items:
$ref: '#/components/schemas/Recipient'
description: The recipients list for directed meetingMessages.
description: The event's data representation. This object will contain the event's `resource`, such as [memberships](/docs/api/v1/memberships/get-membership-details), [messages](/docs/api/v1/messages/get-message-details), [meetings](/docs/api/v1/meetings), [meetingMessages](/docs/api/v1/meetingMessages), [tabs](/docs/api/v1/room-tabs), [rooms](/docs/api/v1/space-classifications) or [attachmentActions](/docs/api/v1/attachment-actions) at the time the event took place.
EventTypeEnum:
type: string
enum:
- created
- updated
- deleted
- ended
description: " * `created` - The resource has been created\n * `updated` - A property on the resource has been updated\n * `deleted` - The resource has been deleted\n * `ended` - The meeting has ended\n"
EventCollectionResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Event'
Recipient:
type: object
properties:
personId:
type: string
example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9lOGYwOTIwOC00ZjUxLTExZWYtOTQ4My1iYTA3NjE2MzY4NmQ
description: The personId of the recipient
personEmail:
type: string
example: johndoe@simplistic.com
description: The personEmail
guestDisplayName:
type: string
example: John Wayne
description: Guests, who are unauthenticated users, have a guestDisplayName
guestEmail:
type: string
example: jwayne@mailinator.com
description: Guests, who are unauthenticated users, have a guestEmail
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