أسماء الحقول ورموز الأخطاء وأمثلة الشيفرة بالإنجليزية، كما تستخدمها في برنامجك.

مرجع الواجهة

العنوان الأساسي https://deewan.io/api/v1. كل طلب يحتاج إلى Authorization: Bearer <key>.

الحساب

GET/me

فحص المفتاح

Returns the key's id, workspace, scopes and environment. Useful as a connectivity check.

يعيد An api_key object.

الطلب

curl -X GET "https://deewan.io/api/v1/me" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "api_key",
  "id": "9b1f…",
  "workspace_id": "org_8Hk2…",
  "scopes": [
    "rooms:read",
    "rooms:write"
  ],
  "environment": "live"
}

الغرف

GET/roomsrooms:read

عرض الغرف

Rooms in the key's scope, newest first. Paginate with starting_after set to the last id of the previous page.

معاملات الاستعلام

limitinteger: 1–100, default 25.
starting_afteruuid: Return rooms created before this room.

يعيد A list of room objects.

الطلب

curl -X GET "https://deewan.io/api/v1/rooms" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "list",
  "data": [
    {
      "object": "room",
      "id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
      "name": "Onboarding call",
      "code": "k7pq-3mzt-9xwe",
      "description": null,
      "url": "https://deewan.io/en/r/k7pq-3mzt-9xwe",
      "locked": false,
      "workspace_id": "org_8Hk2…",
      "team_id": null,
      "settings": {
        "access": "link",
        "admission": "knock",
        "mute_on_entry": false,
        "camera_off_on_entry": false,
        "screen_share": "hosts",
        "reactions": true,
        "chat": true,
        "encryption": "standard",
        "recordings": "workspace",
        "before_host": "join",
        "type": "meeting"
      },
      "created_at": "2026-09-17T09:12:44.120Z",
      "updated_at": "2026-09-17T09:12:44.120Z"
    }
  ],
  "has_more": false
}

POST/roomsrooms:write

إنشاء غرفة

Creates a room with a permanent link. Rooms created through the API default to access: "link".

جسم الطلب

namestringمطلوب: 1–80 characters.
descriptionstring | null: Up to 500 characters.
settings.access"members" | "link": link: anyone with the link can join, with or without an account. members: only people who can already see the room.
settings.admission"direct" | "knock": direct: everyone the room lets in walks straight in (in a link room, anyone with the link). knock: everyone but hosts waits for a host to admit them.
settings.mute_on_entryboolean: Join participants with their microphone off.
settings.camera_off_on_entryboolean: Join participants with their camera off.
settings.screen_share"everyone" | "hosts": Who may share their screen.
settings.reactionsboolean: Allow emoji reactions.
settings.chatboolean: Allow meeting chat.
settings.encryption"standard" | "strict": strict: the meeting key exists only on participants' devices and Deewan can't access meeting content. Media tokens and live captions aren't available; use join links. Can't be changed while a meeting is running.
settings.recordings"workspace" | "end_to_end": workspace (the default for rooms made through the API): recordings can be downloaded and played through this API. end_to_end: only people allowed in the room can open them — not Deewan, not the API. Strict rooms are always end_to_end.
settings.before_host"join" | "wait": What happens before a host arrives. join (default): people let into the room go straight in. wait: they wait on the pre-join page and come in automatically the moment a host joins. Applies to the room's own link; join links you create through this API always go straight in.

يعيد The new room.

الطلب

curl -X POST "https://deewan.io/api/v1/rooms" \
  -H "Authorization: Bearer $DEEWAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Onboarding call","settings":{"admission":"knock","screen_share":"hosts"}}'

الاستجابة

{
  "object": "room",
  "id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
  "name": "Onboarding call",
  "code": "k7pq-3mzt-9xwe",
  "description": null,
  "url": "https://deewan.io/en/r/k7pq-3mzt-9xwe",
  "locked": false,
  "workspace_id": "org_8Hk2…",
  "team_id": null,
  "settings": {
    "access": "link",
    "admission": "knock",
    "mute_on_entry": false,
    "camera_off_on_entry": false,
    "screen_share": "hosts",
    "reactions": true,
    "chat": true,
    "encryption": "standard",
    "recordings": "workspace",
    "before_host": "join",
    "type": "meeting"
  },
  "created_at": "2026-09-17T09:12:44.120Z",
  "updated_at": "2026-09-17T09:12:44.120Z"
}

GET/rooms/{room_id}rooms:read

قراءة غرفة

Returns one room.

معاملات المسار

room_iduuidمطلوب: The room's id.

يعيد A room.

الطلب

curl -X GET "https://deewan.io/api/v1/rooms/$ROOM_ID" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "room",
  "id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
  "name": "Onboarding call",
  "code": "k7pq-3mzt-9xwe",
  "description": null,
  "url": "https://deewan.io/en/r/k7pq-3mzt-9xwe",
  "locked": false,
  "workspace_id": "org_8Hk2…",
  "team_id": null,
  "settings": {
    "access": "link",
    "admission": "knock",
    "mute_on_entry": false,
    "camera_off_on_entry": false,
    "screen_share": "hosts",
    "reactions": true,
    "chat": true,
    "encryption": "standard",
    "recordings": "workspace",
    "before_host": "join",
    "type": "meeting"
  },
  "created_at": "2026-09-17T09:12:44.120Z",
  "updated_at": "2026-09-17T09:12:44.120Z"
}

PATCH/rooms/{room_id}rooms:write

تعديل غرفة

Changes the name, description, lock or settings. Setting changes apply immediately to a meeting in progress (who may share, chat and react).

معاملات المسار

room_iduuidمطلوب: The room's id.

جسم الطلب

namestring: 1–80 characters.
descriptionstring | null: Up to 500 characters.
lockedboolean: A locked room admits nobody new.
settings.access"members" | "link": link: anyone with the link can join, with or without an account. members: only people who can already see the room.
settings.admission"direct" | "knock": direct: everyone the room lets in walks straight in (in a link room, anyone with the link). knock: everyone but hosts waits for a host to admit them.
settings.mute_on_entryboolean: Join participants with their microphone off.
settings.camera_off_on_entryboolean: Join participants with their camera off.
settings.screen_share"everyone" | "hosts": Who may share their screen.
settings.reactionsboolean: Allow emoji reactions.
settings.chatboolean: Allow meeting chat.
settings.encryption"standard" | "strict": strict: the meeting key exists only on participants' devices and Deewan can't access meeting content. Media tokens and live captions aren't available; use join links. Can't be changed while a meeting is running.
settings.recordings"workspace" | "end_to_end": workspace (the default for rooms made through the API): recordings can be downloaded and played through this API. end_to_end: only people allowed in the room can open them — not Deewan, not the API. Strict rooms are always end_to_end.
settings.before_host"join" | "wait": What happens before a host arrives. join (default): people let into the room go straight in. wait: they wait on the pre-join page and come in automatically the moment a host joins. Applies to the room's own link; join links you create through this API always go straight in.

