Meetings - Join a Meeting | Webex for Developers

Join a Meeting

Retrieves links for a meeting with a specified meetingId, meetingNumber, or webLink that allow users to start or join the meeting directly without logging in and entering a password.

Please note that meetingId, meetingNumber and webLink are mutually exclusive and they cannot be specified simultaneously.
If joinDirectly is true or not specified, the response will have HTTP response code 302 and the request will be redirected to joinLink; otherwise, the response will have HTTP response code 200 and joinLink will be returned in response body.
Only the meeting host or cohost can generate the startLink.
An admin user or a Service App can generate the startLink and joinLink on behalf of another meeting host using the hostEmail parameter. When a Service App generates the startLink and joinLink, the hostEmail parameter is required. The hostEmail parameter only applies to meetings, not webinars.
For Service Apps, hostEmail must be provided in the request.
Generating a join link or a start link before the time specified by joinBeforeHostMinutes for a webinar is not supported.
The joinLink and startLink generated by the API only work in a web browser, not in mobile apps. When the joinLink or startLink is used in a mobile app, the user can't join or start the meeting directly by the dial-in or dial-out phone numbers displayed in the app.
When createJoinLinkAsWebLink or createStartLinkAsWebLink is set to true, a user cannot join or start the meeting using the joinLink or startLink returned in the response, and must complete the login flow. Those options are typically useful if mandatory user login is configured in Control Hub.
Embedded Apps are not supported in a meeting which is started from the startLink generated by this API.

When the email or displayName is omitted from the API request, the backend inserts the data from the user making the request. That may lead to situations where an attendee is shown in the roster with the hostname which should be avoided. In the future, we will make those two fields required.

POST/v1/meetings/join

Body Parameters

meetingId

string

Unique identifier for the meeting. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled personal room meeting is also supported for this API.

meetingNumber

string

Meeting number. Applies to meeting series, scheduled meeting, and meeting instances, but not to meeting instances which have ended.

webLink

string

Link to a meeting information page where the meeting client is launched if the meeting is ready to start or join.

joinDirectly

boolean

Whether or not to redirect to joinLink. It is an optional field and default value is true.

string

Email address of meeting participant. If email is specified, the link is generated for the user of email; otherwise, the API returns the link for the user calling the API. email is required for a guest issuer.

displayName

string

Display name of meeting participant. If displayName is specified, email must be specified as well. If email is specified and displayName is not, display name is the same as email. If neither displayName nor email is specified, the API returns the link for the user calling the API. The maximum length of displayName is 128 characters. displayName is required for a guest issuer.

password

string

Required when the meeting is protected by a password and the current user is not privileged to view it if they are not a host, cohost, or invitee.

expirationMinutes

number

Expiration duration of joinLink in minutes. Must be between 1 and 60.

registrationId

string

Required when the meeting is webinar-enabled and enabled registration ID.

hostEmail

string

Email address for the meeting host. This attribute should be set if the user or application calling the API has the admin on-behalf-of scopes. This parameter is required for a Service App. It only applies to meetings, not webinars.

createJoinLinkAsWebLink

boolean

When createJoinLinkAsWebLink is true, the returned joinLink is the webLink of the meeting, otherwise, the normal joinLink is returned. This parameter is applicable when the option to force the user to log in is set in Control Hub. When true, a user cannot join the meeting by the link directly and must go through the login flow.

createStartLinkAsWebLink

boolean

When createStartLinkAsWebLink is true, the returned startLink is the webLink of the meeting, otherwise, the normal startLink is returned. This parameter is applicable when the option to force the user to log in is set in Control Hub. When true, a user cannot start the meeting using the link and must go through the login flow.

Response Properties

startLink

string

The link is used to start a meeting as the meeting host. Only the meeting host or cohost can generate the startLink.

joinLink

string

The link is used to join the meeting.

expiration

string

Expiration time of joinLink. When both createJoinLinkAsWebLink and createStartLinkAsWebLink are true, this attribute is not returned in the response.

Response Codes

The list below describes the common success and error responses you should expect from the API:

Code	Status	Description
200	OK	Successful request with body content.
201	Created	The request has succeeded and has led to the creation of a resource.
202	Accepted	The request has been accepted for processing.
204	No Content	Successful request without body content.
400	Bad Request	The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401	Unauthorized	Authentication credentials were missing or incorrect.
403	Forbidden	The request is understood, but it has been refused or access is not allowed.
404	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	Method Not Allowed	The request was made to a resource using an HTTP request method that is not supported.
409	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	Gone	The requested resource is no longer available.
415	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	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	Precondition Required	File(s) cannot be scanned for malware and need to be force downloaded.
429	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	Internal Server Error	Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502	Bad Gateway	The server received an invalid response from an upstream server while processing the request. Try again later.
503	Service Unavailable	Server is overloaded with requests. Try again later.
504	Gateway Timeout	An upstream server failed to respond on time. If your query uses `max` parameter, please try to reduce it.

POST

/v1/meetings/join

Header

Content-Type
Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Body

