{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-rtc-white-board/create-app":{"post":{"operationId":"cloud_aliyun_rtc_white_board_create_app","summary":"Creates a whiteboard application. You can set the application name and obtain the AppID at the same time","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName"],"properties":{"AppName":{"type":"string","description":"The application name that you set in the console when creating a whiteboard application. The name must be 1 to 32 characters in length and…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc-white-board/create-white-board":{"post":{"operationId":"cloud_aliyun_rtc_white_board_create_white_board","summary":"Creates a whiteboard document and retrieves the document identifier (DocKey)","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["UserId","AppID"],"properties":{"UserId":{"type":"string","description":"The user ID (business user) who creates the whiteboard. The value is 1 to 32 characters in length and can contain uppercase and lowercase…"},"AppID":{"type":"string","description":"The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc-white-board/describe-apps":{"post":{"operationId":"cloud_aliyun_rtc_white_board_describe_apps","summary":"Queries whiteboard application information under a cloud account by using paged query. Paging is supported","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"AppID":{"type":"string","description":"The unique identifier of the whiteboard application. If this parameter is left empty, all application IDs are queried by default. To…"},"AppStatus":{"type":"integer","description":"The status of the whiteboard application. If this parameter is left empty, all statuses are queried by default. Valid values: 1: Enabled.…"},"PageNum":{"type":"integer","description":"The page number. If this parameter is left empty, the first page is queried by default"},"PageSize":{"type":"integer","description":"The number of entries per page. If this parameter is left empty, the default value is 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc-white-board/describe-white-board-recordings":{"post":{"operationId":"cloud_aliyun_rtc_white_board_describe_white_board_recordings","summary":"Queries the recording list and operation sequences of a whiteboard by paging","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppID","DocKey"],"properties":{"AppID":{"type":"string","description":"The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html"},"DocKey":{"type":"string","description":"The unique identifier of the whiteboard document. To obtain the DocKey, see https://help.aliyun.com/document_detail/204299.html"},"PageNum":{"type":"integer","description":"The page number. If this parameter is left empty, the first page is queried by default"},"PageSize":{"type":"integer","description":"The number of entries per page. If this parameter is left empty, the default value is 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc-white-board/describe-white-boards":{"post":{"operationId":"cloud_aliyun_rtc_white_board_describe_white_boards","summary":"Queries whiteboard document information under a specified AppID by paging","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppID"],"properties":{"AppID":{"type":"string","description":"The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html"},"DocStatus":{"type":"integer","description":"The status of the whiteboard document. If this parameter is left empty, all statuses are queried by default. Valid values: 1: Enabled. 2:…"},"PageNum":{"type":"integer","description":"The page number. If this parameter is left empty, the first page is queried by default"},"PageSize":{"type":"integer","description":"The number of entries per page. If this parameter is left empty, the default value is 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc-white-board/open-white-board":{"post":{"operationId":"cloud_aliyun_rtc_white_board_open_white_board","summary":"Opens an existing whiteboard document and retrieves the connection information for the whiteboard document","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppID","UserId","DocKey"],"properties":{"AppID":{"type":"string","description":"The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html"},"UserId":{"type":"string","description":"The ID of the user who opens the whiteboard (business user), consisting of 1 to 32 characters including uppercase and lowercase letters,…"},"DocKey":{"type":"string","description":"The unique identifier of the whiteboard document. To obtain the DocKey, see https://help.aliyun.com/document_detail/204299.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc-white-board/pause-white-board-recording":{"post":{"operationId":"cloud_aliyun_rtc_white_board_pause_white_board_recording","summary":"Pauses the recording of whiteboard operation sequences","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppID","UserId","DocKey","RecordId"],"properties":{"AppID":{"type":"string","description":"The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html"},"UserId":{"type":"string","description":"The ID of the user (business user) who pauses the whiteboard recording. The value consists of 1 to 32 characters including uppercase and…"},"DocKey":{"type":"string","description":"The unique identifier of the whiteboard document. To obtain the DocKey, see https://help.aliyun.com/document_detail/204299.html"},"RecordId":{"type":"string","description":"The unique identifier of the whiteboard recording session. To obtain the RecordId, see https://help.aliyun.com/document_detail/253300.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc-white-board/refresh-users-permissions":{"post":{"operationId":"cloud_aliyun_rtc_white_board_refresh_users_permissions","summary":"Refreshes the permission cache of whiteboard document users. When a user accesses the whiteboard again, the…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["UserIds","DocKey","AppID"],"properties":{"UserIds":{"type":"string","description":"The IDs of users whose permissions you want to refresh, separated by commas (,). You can specify up to 30 IDs. Each ID consists of digits…"},"DocKey":{"type":"string","description":"The unique identifier of the whiteboard document. To obtain the DocKey, see https://help.aliyun.com/document_detail/204299.html"},"AppID":{"type":"string","description":"The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc-white-board/resume-white-board-recording":{"post":{"operationId":"cloud_aliyun_rtc_white_board_resume_white_board_recording","summary":"Resumes whiteboard operation sequence recording from a paused state","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppID","UserId","DocKey","RecordId"],"properties":{"AppID":{"type":"string","description":"The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html"},"UserId":{"type":"string","description":"The ID of the user (business user) who resumes whiteboard recording. The ID is 1 to 32 characters in length and can contain letters,…"},"DocKey":{"type":"string","description":"The unique identifier of the whiteboard document. To obtain the DocKey, see https://help.aliyun.com/document_detail/204299.html"},"RecordId":{"type":"string","description":"The unique identifier of the whiteboard recording session. To obtain the RecordId, see https://help.aliyun.com/document_detail/253300.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc-white-board/set-app-callback-type":{"post":{"operationId":"cloud_aliyun_rtc_white_board_set_app_callback_type","summary":"Sets the callback type for a whiteboard application","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppID","AppCallbackType"],"properties":{"AppID":{"type":"string","description":"The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html"},"AppCallbackType":{"type":"string","description":"The callback type of the whiteboard application. Separate multiple values with commas (,). Valid values: userPermissionCallback: User…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc-white-board/set-app-callback-url":{"post":{"operationId":"cloud_aliyun_rtc_white_board_set_app_callback_url","summary":"Sets the callback URL and callback authentication code for a whiteboard application","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppID","AppCallbackUrl","AppCallbackAuthKey"],"properties":{"AppID":{"type":"string","description":"The unique identifier of the whiteboard application. To obtain the whiteboard application ID, see…"},"AppCallbackUrl":{"type":"string","description":"The callback URL of the whiteboard application"},"AppCallbackAuthKey":{"type":"string","description":"The callback authentication code of the whiteboard application, consisting of 8 to 20 characters including uppercase letters, lowercase…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc-white-board/set-app-domain-names":{"post":{"operationId":"cloud_aliyun_rtc_white_board_set_app_domain_names","summary":"Sets the list of authorized domain names for a whiteboard application, which are the domain names that need…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppID","AppDomainNames"],"properties":{"AppID":{"type":"string","description":"The unique identifier of the whiteboard application. To obtain the whiteboard application ID, see…"},"AppDomainNames":{"type":"string","description":"The domain names of all customer websites that use the whiteboard application. Separate multiple domain names with commas (,). You can…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc-white-board/set-app-name":{"post":{"operationId":"cloud_aliyun_rtc_white_board_set_app_name","summary":"Renames a whiteboard application","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppID","AppName"],"properties":{"AppID":{"type":"string","description":"The unique identifier of the whiteboard application. To obtain the whiteboard application ID, see…"},"AppName":{"type":"string","description":"The name of the whiteboard application. The name must be 1 to 32 characters in length and can contain Chinese characters, letters, digits,…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc-white-board/set-app-status":{"post":{"operationId":"cloud_aliyun_rtc_white_board_set_app_status","summary":"Sets the status of a whiteboard application. Valid values: 1 (enabled) and 2 (disabled)","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppID","AppStatus"],"properties":{"AppID":{"type":"string","description":"The unique identifier of the whiteboard application. To obtain the whiteboard application ID, see…"},"AppStatus":{"type":"integer","description":"The status of the whiteboard application. Valid values: 1: Enabled. 2: Disabled"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc-white-board/set-users-permissions":{"post":{"operationId":"cloud_aliyun_rtc_white_board_set_users_permissions","summary":"Sets long-term permissions for users of a whiteboard document","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["UserIds","DocKey","AppID","PermissionType"],"properties":{"UserIds":{"type":"string","description":"The IDs of the users for whom you want to set permissions. Separate multiple IDs with commas (,). You can specify up to 30 IDs. Each ID…"},"DocKey":{"type":"string","description":"The unique identifier of the whiteboard document. To obtain the DocKey, see https://help.aliyun.com/document_detail/204299.html"},"AppID":{"type":"string","description":"The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html"},"PermissionType":{"type":"string","description":"The user whiteboard permission type. Valid values: ban: No permissions. read: Read-only. edit: Read and write"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc-white-board/start-white-board-recording":{"post":{"operationId":"cloud_aliyun_rtc_white_board_start_white_board_recording","summary":"Starts recording the operation sequence of a whiteboard","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppID","UserId","DocKey"],"properties":{"AppID":{"type":"string","description":"The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html"},"UserId":{"type":"string","description":"The ID of the user (business user) who starts the whiteboard recording. The value is 1 to 32 characters in length and can contain…"},"DocKey":{"type":"string","description":"The unique identifier of the whiteboard document. To obtain the DocKey, see https://help.aliyun.com/document_detail/204299.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc-white-board/stop-white-board-recording":{"post":{"operationId":"cloud_aliyun_rtc_white_board_stop_white_board_recording","summary":"Stops recording a whiteboard operation sequence","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppID","UserId","DocKey","RecordId"],"properties":{"AppID":{"type":"string","description":"The unique identifier of the whiteboard application. To obtain the AppID, see https://help.aliyun.com/document_detail/204234.html"},"UserId":{"type":"string","description":"The ID of the user (business user) who stops the whiteboard recording. The value is 1 to 32 characters in length and can contain uppercase…"},"DocKey":{"type":"string","description":"The unique identifier of the whiteboard document. To obtain the DocKey, see https://help.aliyun.com/document_detail/204299.html"},"RecordId":{"type":"string","description":"The unique identifier of the whiteboard recording session. To obtain the RecordId, see https://help.aliyun.com/document_detail/253300.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-rtc-white-board/version":{"post":{"operationId":"cloud_aliyun_rtc_white_board_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}