يعيد The updated room.

الطلب

curl -X PATCH "https://deewan.io/api/v1/rooms/$ROOM_ID" \
  -H "Authorization: Bearer $DEEWAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"locked":true}'

الاستجابة

{
  "object": "room",
  "id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
  "name": "Onboarding call",
  "code": "k7pq-3mzt-9xwe",
  "description": null,
  "url": "https://deewan.io/en/r/k7pq-3mzt-9xwe",
  "locked": true,
  "workspace_id": "org_8Hk2…",
  "team_id": null,
  "settings": {
    "access": "link",
    "admission": "knock",
    "mute_on_entry": false,
    "camera_off_on_entry": false,
    "screen_share": "hosts",
    "reactions": true,
    "chat": true,
    "encryption": "standard",
    "recordings": "workspace",
    "before_host": "join",
    "type": "meeting"
  },
  "created_at": "2026-09-17T09:12:44.120Z",
  "updated_at": "2026-09-17T09:12:44.120Z"
}

DELETE/rooms/{room_id}rooms:write

حذف غرفة

Deletes the room and ends any meeting in it. Its link stops working.

معاملات المسار

room_iduuidمطلوب: The room's id.

يعيد The deleted room with deleted: true.

الطلب

curl -X DELETE "https://deewan.io/api/v1/rooms/$ROOM_ID" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "room",
  "id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
  "name": "Onboarding call",
  "code": "k7pq-3mzt-9xwe",
  "description": null,
  "url": "https://deewan.io/en/r/k7pq-3mzt-9xwe",
  "locked": false,
  "workspace_id": "org_8Hk2…",
  "team_id": null,
  "settings": {
    "access": "link",
    "admission": "knock",
    "mute_on_entry": false,
    "camera_off_on_entry": false,
    "screen_share": "hosts",
    "reactions": true,
    "chat": true,
    "encryption": "standard",
    "recordings": "workspace",
    "before_host": "join",
    "type": "meeting"
  },
  "created_at": "2026-09-17T09:12:44.120Z",
  "updated_at": "2026-09-17T09:12:44.120Z",
  "deleted": true
}

الانضمام

POST/rooms/{room_id}/join-linkstokens:create

إنشاء رابط انضمام

A personal, expiring link into Deewan's hosted meeting page. The person needs no Deewan account and does not wait in the waiting room — your server already decided they may join. Send each person their own link.

معاملات المسار

room_iduuidمطلوب: The room's id.

جسم الطلب

namestringمطلوب: Display name shown to others (1–60).
role"host" | "participant": Hosts may share their screen and speak in hosts-only rooms. Default participant.
user_idstring: Your own id for this person (max 64). Keeps a stable identity across links.
expires_ininteger: Seconds, 60–604800. Default 3600.
locale"en" | "ar": Interface language. Default en.
redirect_urlstring: Where people go when they leave or the meeting ends — your app, instead of deewan.io. https:// only, max 500 characters.
branding"deewan" | "none": none hides Deewan's name and logo on the meeting pages (white-label). Default deewan.

يعيد A join_link.

الطلب

curl -X POST "https://deewan.io/api/v1/rooms/$ROOM_ID/join-links" \
  -H "Authorization: Bearer $DEEWAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Sara Ahmed","role":"host","user_id":"user_123","expires_in":7200,"redirect_url":"https://app.example.com/sessions/42/done","branding":"none"}'

الاستجابة

{
  "object": "join_link",
  "url": "https://deewan.io/en/j/eyJ2Ijox…",
  "room_id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
  "role": "host",
  "redirect_url": "https://app.example.com/sessions/42/done",
  "branding": "none",
  "expires_at": "2026-09-17T11:12:44.000Z"
}

POST/rooms/{room_id}/tokenstokens:create

إنشاء رمز وسائط

Credentials for an interface you build yourself, using @deewan/client in the browser. Valid for 10 minutes to connect. Includes the meeting's end-to-end encryption passphrase: treat the whole response as a secret for that one person. For Deewan's own interface, create a join link instead. Rooms with strict encryption return 409: their key never exists on our servers, so there is no passphrase to give.

معاملات المسار

room_iduuidمطلوب: The room's id.

جسم الطلب

namestringمطلوب: Display name (1–60).
role"host" | "participant": Default participant.
user_idstring: Your own id for this person (max 64).
avatarstring: A Deewan avatar preset id, a01–a16.

يعيد A room_token.

الطلب

curl -X POST "https://deewan.io/api/v1/rooms/$ROOM_ID/tokens" \
  -H "Authorization: Bearer $DEEWAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Omar","user_id":"user_456"}'

الاستجابة

{
  "object": "room_token",
  "server_url": "wss://media.deewan.io",
  "token": "eyJhbGciOi…",
  "identity": "api_Qm9vZ3Y…3pvf.k2d9x0aa",
  "e2ee_passphrase": "Yx3…",
  "expires_in": 600
}

المشاركون

GET/rooms/{room_id}/participantsparticipants:read

عرض المشاركين

Who is in the meeting right now. Empty when the meeting isn't running.

معاملات المسار

room_iduuidمطلوب: The room's id.

يعيد A list of participant objects.

الطلب

curl -X GET "https://deewan.io/api/v1/rooms/$ROOM_ID/participants" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "list",
  "data": [
    {
      "object": "participant",
      "identity": "api_Qm9vZ3Y.k2d9x0aa",
      "name": "Omar",
      "role": "participant",
      "joined_at": "2026-09-17T09:20:11.000Z",
      "audio_muted": false,
      "video_muted": true,
      "screen_sharing": false,
      "hand_raised": false
    }
  ],
  "has_more": false
}

POST/rooms/{room_id}/participants/{identity}/muteparticipants:write

كتم مشارك

Mutes someone's microphone. Only they can unmute themselves.

معاملات المسار

room_iduuidمطلوب: The room's id.
identitystringمطلوب: The participant's identity.

يعيد { object, identity, audio_muted: true }

الطلب

curl -X POST "https://deewan.io/api/v1/rooms/$ROOM_ID/participants/$IDENTITY/mute" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "participant",
  "identity": "api_Qm9vZ3Y.k2d9x0aa",
  "audio_muted": true
}

POST/rooms/{room_id}/participants/{identity}/cohostparticipants:write

تعيين مضيف مشارك

Gives someone in the meeting host powers for this meeting only: admitting, muting and removing people, and running breakout rooms and polls. Not the room itself — a co-host can't change its saved settings or delete it — and it ends when the meeting ends. Works for Deewan accounts and for your own users who joined with a token from this API — for them it lasts while they're connected (to make someone a host from the start, create their token with role: "host"). The key's creator must manage the room.

معاملات المسار

room_iduuidمطلوب: The room's id.
identitystringمطلوب: The participant's identity.

يعيد { object, identity, cohost: true }

الطلب

curl -X POST "https://deewan.io/api/v1/rooms/$ROOM_ID/participants/$IDENTITY/cohost" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "participant",
  "identity": "user_2fK9Lm.k2d9x0aa",
  "cohost": true
}

DELETE/rooms/{room_id}/participants/{identity}/cohostparticipants:write

إلغاء المضيف المشارك

Takes co-host powers back. Never demotes one of the room's own hosts (400 not_a_cohost).

معاملات المسار

room_iduuidمطلوب: The room's id.
identitystringمطلوب: The participant's identity.

يعيد { object, identity, cohost: false }

الطلب

curl -X DELETE "https://deewan.io/api/v1/rooms/$ROOM_ID/participants/$IDENTITY/cohost" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "participant",
  "identity": "user_2fK9Lm.k2d9x0aa",
  "cohost": false
}

POST/rooms/{room_id}/participants/{identity}/stageparticipants:write

دعوة للتحدّث (الندوات)

In a webinar, puts someone from the audience on stage: the media server now lets them publish their microphone and camera (and their screen, if the room allows it). Lasts while they're connected. Hosts are always on stage (400 already_host); a meeting has no audience (400 not_a_webinar). The key's creator must manage the room.

معاملات المسار

room_iduuidمطلوب: The room's id.
identitystringمطلوب: The participant's identity.

يعيد { object, identity, on_stage: true }

الطلب

curl -X POST "https://deewan.io/api/v1/rooms/$ROOM_ID/participants/$IDENTITY/stage" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "participant",
  "identity": "api_Qm9vZ3Y.k2d9x0aa",
  "on_stage": true
}

DELETE/rooms/{room_id}/participants/{identity}/stageparticipants:write

إعادة إلى الجمهور (الندوات)

Sends someone on stage back to the audience. The media server stops their microphone, camera and screen at once.

معاملات المسار

room_iduuidمطلوب: The room's id.
identitystringمطلوب: The participant's identity.

يعيد { object, identity, on_stage: false }

الطلب

curl -X DELETE "https://deewan.io/api/v1/rooms/$ROOM_ID/participants/$IDENTITY/stage" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "participant",
  "identity": "api_Qm9vZ3Y.k2d9x0aa",
  "on_stage": false
}

GET/rooms/{room_id}/waitingparticipants:read

عرض غرفة الانتظار

People asking to join, oldest first. People wait in rooms set to "Ask to join", and outsiders wait in members-only rooms. Nobody is kept waiting more than an hour.

معاملات المسار

room_iduuidمطلوب: The room's id.

يعيد A list of waiting_participant objects.

الطلب

curl -X GET "https://deewan.io/api/v1/rooms/$ROOM_ID/waiting" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "list",
  "data": [
    {
      "object": "waiting_participant",
      "identity": "guest_Hk2p9QwEr3.m1x0aa2b",
      "name": "Rania"
    }
  ]
}

POST/rooms/{room_id}/waiting/{identity}participants:write

السماح بالدخول أو الرفض

Lets someone in from the waiting room, or turns them away.

معاملات المسار

room_iduuidمطلوب: The room's id.
identitystringمطلوب: The participant's identity.

جسم الطلب

decision"admit" | "deny"مطلوب: What to do.

يعيد { object: "waiting_participant", identity, decision }

الطلب

curl -X POST "https://deewan.io/api/v1/rooms/$ROOM_ID/waiting/$IDENTITY" \
  -H "Authorization: Bearer $DEEWAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"decision":"admit"}'

الاستجابة

{
  "object": "waiting_participant",
  "identity": "guest_Hk2p9QwEr3.m1x0aa2b",
  "decision": "admit"
}

DELETE/rooms/{room_id}/participants/{identity}participants:write

إزالة مشارك

Removes someone from the meeting. Lock the room as well if they shouldn't come back.

معاملات المسار

room_iduuidمطلوب: The room's id.
identitystringمطلوب: The participant's identity.

يعيد { object, identity, removed: true }

الطلب

curl -X DELETE "https://deewan.io/api/v1/rooms/$ROOM_ID/participants/$IDENTITY" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "participant",
  "identity": "api_Qm9vZ3Y.k2d9x0aa",
  "removed": true
}

POST/rooms/{room_id}/endparticipants:write

إنهاء الاجتماع

Disconnects everyone. The room and its link remain.

معاملات المسار

room_iduuidمطلوب: The room's id.

يعيد { object: "room", id, ended: true }

الطلب

curl -X POST "https://deewan.io/api/v1/rooms/$ROOM_ID/end" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "room",
  "id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
  "ended": true
}

الاجتماعات

GET/meetingsmeetings:read

عرض الاجتماعات المجدولة

Meetings overlapping a time window, soonest first.

معاملات الاستعلام

fromISO 8601: Default: now.
toISO 8601: Default: 30 days after from.
limitinteger: 1–100, default 25.

يعيد A list of meeting objects.

الطلب

curl -X GET "https://deewan.io/api/v1/meetings" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "list",
  "data": [
    {
      "object": "meeting",
      "id": "a1d3f0c9-6b2e-4e8f-8d1a-7c0b9e5f2a11",
      "title": "Weekly sync",
      "description": null,
      "starts_at": "2026-10-01T09:00:00.000Z",
      "ends_at": "2026-10-01T09:30:00.000Z",
      "room_id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
      "join_url": "https://deewan.io/en/r/k7pq-3mzt-9xwe",
      "recurrence": "weekly",
      "recurrence_until": null,
      "timezone": "Asia/Amman",
      "created_at": "2026-09-17T09:15:02.000Z"
    }
  ],
  "has_more": false
}

