Meetings - Create Invitation Sources

Create Invitation Sources

Creates one or more invitation sources for a meeting.

POST/v1/meetings/{meetingId}/invitationSources

URI Parameters

meetingId

stringrequired

Unique identifier for the meeting. Only the meeting ID of a scheduled webinar is supported for this API.

Body Parameters

hostEmail

string

Email address for the meeting host. This parameter is only used if a user or application calling the API has the admin-level scopes. The admin may specify the email of a user on a site they manage and the API will return meeting participants of the meetings that are hosted by that user.

personId

string

Unique identifier for the meeting host. Should only be set if the user or application calling the API has the admin-level scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host.

items

array[InvitationSourceCreateObject]

sourceId

stringrequired

Source ID for the invitation.

sourceEmail

stringrequired

Email for invitation source.

Response Properties

items

array[InvitationSourceObject]

Invitation source array.

string

Unique identifier for invitation source.

sourceId

string

Source ID for invitation.

sourceEmail

string

Email for invitation source.

joinLink

string

The link bound to sourceId can directly join the meeting. If the meeting requires registration,joinLink is not returned.

registerLink

string

The link bound to sourceId can directly register the meeting. If the meeting requires registration, registerLink is returned.

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//invitationSources

Header

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

Body

hostEmail
string
Email address for the meeting host. This parameter is only used if a user or application calling the API has the admin-level scopes. The admin may specify the email of a user on a site they manage and the API will return meeting participants of the meetings that are hosted by that user.
personId
string
Unique identifier for the meeting host. Should only be set if the user or application calling the API has the admin-level scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host.
items
array

https://webexapis.com/v1/meetings/560d7b784f5143e3be2fc3064a5c4999/invitationSources

{
    "hostEmail":"john.andersen@example.com",
    "personId":"Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xYTY5MmE2Mi00MTNmLTRjYWEtYjdkOS0wYzg0ZDZmMDdlNzY",
    "items":[
        {
            "sourceId":"cisco",
            "sourceEmail":"john001@example.com"
        },
        {
            "sourceId":"webex",
            "sourceEmail":"john002@example.com"
        }
    ]
}

200 / OK

{
    "items":[
        {
            "id":"1",
            "sourceId":"cisco",
            "joinLink":"https://example.webex.com/example/j.php?MTID=m6d75f1c875b3e3c5d18c7598036bdd8b",
            "registerLink":"https://example.webex.com/example/j.php?RGID=rb05b31307b5b820e16594da9d1cfc5c7",
            "sourceEmail":"john001@example.com"
        },
        {
            "id":"2",
            "sourceId":"webex",
            "joinLink":"https://example.webex.com/example/j.php?MTID=m6d75f1c875b3e3c5d18c7598036bdd8b",
            "registerLink":"https://example.webex.com/example/j.php?RGID=rb05b31307b5b820e16594da9d1cfc588",
            "sourceEmail":"john002@example.com"
        }
    ]
}