For the complete documentation index, see llms.txt. This page is also available as Markdown.

Katılımcı Ekleme

Bu alan, bir oturuma bir veya birden fazla kullanıcıyı katılımcı olarak GroupsAPI ile eklemenin yöntemini gösterir.

Bir kullanıcıyı bir oturuma katılımcı olarak eklemeden önce ilgili kullanıcının USER_ID verisi ve ilgili oturumun SESSION_ID verilerine ihtiyacınız olacaktır.

Aşağıdaki listede gerekli parametreleri görebilirsiniz:

Parameter
Tip
Açıklama

user_id

string

role

string

a=Admin u=User e=Öğretmen

Aşağıdaki şekilde bir kullanıcıyı bir oturuma katılımcı olarak ekleyebilirsiniz:

curl --location 'https://<DOMAIN>/xapi/session/<SESSION_ID>/attendees' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data '[{
    "user_id": "<USER_ID>",
    "role": "u"
}]'

İlk olarak Python SDK'sı yüklenmelidir:

pip install perculus-sdk

SDK'nın yüklendiğinden emin olunduktan sonra aşağıdaki şekilde kullanıcılarınızı oturumlarınıza katılımcı olarak ekleyebilirsiniz:

from perculus_sdk.client import APIClient

# API client
client = APIClient()

# Set your domain (if you haven't set it before)
client.set_domain("<DOMAIN>")

# Set your credentials(if you haven't set it before)
client.set_credentials(
    access_key="<EMAIL>",
    secret_key="<PASSWORD>",
    account_id="<ACCOUNT_ID>"
)

#Add an Attendee
attendee = client.attendees.add_by_user_id("<SESSION_ID>", "<USER_ID>")
print(attendee)

#Add Multiple Attendees
attendees = client.attendees.add_multiple_by_user_id("<SESSION_ID>", [
    {
        "user_id": "<USER_ID1>",
    },{
        "user_id": "<USER_ID2>",
    }
])
print(attendees)

Aşağıda örnek bir response model görebilirsiniz:

{
    "approved": [
        {
            "session_id": "<SESSION_ID>",
            "user_id": "<USER_ID>",
            "attendee_id": "***",
            "attendance_code": "<ATTENDANCE_CODE>",
            "name": "john",
            "surname": "Doe",
            "email": "john@doe.com",
            "role": "u",
            "mobile": "",
            "avatar": null,
            "creation_date": "2024-08-16T01:55:15.7991084Z",
            "updating_date": null
        }
    ],
    "rejected": []
}

🔴 Response içerisinde approved ve rejected olarak iki obje göreceksiniz, bunların detaylarını aşağıda görebilirsiniz:

  • approved:

    • Katılımcı olarak eklenmeye çalışılan kullanıcılardan başarılı bir şekilde eklene kayıtları listeler.

  • rejected:

    • Katılımcı olarak eklenmeye çalışılan kullanıcılardan başarılı bir şekilde eklenemeyen kayıtları hata kodları ve hata mesajları ile birlikte listeler, aşağıda hatalı eklenmeye çalışılan bir kaydın response'unu görebilirsiniz

Last updated