POST/meetingsmeetings:write

جدولة اجتماع

Adds a meeting to the workspace calendar, once or on a repeating rule, optionally in a room. It is also written to the key creator's connected Google and Outlook calendars, and sends meeting.scheduled.

جسم الطلب

titlestringمطلوب: 1–120 characters.
starts_atISO 8601مطلوب: With a timezone offset. For a series, the first occurrence.
ends_atISO 8601مطلوب: After starts_at; a meeting lasts at most 24 hours.
room_iduuid: A room in the key's scope.
descriptionstring | null: Up to 1000 characters.
recurrence"none" | "daily" | "weekdays" | "weekly" | "biweekly" | "monthly": How the meeting repeats. Default none.
recurrence_untilISO 8601 | null: When a series ends. null: it doesn't.
timezonestring | null: IANA zone the series repeats in, e.g. Asia/Amman, so 10:00 stays 10:00 through daylight saving.

يعيد The new meeting.

الطلب

curl -X POST "https://deewan.io/api/v1/meetings" \
  -H "Authorization: Bearer $DEEWAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Weekly sync","room_id":"5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44","starts_at":"2026-10-01T09:00:00.000Z","ends_at":"2026-10-01T09:30:00.000Z","recurrence":"weekly","timezone":"Asia/Amman"}'

الاستجابة

{
  "object": "meeting",
  "id": "a1d3f0c9-6b2e-4e8f-8d1a-7c0b9e5f2a11",
  "title": "Weekly sync",
  "description": null,
  "starts_at": "2026-10-01T09:00:00.000Z",
  "ends_at": "2026-10-01T09:30:00.000Z",
  "room_id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
  "join_url": "https://deewan.io/en/r/k7pq-3mzt-9xwe",
  "recurrence": "weekly",
  "recurrence_until": null,
  "timezone": "Asia/Amman",
  "created_at": "2026-09-17T09:15:02.000Z"
}

GET/meetings/{meeting_id}meetings:read

قراءة اجتماع

Returns one scheduled meeting.

معاملات المسار

meeting_iduuidمطلوب: The meeting's id.

يعيد A meeting.

الطلب

curl -X GET "https://deewan.io/api/v1/meetings/$MEETING_ID" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "meeting",
  "id": "a1d3f0c9-6b2e-4e8f-8d1a-7c0b9e5f2a11",
  "title": "Weekly sync",
  "description": null,
  "starts_at": "2026-10-01T09:00:00.000Z",
  "ends_at": "2026-10-01T09:30:00.000Z",
  "room_id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
  "join_url": "https://deewan.io/en/r/k7pq-3mzt-9xwe",
  "recurrence": "weekly",
  "recurrence_until": null,
  "timezone": "Asia/Amman",
  "created_at": "2026-09-17T09:15:02.000Z"
}

PATCH/meetings/{meeting_id}meetings:write

تعديل اجتماع

Changes a meeting. Fields you leave out keep their value. For a repeating meeting every occurrence changes. Connected calendars are updated too, and meeting.updated is sent.

معاملات المسار

meeting_iduuidمطلوب: The meeting's id.

جسم الطلب

titlestring: 1–120 characters.
starts_atISO 8601: With a timezone offset. For a series, the first occurrence.
ends_atISO 8601: After starts_at; a meeting lasts at most 24 hours.
descriptionstring | null: Up to 1000 characters.
recurrence"none" | "daily" | "weekdays" | "weekly" | "biweekly" | "monthly": How the meeting repeats. Default none.
recurrence_untilISO 8601 | null: When a series ends. null: it doesn't.
timezonestring | null: IANA zone the series repeats in, e.g. Asia/Amman, so 10:00 stays 10:00 through daylight saving.

يعيد The updated meeting.

الطلب

curl -X PATCH "https://deewan.io/api/v1/meetings/$MEETING_ID" \
  -H "Authorization: Bearer $DEEWAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Weekly sync (new time)","starts_at":"2026-10-01T10:00:00+03:00","ends_at":"2026-10-01T10:30:00+03:00"}'

الاستجابة

{
  "object": "meeting",
  "id": "a1d3f0c9-6b2e-4e8f-8d1a-7c0b9e5f2a11",
  "title": "Weekly sync",
  "description": null,
  "starts_at": "2026-10-01T09:00:00.000Z",
  "ends_at": "2026-10-01T09:30:00.000Z",
  "room_id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
  "join_url": "https://deewan.io/en/r/k7pq-3mzt-9xwe",
  "recurrence": "weekly",
  "recurrence_until": null,
  "timezone": "Asia/Amman",
  "created_at": "2026-09-17T09:15:02.000Z"
}

DELETE/meetings/{meeting_id}meetings:write

إلغاء اجتماع

Removes the meeting from the calendar, and from connected Google and Outlook calendars. The room is not affected.

معاملات المسار

meeting_iduuidمطلوب: The meeting's id.

يعيد The cancelled meeting with deleted: true.

الطلب

curl -X DELETE "https://deewan.io/api/v1/meetings/$MEETING_ID" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "meeting",
  "id": "a1d3f0c9-6b2e-4e8f-8d1a-7c0b9e5f2a11",
  "title": "Weekly sync",
  "description": null,
  "starts_at": "2026-10-01T09:00:00.000Z",
  "ends_at": "2026-10-01T09:30:00.000Z",
  "room_id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
  "join_url": "https://deewan.io/en/r/k7pq-3mzt-9xwe",
  "recurrence": "weekly",
  "recurrence_until": null,
  "timezone": "Asia/Amman",
  "created_at": "2026-09-17T09:15:02.000Z",
  "deleted": true
}

الاستطلاعات

GET/rooms/{room_id}/pollspolls:read

عرض الاستطلاعات

Polls asked in this room in the last 24 hours, newest first, with their counts. Voter names are never returned.

معاملات المسار

room_iduuidمطلوب: The room's id.

يعيد A list of poll objects.

الطلب

curl -X GET "https://deewan.io/api/v1/rooms/$ROOM_ID/polls" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "list",
  "data": [
    {
      "object": "poll",
      "id": "7c1f4a90-52d3-4f1e-9a6b-2e8c0d4f7b31",
      "room_id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
      "question": "Ready to move on?",
      "kind": "single",
      "anonymous": false,
      "results": "after_close",
      "status": "open",
      "created_by": "API",
      "created_at": "2026-09-17T09:30:02.000Z",
      "closed_at": null,
      "total_voters": 12,
      "options": [
        {
          "id": "3b9d1c77-0a44-4f52-8f0e-1d2c3b4a5e60",
          "label": "Yes",
          "votes": 9
        },
        {
          "id": "9f2a5e31-7c08-4b63-9d1a-8e7f6c5b4a32",
          "label": "Not yet",
          "votes": 3
        }
      ]
    }
  ],
  "has_more": false
}

