Skip to main content

RegistrationManagementService

A list of all methods in the RegistrationManagementService service. Click on the method name to view detailed information about that method.

MethodsDescription
rcw_reg_get_sessionReturns a registration Session information by ID. A caller must be an authorized user: either a host of the webinar or an IT Admin: a user from host's account with "WebinarSettings" permission.
rcw_reg_update_sessionUpdates a Session by ID. This is a PARTIAL update (PATCH), client may call it providing only attributes which are to be changed. A caller must be an authorized user: either a host of the webinar or an IT Admin: a user from host's account with "WebinarSettings" permission. If a session record with given ID doesn't exist on Registration Service side the API should return HTTP 404.

rcw_reg_get_session

Returns a registration Session information by ID. A caller must be an authorized user: either a host of the webinar or an IT Admin: a user from host's account with "WebinarSettings" permission.

  • HTTP Method: GET
  • Endpoint: /webinar/registration/v1/sessions/{sessionId}

Parameters

NameTypeRequiredDescription
session_idstrIdentifier of the Session.

Return Type

RegSessionModel

Example Usage Code Snippet

from ring_central import RingCentral, Environment

sdk = RingCentral(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value
)

result = sdk.registration_management.rcw_reg_get_session(session_id="ame")

print(result)

rcw_reg_update_session

Updates a Session by ID. This is a PARTIAL update (PATCH), client may call it providing only attributes which are to be changed. A caller must be an authorized user: either a host of the webinar or an IT Admin: a user from host's account with "WebinarSettings" permission. If a session record with given ID doesn't exist on Registration Service side the API should return HTTP 404.

  • HTTP Method: PATCH
  • Endpoint: /webinar/registration/v1/sessions/{sessionId}

Parameters

NameTypeRequiredDescription
request_bodyRegSessionModelThe request body.
session_idstrIdentifier of the Session.

Return Type

RegSessionModel

Example Usage Code Snippet

from ring_central import RingCentral, Environment
from ring_central.models import RegSessionModel

sdk = RingCentral(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value
)

request_body = RegSessionModel(
id_="123456789",
registration_status="Open",
registration_page_uri="https://abcde12345.webinar.ringcentral.com/register",
branding_descriptor_uri="https://abcde12345.webinar.ringcentral.com/branding",
registrant_count=10,
has_real_registrants=True,
icalendar_sequence=10,
settings={
"auto_close_limit": 2,
"suppress_emails": True,
"registration_digest_enabled": True,
"prevent_multiple_device_joins": True,
"work_email_required": False,
"view_recording": False,
"on_demand_duration": "OneMonth",
"recording_exist": True
}
)

result = sdk.registration_management.rcw_reg_update_session(
request_body=request_body,
session_id="lab"
)

print(result)

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →