Meetings - List Meeting Tracking Codes

List Meeting Tracking Codes

Lists tracking codes on a site by a meeting host. The result indicates which tracking codes and what options can be used to create or update a meeting on the specified site.

The options here differ from those in the site-level tracking codes and the user-level tracking codes. It is the result of a selective combination of the two.
For a tracking code, if there is no user-level tracking code, the API returns the site-level options, and the defaultValue of the site-level default option is true. If there is a user-level tracking code, it is merged into the options. Meanwhile, the defaultValue of this user-level option is true and the site-level default option becomes non default.
If siteUrl is specified, tracking codes of the specified site will be listed; otherwise, tracking codes of the user's preferred site will be listed. All available Webex sites and the preferred sites of a user can be retrieved by Get Site List API.

GET/v1/meetings/trackingCodes

Query Parameters

siteUrl

string

URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by Get Site List API.

service

stringrequired

Service for schedule or sign-up pages.

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.

Response Properties

string

Unique identifier for the tracking code.

name

string

Name for the tracking code.

siteUrl

string

Site URL for the tracking code.

options

array[OptionsForTrackingCodeObject]

Tracking code option list. The options here differ from those in the site-level tracking codes and the user-level tracking codes. It is the result of a selective combination of the two. If there's user-level value for a tracking code, the user-level value becomes the default option for the tracking code, and the site-level default value becomes non-default.

value

string

The value of a tracking code option. value cannot be empty and the maximum size is 120 characters.

defaultValue

boolean

Whether or not the option is the default option of a tracking code.

inputMode

enum

The input mode in which the tracking code value can be assigned.

text

string

Text input.

select

string

Drop down list which requires options.

editableSelect

string

Both text input and select from list.

hostProfileSelect

string

An input method which is only available for the host profile and sign-up pages.

service

enum

Service for schedule or sign up pages

All

string

Tracking codes apply to all services.

MeetingCenter

string

Users can set tracking codes when scheduling a meeting.

EventCenter

string

Users can set tracking codes when scheduling an event.

TrainingCenter

string

Users can set tracking codes when scheduling a training session.

SupportCenter

string

Users can set tracking codes when scheduling a support meeting.

type

enum

Type for meeting scheduler or meeting start pages.

optional

string

Available to be chosen but not compulsory.

required

string

Officially compulsory.

adminSet

string

The value is set by admin.

notUsed

string

The value cannot be used.

notApplicable

string

This value only applies to the service of All. When the type of All for a tracking code is notApplicable, there are different types for different services. For example, required for MeetingCenter, optional for EventCenter and notUsed for others.

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.

GET

/v1/meetings/trackingCodes{?siteUrl,service,hostEmail}

Header

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

Query Parameters

siteUrl
string
URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API.
service
stringRequired
Service for schedule or sign-up pages.
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.

https://webexapis.com/v1/meetings/trackingCodes?siteUrl=example.webex.com&service=MeetingCenter&hostEmail=john.andersen@example.com

200 / OK

{
    "items": [
        {
            "id": "1",
            "name": "Department",
            "siteUrl": "example.webex.com",
            "inputMode": "text",
            "options": [
                {
                    "value": "Engineering",
                    "defaultValue": false
                },
                {
                    "value": "Design",
                    "defaultValue": true
                },
                {
                    "value": "Sales",
                    "defaultValue": false
                }
            ],
            "service": "MeetingCenter",
            "type": "optional"
        }
    ]
}