POST/rooms/{room_id}/pollspolls:write

إنشاء استطلاع

Asks everyone in the meeting a question. It appears immediately for people in Deewan's meeting interface.

معاملات المسار

room_iduuidمطلوب: The room's id.

جسم الطلب

questionstringمطلوب: Up to 240 characters.
optionsstring[]مطلوب: Two to ten answers, each up to 120 characters.
kind"single" | "multiple": One answer, or several. Defaults to single.
anonymousboolean: When true, nobody — including hosts — learns who picked what.
results"live" | "after_vote" | "after_close": When participants see the counts. Defaults to live.

يعيد The created poll.

الطلب

curl -X POST "https://deewan.io/api/v1/rooms/$ROOM_ID/polls" \
  -H "Authorization: Bearer $DEEWAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"question":"Ready to move on?","options":["Yes","Not yet"],"results":"after_close"}'

الاستجابة

{
  "object": "poll",
  "id": "7c1f4a90-52d3-4f1e-9a6b-2e8c0d4f7b31",
  "room_id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
  "question": "Ready to move on?",
  "kind": "single",
  "anonymous": false,
  "results": "after_close",
  "status": "open",
  "created_by": "API",
  "created_at": "2026-09-17T09:30:02.000Z",
  "closed_at": null,
  "total_voters": 12,
  "options": [
    {
      "id": "3b9d1c77-0a44-4f52-8f0e-1d2c3b4a5e60",
      "label": "Yes",
      "votes": 9
    },
    {
      "id": "9f2a5e31-7c08-4b63-9d1a-8e7f6c5b4a32",
      "label": "Not yet",
      "votes": 3
    }
  ]
}

PATCH/polls/{poll_id}polls:write

إغلاق استطلاع أو إعادة فتحه

Closing stops voting and reveals results that were hidden until the end.

معاملات المسار

poll_iduuidمطلوب: The poll's id.

جسم الطلب

status"open" | "closed"مطلوب: The new state.

يعيد The updated poll.

الطلب

curl -X PATCH "https://deewan.io/api/v1/polls/{poll_id}" \
  -H "Authorization: Bearer $DEEWAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"closed"}'

الاستجابة

{
  "object": "poll",
  "id": "7c1f4a90-52d3-4f1e-9a6b-2e8c0d4f7b31",
  "room_id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
  "question": "Ready to move on?",
  "kind": "single",
  "anonymous": false,
  "results": "after_close",
  "status": "closed",
  "created_by": "API",
  "created_at": "2026-09-17T09:30:02.000Z",
  "closed_at": "2026-09-17T09:31:10.000Z",
  "total_voters": 12,
  "options": [
    {
      "id": "3b9d1c77-0a44-4f52-8f0e-1d2c3b4a5e60",
      "label": "Yes",
      "votes": 9
    },
    {
      "id": "9f2a5e31-7c08-4b63-9d1a-8e7f6c5b4a32",
      "label": "Not yet",
      "votes": 3
    }
  ]
}

DELETE/polls/{poll_id}polls:write

حذف استطلاع

Removes the poll and its votes for everyone.

معاملات المسار

poll_iduuidمطلوب: The poll's id.

يعيد { object: "poll", id, deleted: true }.

الطلب

curl -X DELETE "https://deewan.io/api/v1/polls/{poll_id}" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "poll",
  "id": "7c1f4a90-52d3-4f1e-9a6b-2e8c0d4f7b31",
  "deleted": true
}

الغرف الفرعية

GET/rooms/{room_id}/breakoutsbreakouts:read

عرض الغرف الفرعية

The breakout session running in this meeting, with who is placed in each room and who is still unassigned, plus the ten most recent sessions. active is null when nothing is running.

معاملات المسار

room_iduuidمطلوب: The room's id.

يعيد { object: "breakouts", room_id, active, history }, where active is a breakout_session.

الطلب

curl -X GET "https://deewan.io/api/v1/rooms/$ROOM_ID/breakouts" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "breakouts",
  "room_id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
  "active": {
    "object": "breakout_session",
    "id": "b3d9a7c2-6e41-4f08-8c15-0a7e52d1f9c6",
    "room_id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
    "status": "open",
    "auto_join": true,
    "allow_return": true,
    "self_select": false,
    "duration_seconds": 600,
    "started_at": "2026-09-17T10:00:00.000Z",
    "ends_at": "2026-09-17T10:10:00.000Z",
    "rooms": [
      {
        "id": "e14b07d9-3a52-4c6f-b8d1-92f6a0c73e58",
        "name": "Room 1",
        "members": [
          {
            "id": "user_2fK9…",
            "name": "Salma",
            "present": true,
            "can_return": true
          },
          {
            "id": "api_Xk3mQp9Lr2",
            "name": "Omar",
            "present": true,
            "can_return": false
          }
        ]
      },
      {
        "id": "5a0c9e21-77d4-4b3e-a1f8-c4d62b90e7a3",
        "name": "Room 2",
        "members": [
          {
            "id": "user_7Qa1…",
            "name": "Hana",
            "present": true,
            "can_return": true
          }
        ]
      }
    ],
    "unassigned": []
  },
  "history": [
    {
      "object": "breakout_session_summary",
      "id": "b3d9a7c2-6e41-4f08-8c15-0a7e52d1f9c6",
      "status": "open",
      "started_by": "api",
      "started_at": "2026-09-17T10:00:00.000Z",
      "ends_at": "2026-09-17T10:10:00.000Z",
      "closed_at": null,
      "rooms": 2,
      "people": 3
    }
  ]
}

POST/rooms/{room_id}/breakoutsbreakouts:write

بدء الغرف الفرعية

Splits the people in the meeting into smaller private rooms. Each breakout has its own end-to-end encryption key, so nobody can join or decrypt a room they were not placed in. Only one session can be open at a time; a second start returns 409. Hosts stay in the main room unless include_hosts is set, and can visit any breakout.

معاملات المسار

room_iduuidمطلوب: The room's id.

جسم الطلب

