Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 94 additions & 3 deletions chat-apis.json
Original file line number Diff line number Diff line change
Expand Up @@ -521,7 +521,8 @@
"enum": [
"available",
"offline"
]
],
"example": "available"
}
},
{
Expand Down Expand Up @@ -605,6 +606,22 @@
"schema": {
"type": "boolean"
}
},
{
"name": "createdAt[<operator>]",
"in": "query",
"description": "Filter by createdAt start timestamp. Value is a 10-digit unix timestamp. Filters records created on or after this timestamp. Can be used with createdAt[to] for a date range.\n **Supported operators:** from, to.\n **Format:** createdAt[operator]=value.\n **Example:** createdAt[from]=1738368000",
"schema": {
"type": "integer"
}
},
{
"name": "updatedAt[<operator>]",
"in": "query",
"description": "Filter by updatedAt start timestamp. Value is a 10-digit unix timestamp. Filters records updated on or after this timestamp. Can be used with updatedAt[to] for a date range.\n **Supported operators:** from, to.\n **Format:** updatedAt[operator]=value.\n **Example:** updatedAt[from]=1738368000",
"schema": {
"type": "integer"
}
}
],
"responses": {
Expand Down Expand Up @@ -1413,6 +1430,51 @@
"schema": {
"type": "boolean"
}
},
{
"name": "guid",
"in": "query",
"description": "Filter groups by a specific GUID. Accepts a single GUID value.",
"schema": {
"type": "string"
}
},
{
"name": "guids",
"in": "query",
"description": "Filter groups by multiple GUIDs. Accepts comma-separated GUID values.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "createdAt[<operator>]",
"in": "query",
"description": "Filter by createdAt start timestamp. Value is a 10-digit unix timestamp. Filters groups created on or after this timestamp. Can be used with createdAt[to] for a date range.\n **Supported operators:** from, to.\n **Format:** createdAt[operator]=value.\n **Example:** createdAt[from]=1738368000",
"schema": {
"type": "integer"
}
},
{
"name": "updatedAt[<operator>]",
"in": "query",
"description": "Filter by updatedAt start timestamp. Value is a 10-digit unix timestamp. Filters groups updated on or after this timestamp. Can be used with updatedAt[to] for a date range.\n **Supported operators:** from, to.\n **Format:** updatedAt[operator]=value.\n **Example:** updatedAt[from]=1738368000",
"schema": {
"type": "integer"
}
},
{
"name": "membersCount[<operator>]",
"in": "query",
"description": "Filter groups by members count using comparison operators.\n **Supported operators:** eq, gt, gte, lt, lte.\n **Format:** membersCount[operator]=value.\n **Example:** membersCount[gte]=2",
"schema": {
"type": "integer"
}
}
],
"responses": {
Expand Down Expand Up @@ -1991,6 +2053,19 @@
"type": "string"
}
},
{
"name": "senders",
"in": "query",
"description": "Filter messages by multiple sender UIDs. Accepts comma-separated UID values.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "mentionsWithBlockedInfo",
"in": "query",
Expand Down Expand Up @@ -2048,9 +2123,25 @@
}
},
{
"name": "sentAt",
"name": "sentAt[<operator>]",
"in": "query",
"description": "Filter by message sent time. Value is a 10-digit unix timestamp. Fetches messages sent after the specified timestamp.\n **Supported operators:** from, to.\n **Format:** sentAt[operator]=value.\n **Example:** sentAt[from]=1738368000",
"schema": {
"type": "integer"
}
},
{
"name": "updatedAt[<operator>]",
"in": "query",
"description": "Filter by updatedAt start timestamp. Value is a 10-digit unix timestamp. Filters messages updated on or after this timestamp. Can be used with updatedAt[to] for a date range.\n **Supported operators:** from, to.\n **Format:** updatedAt[operator]=value.\n **Example:** updatedAt[from]=1738368000",
"schema": {
"type": "integer"
}
},
{
"name": "editedAt[<operator>]",
"in": "query",
"description": "Fetches the messages list after a particular sentAt timestamp.",
"description": "Filter by editedAt start timestamp. Value is a 10-digit unix timestamp. Filters messages edited on or after this timestamp. Can be used with editedAt[to] for a date range.\n **Supported operators:** from, to.\n **Format:** editedAt[operator]=value.\n **Example:** editedAt[from]=1738368000",
"schema": {
"type": "integer"
}
Expand Down
169 changes: 169 additions & 0 deletions data-import-apis.json
Original file line number Diff line number Diff line change
Expand Up @@ -2081,6 +2081,30 @@
},
"type": "object"
},
"RolePermissionSchema": {
"description": "Role permission mapping",
"properties": {
"role": {
"description": "Role name",
"type": "string",
"example": "admin"
},
"permissions": {
"description": "List of permissions mapped to the role",
"type": "object",
"example": {
"users.read": true,
"users.write": true,
"groups.read": true,
"groups.write": false
},
"additionalProperties": {
"type": "boolean"
}
}
},
"type": "object"
},
"Schedule": {
"properties": {
"monday": {
Expand Down Expand Up @@ -2275,6 +2299,36 @@
},
"type": "object"
},
"ScopePermissionSchema": {
"description": "Scope permission details",
"properties": {
"scope": {
"description": "Scope identifier",
"type": "string",
"example": "users"
},
"permissions": {
"description": "List of permissions available for this scope",
"type": "array",
"items": {
"properties": {
"permission": {
"description": "Permission identifier",
"type": "string",
"example": "read"
},
"description": {
"description": "Permission description",
"type": "string",
"example": "View user information"
}
},
"type": "object"
}
}
},
"type": "object"
},
"SentenceSimilaritySchema": {
"required": [
"category",
Expand Down Expand Up @@ -2334,6 +2388,64 @@
},
"type": "object"
},
"SetRolePermissionSchema": {
"description": "Set role permission response",
"properties": {
"role": {
"description": "Role identifier",
"type": "string",
"example": "default"
},
"permissions": {
"description": "Permissions configuration for the role",
"type": "object",
"example": {
"createGroup": "allow",
"listUsers.mode": "friends",
"createGroup.allowedGroupTypes": [
"public"
]
},
"additionalProperties": true
},
"updatedAt": {
"description": "Timestamp when permissions were last updated",
"type": "integer",
"example": 1640000000
}
},
"type": "object"
},
"SetScopePermissionSchema": {
"description": "Set scope permission response",
"properties": {
"guid": {
"description": "Group identifier",
"type": "string",
"example": "supergroup"
},
"scope": {
"description": "Scope identifier",
"type": "string",
"example": "admin"
},
"permissions": {
"description": "Permissions configuration for the scope",
"type": "object",
"example": {
"sendMessage": "deny",
"initiateCall": "friends"
},
"additionalProperties": true
},
"updatedAt": {
"description": "Timestamp when permissions were last updated",
"type": "integer",
"example": 1640000000
}
},
"type": "object"
},
"SilentNotification": {
"properties": {
"chat": {
Expand Down Expand Up @@ -2520,6 +2632,63 @@
},
"type": "object"
},
"UnsetRolePermissionSchema": {
"description": "Unset role permission response",
"properties": {
"role": {
"description": "Role identifier",
"type": "string",
"example": "default"
},
"permission": {
"description": "The permission key that was removed",
"type": "string",
"example": "listUsers.mode"
},
"status": {
"description": "Status of the operation",
"type": "string",
"example": "removed"
},
"updatedAt": {
"description": "Timestamp when permission was removed",
"type": "integer",
"example": 1640000000
}
},
"type": "object"
},
"UnsetScopePermissionSchema": {
"description": "Unset scope permission response",
"properties": {
"guid": {
"description": "Group identifier",
"type": "string",
"example": "supergroup"
},
"scope": {
"description": "Scope identifier",
"type": "string",
"example": "admin"
},
"permission": {
"description": "The permission key that was removed",
"type": "string",
"example": "sendMessage"
},
"status": {
"description": "Status of the operation",
"type": "string",
"example": "removed"
},
"updatedAt": {
"description": "Timestamp when permission was removed",
"type": "integer",
"example": 1640000000
}
},
"type": "object"
},
"UserFilter": {
"required": [
"entity",
Expand Down