meetingId
string
Unique identifier for the meeting. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. 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 also supported for this API.
meetingNumber
string
Meeting number. Applies to meeting series, scheduled meeting, and meeting instances, but not to meeting instances which have ended.
webLink
string
Link to a meeting information page where the meeting client is launched if the meeting is ready to start or join.
joinDirectly
boolean
Whether or not to redirect to `joinLink`. It is an optional field and default value is true.
email
string
Email address of meeting participant. If `email` is specified, the link is generated for the user of `email`; otherwise, the API returns the link for the user calling the API. `email` is required for a [guest issuer](https://developer.webex.com/docs/guest-issuer).
displayName
string
Display name of meeting participant. If `displayName` is specified, `email` must be specified as well. If `email` is specified and `displayName` is not, display name is the same as `email`. If neither `displayName` nor `email` is specified, the API returns the link for the user calling the API. The maximum length of `displayName` is 128 characters. `displayName` is required for a [guest issuer](https://developer.webex.com/docs/guest-issuer).
password
string
Required when the meeting is protected by a password and the current user is not privileged to view it if they are not a host, cohost, or invitee.
expirationMinutes
number
Expiration duration of `joinLink` in minutes. Must be between 1 and 60.
registrationId
string
Required when the meeting is webinar-enabled and enabled registration ID.
hostEmail
string
Email address for the meeting host. This attribute should be set if the user or application calling the API has the admin on-behalf-of scopes. This parameter is required for a [Service App](/docs/service-apps). It only applies to meetings, not webinars.
createJoinLinkAsWebLink
boolean
When `createJoinLinkAsWebLink` is true, the returned `joinLink` is the webLink of the meeting, otherwise, the normal `joinLink` is returned. This parameter is applicable when the option to force the user to log in is set in Control Hub. When true, a user cannot join the meeting by the link directly and must go through the login flow.
createStartLinkAsWebLink
boolean
When `createStartLinkAsWebLink` is true, the returned `startLink` is the webLink of the meeting, otherwise, the normal `startLink` is returned. This parameter is applicable when the option to force the user to log in is set in Control Hub. When true, a user cannot start the meeting using the link and must go through the login flow.

{
    "meetingId":"98d8c2212c9d62b162b9565932735e58_I_231409844992607809",
    "meetingNumber":"123456789",
    "webLink": "https://site4-example.webex.com/site4/j.php?MTID=md41817da6a55b0925530cb88b3577b1e",
    "joinDirectly":false,
    "email": "brenda.song@example.com",
    "displayName": "Brenda Song",
    "password": "BgJep@43",
    "expirationMinutes": 5,
    "hostEmail": "john.andersen@example.com",
    "createJoinLinkAsWebLink": false,
    "createStartLinkAsWebLink": false
}

200 / OK

{
    "startLink": "https://convergedint.dmz.webex.com/wbxmjs/joinservice/sites/convergedint/meeting/download/b711f29256e54ed780f2a1b7f96d202f?siteurl=convergedint&integrationJoinToken=QUhTSwAAAIXWmx57bQgiYLuAYZvEKAN6taYj3h2th5jIusReBmnOZBLmjPHQIhknV9%2FVOtZTRfvHek%2FbN%2BUA3CcmfqiYEisTZyWhIWboxRG3KGzVQxijZV0z%2B%2FTdXqgX3Cvo%2B3FfO3tIgh1dcP5bprqYxuwJu%2BhW13nctAZPsLuyLaCuADQ%2FsQ%3D%3D&principal=QUhTSwAAAIUNvqV715wdKSiJfpQz9G2uUjyNlBeu0bcNYoXwvYPyHeysQAgve3XrsM83KS10rU34VjuJjPyOi225Po2n3q2MTUmMgIk9hgkDXHxO476xlMoDPsQONMp8vBY9uVybKgBOyTkJsMa%2F2pFES4hk101q&integrationEndUrl=https%3A%2F%2Fconvergedint.dmz.webex.com%2Fmc3300%2Fmeetingcenter%2Fmeetingend%2Fmeetingend.do%3Fsiteurl%3Dconvergedint%26from%3Dmeeting%26backurl%3D",
    "joinLink": "https://convergedint.dmz.webex.com/wbxmjs/joinservice/sites/convergedint/meeting/download/b711f29256e54ed780f2a1b7f96d202f?siteurl=convergedint&integrationJoinToken=QUhTSwAAAIXWmx57bQgiYLuAYZvEKAN6taYj3h2th5jIusReBmnOZBLmjPHQIhknV9%2FVOtZTRfvHek%2FbN%2BUA3CcmfqiYEisTZyWhIWboxRG3KGzVQxijZV0z%2B%2FTdXqgX3Cvo%2B3FfO3tIgh1dcP5bprqYxuwJu%2BhW13nctAZPsLuyLaCuADQ%2FsQ%3D%3D&principal=QUhTSwAAAIUNvqV715wdKSiJfpQz9G2uUjyNlBeu0bcNYoXwvYPyHeysQAgve3XrsM83KS10rU34VjuJjPyOi225Po2n3q2MTUmMgIk9hgkDXHxO476xlMoDPsQONMp8vBY9uVybKgBOyTkJsMa%2F2pFES4hk101q&integrationEndUrl=https%3A%2F%2Fconvergedint.dmz.webex.com%2Fmc3300%2Fmeetingcenter%2Fmeetingend%2Fmeetingend.do%3Fsiteurl%3Dconvergedint%26from%3Dmeeting%26backurl%3D",
    "expiration": "2022-05-30T09:44:08Z"
}