roomsinteger | string[]مطلوب: How many rooms (1–50), or their names. Unnamed rooms are called Room 1, Room 2, …
assign"auto" | "manual" | "none": auto (default) deals everyone out evenly at random; manual uses placements; none opens empty rooms for people to choose from.
placements{ participant, room }[]: With assign: "manual": who goes where. participant is a participant id or a connection identity; room is a 0-based index into rooms. Anyone not in the meeting is ignored.
auto_joinboolean: Move people into their room without asking. Defaults to true.
allow_returnboolean: Let people go back to the main room by themselves. Defaults to true.
self_selectboolean: Let people pick their own room. Implied by assign: "none".
duration_secondsinteger | null: Close the rooms automatically after this long (60 to 14400). Omit to run until ended.
include_hostsboolean: Deal hosts into rooms too when using auto.

يعيد The started breakout_session.

الطلب

curl -X POST "https://deewan.io/api/v1/rooms/$ROOM_ID/breakouts" \
  -H "Authorization: Bearer $DEEWAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rooms":2,"assign":"auto","duration_seconds":600}'

الاستجابة

{
  "object": "breakout_session",
  "id": "b3d9a7c2-6e41-4f08-8c15-0a7e52d1f9c6",
  "room_id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
  "status": "open",
  "auto_join": true,
  "allow_return": true,
  "self_select": false,
  "duration_seconds": 600,
  "started_at": "2026-09-17T10:00:00.000Z",
  "ends_at": "2026-09-17T10:10:00.000Z",
  "rooms": [
    {
      "id": "e14b07d9-3a52-4c6f-b8d1-92f6a0c73e58",
      "name": "Room 1",
      "members": [
        {
          "id": "user_2fK9…",
          "name": "Salma",
          "present": true,
          "can_return": true
        },
        {
          "id": "api_Xk3mQp9Lr2",
          "name": "Omar",
          "present": true,
          "can_return": false
        }
      ]
    },
    {
      "id": "5a0c9e21-77d4-4b3e-a1f8-c4d62b90e7a3",
      "name": "Room 2",
      "members": [
        {
          "id": "user_7Qa1…",
          "name": "Hana",
          "present": true,
          "can_return": true
        }
      ]
    }
  ],
  "unassigned": []
}

POST/rooms/{room_id}/breakouts/assignmentsbreakouts:write

نقل مشارك بين الغرف

Places one person in a breakout room, moves them to another, or sends them back to the main room. It takes effect straight away for people who are connected, and holds for people who reconnect.

معاملات المسار

room_iduuidمطلوب: The room's id.

جسم الطلب

participantstringمطلوب: The participant id, or a connection identity from GET /rooms/{room_id}/participants.
breakout_iduuid | nullمطلوب: The breakout room's id, or null for the main room.
can_returnboolean: Whether this person may go back to the main room by themselves. Defaults to the session's allow_return.

يعيد The updated breakout_session.

الطلب

curl -X POST "https://deewan.io/api/v1/rooms/$ROOM_ID/breakouts/assignments" \
  -H "Authorization: Bearer $DEEWAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"participant":"api_Xk3mQp9Lr2","breakout_id":"5a0c9e21-77d4-4b3e-a1f8-c4d62b90e7a3"}'

الاستجابة

{
  "object": "breakout_session",
  "id": "b3d9a7c2-6e41-4f08-8c15-0a7e52d1f9c6",
  "room_id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
  "status": "open",
  "auto_join": true,
  "allow_return": true,
  "self_select": false,
  "duration_seconds": 600,
  "started_at": "2026-09-17T10:00:00.000Z",
  "ends_at": "2026-09-17T10:10:00.000Z",
  "rooms": [
    {
      "id": "e14b07d9-3a52-4c6f-b8d1-92f6a0c73e58",
      "name": "Room 1",
      "members": [
        {
          "id": "user_2fK9…",
          "name": "Salma",
          "present": true,
          "can_return": true
        },
        {
          "id": "api_Xk3mQp9Lr2",
          "name": "Omar",
          "present": true,
          "can_return": false
        }
      ]
    },
    {
      "id": "5a0c9e21-77d4-4b3e-a1f8-c4d62b90e7a3",
      "name": "Room 2",
      "members": [
        {
          "id": "user_7Qa1…",
          "name": "Hana",
          "present": true,
          "can_return": true
        }
      ]
    }
  ],
  "unassigned": []
}

POST/rooms/{room_id}/breakouts/roomsbreakouts:write

إضافة غرفة

Adds a room to the running session, with its own end-to-end key. Up to 50 rooms.

معاملات المسار

room_iduuidمطلوب: The room's id.

جسم الطلب

namestring: Up to 60 characters. Defaults to "Room N".

يعيد The updated breakout_session.

الطلب

curl -X POST "https://deewan.io/api/v1/rooms/$ROOM_ID/breakouts/rooms" \
  -H "Authorization: Bearer $DEEWAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Room 3"}'

الاستجابة

{
  "object": "breakout_session",
  "id": "b3d9a7c2-6e41-4f08-8c15-0a7e52d1f9c6",
  "room_id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
  "status": "open",
  "auto_join": true,
  "allow_return": true,
  "self_select": false,
  "duration_seconds": 600,
  "started_at": "2026-09-17T10:00:00.000Z",
  "ends_at": "2026-09-17T10:10:00.000Z",
  "rooms": [
    {
      "id": "e14b07d9-3a52-4c6f-b8d1-92f6a0c73e58",
      "name": "Room 1",
      "members": [
        {
          "id": "user_2fK9…",
          "name": "Salma",
          "present": true,
          "can_return": true
        },
        {
          "id": "api_Xk3mQp9Lr2",
          "name": "Omar",
          "present": true,
          "can_return": false
        }
      ]
    },
    {
      "id": "5a0c9e21-77d4-4b3e-a1f8-c4d62b90e7a3",
      "name": "Room 2",
      "members": [
        {
          "id": "user_7Qa1…",
          "name": "Hana",
          "present": true,
          "can_return": true
        }
      ]
    }
  ],
  "unassigned": []
}

PATCH/rooms/{room_id}/breakouts/rooms/{breakout_id}breakouts:write

إعادة تسمية غرفة

Renames a room. People inside see the new name at once.

معاملات المسار

room_iduuidمطلوب: The room's id.
breakout_iduuidمطلوب: The breakout room's id.

جسم الطلب

namestringمطلوب: 1–60 characters.

يعيد The updated breakout_session.

الطلب

