{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Participants API", "version": "1.0.0" }, "items": [ { "info": { "name": "Participants", "type": "folder" }, "items": [ { "info": { "name": "List Meeting Participants", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meetingParticipants", "headers": [ { "name": "timezone", "value": "UTC" } ], "params": [ { "name": "max", "value": "100", "type": "query", "description": "Limit the maximum number of participants in the response, up to 100." }, { "name": "meetingId", "value": "560d7b784f5143e3be2fc3064a5c4999", "type": "query", "description": "The unique identifier for the meeting. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API." }, { "name": "breakoutSessionId", "value": "c84ba778-2f46-4dc6-9459-398694732d70", "type": "query", "description": "The unique identifier for a breakout session which happened during an ended meeting instance. If the `breakoutSessionId` is specified, the operation returns participants who joined the breakout session. Only applies to ended meeting instances." }, { "name": "meetingStartTimeFrom", "value": "2022-10-02T17:31:00Z", "type": "query", "description": "Meetings start from the specified date and time(exclusive) in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. If `meetingStartTimeFrom` is not specified, it equals `meetingStartTimeTo` minus 1 month; if `meetingStartTimeTo` is also not specified, the default value for `meetingStartTimeFrom` is 1 month before current date and time." }, { "name": "meetingStartTimeTo", "value": "2022-10-30T09:30:00Z", "type": "query", "description": "Meetings start before the specified date and time(exclusive) in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. If `meetingStartTimeTo` is not specified, it equals the result of a comparison, `meetingStartTimeFrom` plus one month and the current time, and the result is the earlier of the two; if `meetingStartTimeFrom` is also not specified, the default value for `meetingStartTimeTo` is current date and time minus 1 month." }, { "name": "hostEmail", "value": "john.andersen@example.com", "type": "query", "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin-level scopes, the admin may specify the email of a user in a site they manage and the API will return meeting participants of the meetings that are hosted by that user." }, { "name": "joinTimeFrom", "value": "2022-10-22T09:30:00", "type": "query", "description": "The time participants join a meeting starts from the specified date and time (inclusive) in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. If `joinTimeFrom` is not specified, it equals `joinTimeTo` minus 7 days." }, { "name": "joinTimeTo", "value": "2022-10-25T09:30:00", "type": "query", "description": "The time participants join a meeting before the specified date and time (exclusive) in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. If `joinTimeTo` is not specified, it equals `joinTimeFrom` plus 7 days. The interval between `joinTimeFrom` and `joinTimeTo` must be within 90 days." } ] }, "docs": "List all participants in an in-progress meeting or an ended meeting. The `meetingId` parameter is required, which is the unique identifier for the meeting.\n\nThe authenticated user calling this API must either have an Administrator role with the `meeting:admin_participants_read` scope, or be the meeting host.\n\n* If the `meetingId` value specified is for a meeting series, the operation returns participants' details for the last instance in the meeting series. If the `meetingStartTimeFrom` value an" }, { "info": { "name": "Query Meeting Participants with Email", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/meetingParticipants/query", "headers": [ { "name": "timezone", "value": "UTC" } ], "params": [ { "name": "meetingId", "value": "560d7b784f5143e3be2fc3064a5c4999", "type": "query", "description": "The unique identifier for the meeting." }, { "name": "meetingStartTimeFrom", "value": "2022-10-02T17:31:00Z", "type": "query", "description": "Meetings start from the specified date and time(exclusive) in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. If `meetingStartTimeFrom` is not specified, it equals `meetingStartTimeTo` minus 1 month; if `meetingStartTimeTo` is also not specified, the default value for `meetingStartTimeFrom` is 1 month before current date and time." }, { "name": "meetingStartTimeTo", "value": "2022-10-25T09:30:00Z", "type": "query", "description": "Meetings start before the specified date and time(exclusive) in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. If `meetingStartTimeTo` is not specified, it equals the result of a comparison, `meetingStartTimeFrom` plus one month and the current time, and the result is the earlier of the two; if `meetingStartTimeFrom` is also not specified, the default value for `meetingStartTimeTo` is current date and time minus 1 month." }, { "name": "hostEmail", "value": "john.andersen@example.com", "type": "query", "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin-level scopes, the admin may specify the email of a user in a site they manage and the API will return meeting participants of the meetings that are hosted by that user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Query participants in a live meeting, or after the meeting, using participant's email. The `meetingId` parameter is the unique identifier for the meeting and is required.\n\nThe authenticated user calling this API must either have an Administrator role with the `meeting:admin_participants_read` scope, or be the meeting host.\n\n* If the `meetingId` value specified is for a meeting series, the operation returns participants' details for the last instance in the meeting series. If the `meetingStartTim" }, { "info": { "name": "Get Meeting Participant Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/meetingParticipants/:participantId", "params": [ { "name": "participantId", "value": "560d7b784f5143e3be2fc3064a5c4999_3c2e2338-e950-43bf-b588-573773ee43d1", "type": "path", "description": "The unique identifier for the meeting and the participant." }, { "name": "hostEmail", "value": "john.andersen@example.com", "type": "query", "description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin-level scopes, the admin may specify the email of a user in a site they manage and the API will return meeting participants of the meetings that are hosted by that user." } ] }, "docs": "Get a meeting participant details of a live or post meeting. The `participantId` is required to identify the meeting and the participant.\n\nThe authenticated user calling this API must either have an Administrator role with the `meeting:admin_participants_read` scope, or be the meeting host." }, { "info": { "name": "Update a Participant", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/meetingParticipants/:participantId", "params": [ { "name": "participantId", "value": "560d7b784f5143e3be2fc3064a5c4999_3c2e2338-e950-43bf-b588-573773ee43d1", "type": "path", "description": "The unique identifier for the meeting and the participant." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Mute, un-mute, expel, or admit a participant in a live meeting. The `participantId` is required to identify the meeting and the participant.\n\nNotes:\n\n* The owner of the OAuth token calling this API needs to be the meeting host or co-host.\n\n* The `expel` attribute always takes precedence over `admit` and `muted`. The request can have all `expel`, `admit` and `muted` or any of them.\n\n
There is an inconsistent behavior in Webex Meetings App when all active meeting partic" }, { "info": { "name": "Admit Participants", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/meetingParticipants/admit", "body": { "type": "json", "data": "{}" } }, "docs": "Admit multiple participants to a meeting in progress.\n\nThis API limits the maximum size of `items` in the request body to 100.\n\nEach `participantId` of `items` in the request body should have the same prefix of `meetingId`." }, { "info": { "name": "Call Out a SIP Participant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/meetingParticipants/callout", "body": { "type": "json", "data": "{}" } }, "docs": "Initiate a call to a SIP participant to join a meeting.\n\nIf a user invoking the API is not a [Service App](/docs/service-apps), the user must join the meeting before invoking the API. If a user is a [Service App](/docs/service-apps), the service app can invoke the API without joining the meeting. In both cases, the normal user or the service app that invokes the API must be the meeting host or cohost. If the meeting is created by the service app on behalf of the real host, the service app cannot" }, { "info": { "name": "Cancel Calling Out a SIP Participant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/meetingParticipants/cancelCallout", "body": { "type": "json", "data": "{}" } }, "docs": "Cancel the call to a SIP participant before the ringing on the invited SIP device stops. The ringing on the invited SIP device stops in 30 seconds if there is no response.\n\nIf a user invoking the API is not a [Service App](/docs/service-apps), the user must join the meeting before invoking the API. If a user is a [Service App](/docs/service-apps), the service app can invoke the API without joining the meeting. In both cases, the normal user or the service app that invokes the API must be the mee" } ] } ], "bundled": true }