curl -X PATCH "https://deewan.io/api/v1/rooms/$ROOM_ID/breakouts/rooms/{breakout_id}" \
  -H "Authorization: Bearer $DEEWAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Design review"}'

الاستجابة

{
  "object": "breakout_session",
  "id": "b3d9a7c2-6e41-4f08-8c15-0a7e52d1f9c6",
  "room_id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
  "status": "open",
  "auto_join": true,
  "allow_return": true,
  "self_select": false,
  "duration_seconds": 600,
  "started_at": "2026-09-17T10:00:00.000Z",
  "ends_at": "2026-09-17T10:10:00.000Z",
  "rooms": [
    {
      "id": "e14b07d9-3a52-4c6f-b8d1-92f6a0c73e58",
      "name": "Room 1",
      "members": [
        {
          "id": "user_2fK9…",
          "name": "Salma",
          "present": true,
          "can_return": true
        },
        {
          "id": "api_Xk3mQp9Lr2",
          "name": "Omar",
          "present": true,
          "can_return": false
        }
      ]
    },
    {
      "id": "5a0c9e21-77d4-4b3e-a1f8-c4d62b90e7a3",
      "name": "Room 2",
      "members": [
        {
          "id": "user_7Qa1…",
          "name": "Hana",
          "present": true,
          "can_return": true
        }
      ]
    }
  ],
  "unassigned": []
}

DELETE/rooms/{room_id}/breakouts/rooms/{breakout_id}breakouts:write

حذف غرفة

Removes a room from the running session. Anyone in it goes back to the main room. A session keeps at least one room.

معاملات المسار

room_iduuidمطلوب: The room's id.
breakout_iduuidمطلوب: The breakout room's id.

يعيد The updated breakout_session.

الطلب

curl -X DELETE "https://deewan.io/api/v1/rooms/$ROOM_ID/breakouts/rooms/{breakout_id}" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "breakout_session",
  "id": "b3d9a7c2-6e41-4f08-8c15-0a7e52d1f9c6",
  "room_id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
  "status": "open",
  "auto_join": true,
  "allow_return": true,
  "self_select": false,
  "duration_seconds": 600,
  "started_at": "2026-09-17T10:00:00.000Z",
  "ends_at": "2026-09-17T10:10:00.000Z",
  "rooms": [
    {
      "id": "e14b07d9-3a52-4c6f-b8d1-92f6a0c73e58",
      "name": "Room 1",
      "members": [
        {
          "id": "user_2fK9…",
          "name": "Salma",
          "present": true,
          "can_return": true
        },
        {
          "id": "api_Xk3mQp9Lr2",
          "name": "Omar",
          "present": true,
          "can_return": false
        }
      ]
    },
    {
      "id": "5a0c9e21-77d4-4b3e-a1f8-c4d62b90e7a3",
      "name": "Room 2",
      "members": [
        {
          "id": "user_7Qa1…",
          "name": "Hana",
          "present": true,
          "can_return": true
        }
      ]
    }
  ],
  "unassigned": []
}

POST/rooms/{room_id}/breakouts/announcebreakouts:write

إرسال رسالة إلى كل الغرف

Shows a short message to everyone in the meeting and in every breakout room at once, for example "Five minutes left". Announcements are shown as a banner and are not end-to-end encrypted, so do not put anything private in them. Limited to ten a minute.

معاملات المسار

room_iduuidمطلوب: The room's id.

جسم الطلب

messagestringمطلوب: Up to 300 characters.

يعيد { object: "breakout_announcement", room_id, sent: true }.

الطلب

curl -X POST "https://deewan.io/api/v1/rooms/$ROOM_ID/breakouts/announce" \
  -H "Authorization: Bearer $DEEWAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message":"Five minutes left."}'

الاستجابة

{
  "object": "breakout_announcement",
  "room_id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
  "sent": true
}

POST/rooms/{room_id}/breakouts/endbreakouts:write

إنهاء الغرف الفرعية

Brings everyone back to the main room. With warn: true people see a 60-second countdown and the rooms close when it ends; otherwise they close at once. Ending the whole meeting also ends any open breakouts.

معاملات المسار

room_iduuidمطلوب: The room's id.

جسم الطلب

warnboolean: Give a 60-second countdown first. Defaults to false.

يعيد { object: "breakouts", room_id, ended, closing, ends_at }.

الطلب

curl -X POST "https://deewan.io/api/v1/rooms/$ROOM_ID/breakouts/end" \
  -H "Authorization: Bearer $DEEWAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"warn":true}'

الاستجابة

{
  "object": "breakouts",
  "room_id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
  "ended": false,
  "closing": true,
  "ends_at": "2026-09-17T10:06:00.000Z"
}

التسجيلات

GET/recordingsrecordings:read

عرض التسجيلات

Recordings made in this workspace's rooms, newest first.

معاملات الاستعلام

room_iduuid: Only recordings from this room.
limitinteger: 1–100, default 50.

يعيد A list of recording objects.

الطلب

curl -X GET "https://deewan.io/api/v1/recordings" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "list",
  "data": [
    {
      "object": "recording",
      "id": "e91c7d45-3a62-4b8f-9c0d-1a2b3c4d5e6f",
      "room_id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
      "title": "Onboarding call",
      "status": "ready",
      "visibility": "room",
      "mime_type": "video/webm;codecs=vp9,opus",
      "parts": 14,
      "bytes": 65011712,
      "duration_ms": 1832000,
      "started_at": "2026-09-17T09:20:00.000Z",
      "ended_at": "2026-09-17T09:50:32.000Z"
    }
  ],
  "has_more": false
}

GET/recordings/{recording_id}recordings:read

قراءة تسجيل

Metadata for one recording, including how many encrypted parts it has.

معاملات المسار

recording_iduuidمطلوب: The recording's id.

يعيد A recording object.

الطلب

curl -X GET "https://deewan.io/api/v1/recordings/{recording_id}" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "recording",
  "id": "e91c7d45-3a62-4b8f-9c0d-1a2b3c4d5e6f",
  "room_id": "5f0c2b8e-1d7a-4c52-9a0e-2f3b7c1d9e44",
  "title": "Onboarding call",
  "status": "ready",
  "visibility": "room",
  "mime_type": "video/webm;codecs=vp9,opus",
  "parts": 14,
  "bytes": 65011712,
  "duration_ms": 1832000,
  "started_at": "2026-09-17T09:20:00.000Z",
  "ended_at": "2026-09-17T09:50:32.000Z"
}

POST/recordings/{recording_id}/downloadrecordings:read

الحصول على الأجزاء والمفتاح

Everything needed to rebuild the file: the part URLs and the key for this one recording. Each part is a 12-byte IV followed by AES-256-GCM ciphertext, authenticated with deewan-recording:<recording id>:<index>. The SDK's recordings.download() does this for you. Treat the key like a password.

معاملات المسار

recording_iduuidمطلوب: The recording's id.

يعيد A recording.download object.

الطلب

curl -X POST "https://deewan.io/api/v1/recordings/{recording_id}/download" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "recording.download",
  "id": "e91c7d45-3a62-4b8f-9c0d-1a2b3c4d5e6f",
  "mime_type": "video/webm;codecs=vp9,opus",
  "bytes": 65011712,
  "encryption": {
    "algorithm": "AES-256-GCM",
    "key": "xq7…",
    "key_encoding": "base64url",
    "iv_bytes": 12
  },
  "parts": [
    {
      "index": 0,
      "url": "https://deewan.io/api/v1/recordings/e91c7d45-3a62-4b8f-9c0d-1a2b3c4d5e6f/parts/0"
    }
  ]
}

GET/recordings/{recording_id}/parts/{index}recordings:read

تنزيل جزء

One encrypted part, exactly as stored. The response is binary, not JSON.

معاملات المسار

recording_iduuidمطلوب: The recording's id.
indexintegerمطلوب: Part number, starting at 0.

يعيد application/octet-stream — IV + ciphertext.

الطلب

curl -X GET "https://deewan.io/api/v1/recordings/{recording_id}/parts/{index}" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

"<binary>"

DELETE/recordings/{recording_id}recordings:write

حذف تسجيل

Deletes the recording and its stored parts. This cannot be undone.

معاملات المسار

recording_iduuidمطلوب: The recording's id.

يعيد { object: "recording", id, deleted: true }.

الطلب

curl -X DELETE "https://deewan.io/api/v1/recordings/{recording_id}" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "recording",
  "id": "e91c7d45-3a62-4b8f-9c0d-1a2b3c4d5e6f",
  "deleted": true
}

الويب هوك

GET/webhookswebhooks:manage

عرض النقاط

Webhook endpoints in the key's scope.

يعيد A list of webhook_endpoint objects.

الطلب

curl -X GET "https://deewan.io/api/v1/webhooks" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "list",
  "data": [
    {
      "object": "webhook_endpoint",
      "id": "3c9e…",
      "url": "https://example.com/hooks/deewan",
      "description": null,
      "events": [
        "room.started"
      ],
      "enabled": true,
      "created_at": "2026-09-17T09:00:00.000Z"
    }
  ],
  "has_more": false
}

POST/webhookswebhooks:manage

إنشاء نقطة

Registers a public HTTPS endpoint. The response includes secret, shown only once — store it to verify signatures. Up to 10 endpoints per scope.

جسم الطلب

urlstringمطلوب: A public https:// URL. Private and local addresses are refused.
eventsstring[]مطلوب: Event types to receive, or ["*"] for all.
descriptionstring | null: Up to 120 characters.
enabledboolean: Default true.

يعيد The new webhook_endpoint plus secret.

الطلب

curl -X POST "https://deewan.io/api/v1/webhooks" \
  -H "Authorization: Bearer $DEEWAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/hooks/deewan","events":["room.started","room.finished","participant.joined"]}'

الاستجابة

{
  "object": "webhook_endpoint",
  "id": "3c9e…",
  "url": "https://example.com/hooks/deewan",
  "description": null,
  "events": [
    "room.started",
    "room.finished",
    "participant.joined"
  ],
  "enabled": true,
  "created_at": "2026-09-17T09:00:00.000Z",
  "secret": "whsec_…"
}

PATCH/webhooks/{webhook_id}webhooks:manage

تعديل نقطة

Change the URL, events, description, or pause it with enabled: false.

معاملات المسار

webhook_iduuidمطلوب: The endpoint's id.

جسم الطلب

urlstring: A public https:// URL.
eventsstring[]: Replaces the event list.
descriptionstring | null: Up to 120 characters.
enabledboolean: Pause or resume deliveries.

يعيد The updated webhook_endpoint.

الطلب

curl -X PATCH "https://deewan.io/api/v1/webhooks/$WEBHOOK_ID" \
  -H "Authorization: Bearer $DEEWAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":false}'

الاستجابة

{
  "object": "webhook_endpoint",
  "id": "3c9e…",
  "url": "https://example.com/hooks/deewan",
  "description": null,
  "events": [
    "room.started"
  ],
  "enabled": false,
  "created_at": "2026-09-17T09:00:00.000Z"
}

DELETE/webhooks/{webhook_id}webhooks:manage

حذف نقطة

Stops deliveries and deletes the endpoint.

معاملات المسار

webhook_iduuidمطلوب: The endpoint's id.

يعيد The deleted endpoint with deleted: true.

الطلب

curl -X DELETE "https://deewan.io/api/v1/webhooks/$WEBHOOK_ID" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "webhook_endpoint",
  "id": "3c9e…",
  "deleted": true
}

POST/webhooks/{webhook_id}/testwebhooks:manage

إرسال حدث تجريبي

Delivers a signed webhook.test event now and reports your endpoint's response.

معاملات المسار

webhook_iduuidمطلوب: The endpoint's id.

يعيد { object: "webhook_test", ok, status }

الطلب

curl -X POST "https://deewan.io/api/v1/webhooks/$WEBHOOK_ID/test" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "webhook_test",
  "ok": true,
  "status": 200
}

GET/webhooks/{webhook_id}/deliverieswebhooks:manage

عرض التسليمات

The 50 most recent delivery attempts, with outcome and your endpoint's status code.

معاملات المسار

webhook_iduuidمطلوب: The endpoint's id.

يعيد A list of webhook_delivery objects.

الطلب

curl -X GET "https://deewan.io/api/v1/webhooks/$WEBHOOK_ID/deliveries" \
  -H "Authorization: Bearer $DEEWAN_API_KEY"

الاستجابة

{
  "object": "list",
  "data": [
    {
      "object": "webhook_delivery",
      "id": "77aa…",
      "event_id": "evt_…",
      "event_type": "room.started",
      "status": "succeeded",
      "attempts": 1,
      "response_code": 200,
      "error": null,
      "created_at": "2026-09-17T09:20:00.000Z"
    }
  ],
  "has_more": false
}