{"info":{"_postman_id":"f90fe473-bbec-466a-adaa-8e8c88ec04a6","name":"ChatSphere","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"32763635","collectionId":"f90fe473-bbec-466a-adaa-8e8c88ec04a6","publishedId":"2sA35MzzRV","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-04-08T23:50:46.000Z"},"item":[{"name":"Friend Management","item":[{"name":"Send Friend Request","id":"044c61ba-da15-4338-a491-dd8a7f83190c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/api/v1/users/muhammad@gmail.com/send/mazen@gmail.com","description":"

This request sends a friend request to the user with the specified ID provided in the URL request.

Parameters:

sender_email: The email of the friend who will send the request
receiver_email: The email of the friend who will receive the request

Method: POST

Headers:

Content-Type: application/json

Response:

200 OK: Friend request sent successfully.
400 Bad Request: Invalid input or missing required fields.
404 Not Found: User with the specified ID not found.
500 Internal Server Error: Server encountered an unexpected condition.

Response Example for 200 OK:

{\n    \"body\": null,\n    \"message\": \"Friend request sent successfully.\",\n    \"status\": 200\n}\n\n

Response Example for 404 Not Found:

{\n    \"body\": null,\n    \"message\": \"User with email 'example@mail.com' not found.\",\n    \"status\": 404\n}\n\n

Response Example for 500 Internal Server Error:

{\n    \"body\": null,\n    \"message\": \"Internal Server Error. Please try again later.\",\n    \"status\": 500\n}\n\n

These examples illustrate the possible responses when sending a friend request to a user with a specified ID.

\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","users","muhammad@gmail.com","send","mazen@gmail.com"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"044c61ba-da15-4338-a491-dd8a7f83190c"},{"name":"Respond to friend request","id":"e48a33f9-b1ed-4b32-8e2e-304ab8320391","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"status\": \"ACCEPTED\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/api/v1/users/mo'men@mail.com/response/mohanad@mail.com","description":"

This request allows the user to respond to a friend request with either acceptance or rejection.

Parameters:

sender_email: The email of the friend who will respond to the request
\n
receiver_email: The email of the friend request being responded to.
\n
status: The response to the friend request, either \"accept\" or \"reject\". [ REQUEST BODY ]
\n

Method: POST

Headers:

Content-Type: application/json

Body (JSON):

{\n    \"status\": \"ACCEPTED\"\n}\n\n

Response:

200 OK: Friend request response recorded successfully.
400 Bad Request: Invalid input or missing required fields.
404 Not Found: Friend request with the specified ID not found.
500 Internal Server Error: Server encountered an unexpected condition.

Example:

POST /respond-to-friend-request/789\n{\n    \"status\": \"ACCEPTED/REJECTED\"\n}\n\n

Response Example for 200 OK:

{\n    \"body\": null,\n    \"message\": \"Friend request accepted!/Friend request rejected!\",\n    \"status\": 200\n}\n\n

Response Example for 404 Not Found:

{\n    \"body\": null,\n    \"message\": \"Friend request with email 'example@mail.com' not found.\",\n    \"status\": 404\n}\n\n

Response Example for 500 Internal Server Error:

{\n    \"body\": null,\n    \"message\": \"Internal Server Error. Please try again later.\",\n    \"status\": 500\n}\n\n

These examples demonstrate the possible responses when responding to a friend request with acceptance or rejection.

\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","users","mo'men@mail.com","response","mohanad@mail.com"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"e48a33f9-b1ed-4b32-8e2e-304ab8320391"},{"name":"Get all friends","id":"a339b0b4-d336-4b39-89b6-5d53fd8c0c2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:3000/api/v1/users/nour@gmail.com/friends","description":"

Description:
This request retrieves all the friends of a user.

Parameters:

email: The email of the user whose friends are being retrieved.

Method: GET

Response:

200 OK: Successfully retrieved user's friends.
400 Bad Request: Invalid input or missing required fields.
404 Not Found: User with the specified ID not found or user has no friends.
500 Internal Server Error: Server encountered an unexpected condition.

Example:

Response Example for 200 OK:

{\n    \"body\": [\n        {\n            \"id\": 456,\n            \"username\": \"Jane\",\n            \"email\": \"jane@example.com\"\n        },\n        {\n            \"id\": 789,\n            \"username\": \"Tom\",\n            \"email\": \"tom@example.com\"\n        }\n    ],\n    \"message\": \"User's friends retrieved successfully.\",\n    \"status\": 200\n}\n\n

Response Example for 404 Not Found:

{\n    \"body\": null,\n    \"message\": \"User with email 'sender@example.com' not found.\",\n    \"status\": 404\n}\n\n

Response Example for 500 Internal Server Error:

{\n    \"body\": null,\n    \"message\": \"Internal Server Error. Please try again later.\",\n    \"status\": 500\n}\n\n

These examples illustrate the possible responses when retrieving all the friends of a user.

\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","users","nour@gmail.com","friends"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"a339b0b4-d336-4b39-89b6-5d53fd8c0c2a"},{"name":"Unfriend User","id":"721ab55a-2b22-4006-93c6-14c7725e9be3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PATCH","header":[],"url":"http://localhost:3000/api/v1/users/mohanad@mail.com/unfriend/mo'men@mail.com","description":"

This request unfriends a friend associated with the user's email.

Parameters:

email: The email address of the user who wants to unfriend someone.
friendEmail: The email address of the friend to be unfriended.

Method: DELETE

Response:

200 OK: Successfully unfriended the friend.
\n
400 Bad Request: Invalid input or missing required fields.
\n
404 Not Found: User or friend not found, or they are not friends.
\n
500 Internal Server Error: Server encountered an unexpected condition.
\n

Response Example for 200 OK:

{\n    \"body\": null,\n    \"message\": \"Successfully unfriended.\",\n    \"status\": 200\n}\n\n

Response Example for 404 Not Found:

{\n    \"body\": null,\n    \"message\": \"User 'bishoy@mail.com' or friend 'maz@mail.com' not found, or they are not friends.\",\n    \"status\": 404\n}\n\n

Response Example for 500 Internal Server Error:

{\n    \"body\": null,\n    \"message\": \"Internal Server Error. Please try again later.\",\n    \"status\": 500\n}\n\n

\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","users","mohanad@mail.com","unfriend","mo'men@mail.com"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"721ab55a-2b22-4006-93c6-14c7725e9be3"},{"name":"Cancel friend request","id":"06a634ed-c348-4a9e-a50c-fd84d03f0eec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PATCH","header":[],"url":"http://localhost:3000/api/v1/users/mazen@mail.com/cancel-friend-request/mohanad@mail.com","description":"

This API cancels a friend request if it has not been approved or rejected yet.

API Description:

This API cancels a friend request if it has not been approved or rejected yet.

Endpoint:

bashCopy codeDELETE http://localhost:3000/api/v1/users/{userEmail}/cancel-friend-request/{friendEmail}\n\n

Parameters:

userEmail (path parameter): The email address of the user who initiated the friend request.
friendEmail (path parameter): The email address of the friend for whom the request is to be canceled.

Method: DELETE

Response:

200 OK: Successfully canceled the friend request.
400 Bad Request: Invalid input or missing required fields.
404 Not Found: User or friend not found, or there is no pending friend request.
500 Internal Server Error: Server encountered an unexpected condition.

Response Example for 200 OK:

{\n    \"body\": null,\n    \"message\": \"Friend request canceled successfully.\",\n    \"status\": 200\n}\n\n

Response Example for 404 Not Found:

{\n    \"body\": null,\n    \"message\": \"User 'mazen@mail.com' or friend 'bishoy@mail.com' not found, or there is no pending friend request.\",\n    \"status\": 404\n}\n\n

Response Example for 500 Internal Server Error:

{\n    \"body\": null,\n    \"message\": \"Internal Server Error. Please try again later.\",\n    \"status\": 500\n}\n\n

\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","users","mazen@mail.com","cancel-friend-request","mohanad@mail.com"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"06a634ed-c348-4a9e-a50c-fd84d03f0eec"},{"name":"Get all friend requests","id":"67c0d46b-269f-4336-83f4-12c06ace457a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:3000/api/v1/users/mazen@gmail.com/friend-requests","description":"

Get All Friend Requests

http://localhost:3000/api/v1/users/{email}/friend-requests

Description

Retrieves all friend requests associated with the user's email.

Parameters

email: The email address of the user for whom friend requests are being retrieved.

Responses

200 OK: Successfully retrieved friend requests.
400 Bad Request: Invalid input or missing required fields.
404 Not Found: User not found.
500 Internal Server Error: Server encountered an unexpected condition.

Response Examples

200 OK

{\n    \"message\": \"Friend requests retreived succesfully!\",\n    \"status\": 200,\n    \"body\": [\n        {\n            \"email\": \"mohanad@mail.com\",\n            \"username\": \"test\"\n        }\n    ]\n}\n\n

404 Not Found

{\n    \"body\": null,\n    \"message\": \"User 'mohanad@mail.com' not found.\",\n    \"status\": 404\n}\n\n

500 Internal Server Error

{\n    \"body\": null,\n    \"message\": \"Internal Server Error. Please try again later.\",\n    \"status\": 500\n}\n\n

\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","users","mazen@gmail.com","friend-requests"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"67c0d46b-269f-4336-83f4-12c06ace457a"}],"id":"2859f440-d069-4cbc-a444-d52c1117b6ba","_postman_id":"2859f440-d069-4cbc-a444-d52c1117b6ba","description":""},{"name":"Authentication","item":[{"name":"Register new user","id":"94a020a5-1634-4c4d-8cfc-e0621b84d383","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"username","value":"Bishoy","type":"text","uuid":"ff9f7c18-23b0-4657-9298-bb8f5b6dab15"},{"key":"email","value":"bishosedra0@gmail.com","type":"text","uuid":"05121295-6e12-4269-88a3-049a49bad0c8"},{"key":"password","value":"Password@123","type":"text","uuid":"f5ea1f68-8dcc-46b1-92c4-2193a4fc27d4"}]},"url":"http://localhost:3000/api/v1/auth/register","description":"

This request allows users to create new accounts by providing essential information, including a username, email address, and password.

Parameters:

username: The desired username for the new account.
email: The email address associated with the new account.
password: The chosen password for the new account.

Method: POST

Headers:

Content-Type: application/json

Response:

201 OK: Account successfully created.
400 Bad Request: Invalid input or missing required fields.
409 Conflict: Account with the provided email or username already exists.
500 Internal Server Error: Server encountered an unexpected condition.

\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","auth","register"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"94a020a5-1634-4c4d-8cfc-e0621b84d383"},{"name":"Login","event":[{"listen":"test","script":{"id":"370c6657-9c3a-4c99-9819-76355f811aaa","exec":["// Parse the token from the response\r","let token = pm.response.json().body;\r","\r","\r","// Save it to an environment variable\r","if(token){\r"," pm.environment.set(\"auth_token\", token);\r","}\r",""],"type":"text/javascript","packages":{}}}],"id":"1cf2f8db-f930-494c-905b-d7ee5a3033b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"bishosedra0@gmail.com\",\r\n \"password\": \"Bishoy@123\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/auth/login","description":"

This request enables users to log in to their accounts by providing essential information, including their email address and password.

Parameters:

email: The email address associated with the user's account.
password: The password for the user's account.

Method: POST

Headers:

Content-Type: application/json

Response:

200 OK: Successful login. Returns authentication token.
\n
400 Bad Request: Invalid input or missing required fields.
\n
401 Unauthorized: Incorrect email or password or unverified email
\n
500 Internal Server Error: Server encountered an unexpected condition.
\n

\n","urlObject":{"path":["auth","login"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1cf2f8db-f930-494c-905b-d7ee5a3033b0"},{"name":"Verify User Account","id":"a7d05904-28b6-4b6d-ab0a-7a6d9d8004c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:3000/api/v1/auth/verify/bishosedra0@gmail.com","description":"

This request verifies a user's account after registration by confirming their email address.

Parameters:

email: The email address of the user whose account is being verified.

Method: GET

Response:

200 OK: User account successfully verified.
400 Bad Request: Invalid input or missing required fields.
404 Not Found: User with the specified email not found or account already verified.
500 Internal Server Error: Server encountered an unexpected condition.

Example:

GET /api/v1/auth/verify/bishosedra0@gmail.com\n\n

Response Example for 200 OK:

<h1 class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>Email verified successfully!</h1>\n\n

Response Example for 404 Not Found:

{\n    \"body\": null,\n    \"message\": \"User with email 'bishosedra0@gmail.com' not found or account already verified.\",\n    \"status\": 404\n}\n\n

Response Example for 500 Internal Server Error:

{\n    \"body\": null,\n    \"message\": \"Internal Server Error. Please try again later.\",\n    \"status\": 500\n}\n\n

\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","auth","verify","bishosedra0@gmail.com"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"a7d05904-28b6-4b6d-ab0a-7a6d9d8004c5"}],"id":"f6140f5a-efe6-47ed-ac7e-c0669ba3df1d","_postman_id":"f6140f5a-efe6-47ed-ac7e-c0669ba3df1d","description":""},{"name":"User","item":[{"name":"Get user by email","id":"7707c224-2c63-44d5-bd7b-3f49f309bd31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:3000/api/v1/profile/bishosedra0@gmail.com","description":"

http://localhost:3000/api/v1/profile/{email}

Description:
This API endpoint allows users to retrieve account information by providing the email address associated with the account.

Parameters:

email: The email address associated with the user account. [request parameter not body]

Method:GET

Headers:

Content-Type: application/json

Response:

200 OK: Successful retrieval of the user profile.
400 Bad Request: Invalid input.
404 Not Found: User with the provided email address not found.
500 Internal Server Error: Server encountered an unexpected condition.

200 OK example:

{\n    \"body\": {\n        \"_id\": \"6620690c01d131ca012efba3\",\n        \"username\": \"test changed username\",\n        \"email\": \"mohanad@mail.com\",\n        \"friends\": [],\n        \"__v\": 6\n    },\n    \"status\": 200,\n    \"message\": \"User fetched successfully\"\n}\n\n

\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","profile","bishosedra0@gmail.com"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"7707c224-2c63-44d5-bd7b-3f49f309bd31"},{"name":"Change username by email","id":"43cd7ebe-4c66-49e5-8abe-3788ce9bcb07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"username\": \"test changed username\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/api/v1/profile/change-username/mohanad@mail.com","description":"

http://localhost:3000/api/v1/profile/{email}

Description:

This API endpoint allows users to change their username by providing the email address associated with their account.

Parameters:

email: The email address associated with the user account. [request parameter not body]

Method: PATCH

Headers:

Content-Type: application/json

Response:

200 OK: Successful retrieval of the user profile.
\n
400 Bad Request: Invalid input.
\n
404 Not Found: User with the provided email address not found.
\n
500 Internal Server Error: Server encountered an unexpected condition.
\n

200 OK example:

{\n    \"body\": {\n        \"_id\": \"6620690c01d131ca012efba3\",\n        \"username\": \"test changed username\",\n        \"email\": \"mohanad@mail.com\",\n        \"friends\": [],\n        \"__v\": 6\n    },\n    \"status\": 200,\n    \"message\": \"User fetched successfully\"\n}\n\n

\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","profile","change-username","mohanad@mail.com"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"43cd7ebe-4c66-49e5-8abe-3788ce9bcb07"},{"name":"Public get username by email","id":"86580170-c123-44f9-86f4-d3c0f0359198","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:3000/api/v1/profile/username/mo'men@mail.com","urlObject":{"protocol":"http","port":"3000","path":["api","v1","profile","username","mo'men@mail.com"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"86580170-c123-44f9-86f4-d3c0f0359198"}],"id":"ad6823ba-8d2a-4da8-bc40-0100e4c58581","_postman_id":"ad6823ba-8d2a-4da8-bc40-0100e4c58581","description":""},{"name":"Chat","item":[{"name":"GroupChat","item":[{"name":"Create New Group","id":"2cf1d287-ef13-4828-abcc-aedcb7c861ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"adminEmail\": \"mazen@gmail.com\",\n \"groupName\": \"cat sphere\",\n \"groupDescription\": \"test groupDescription\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/api/v1/chats/groups/create","description":"

Description

Creates a new group chat with the provided details.

Request Body

The request body should be a JSON object with the following properties:

adminEmail (string, required): The email address of the user who will be the admin of the group.
groupName (string, required): The name of the group chat to be created.
groupDescription (string, optional): A description of the group chat (optional).

Method

POST

Responses

200 OK: Group chat created successfully.
400 Bad Request: Invalid input or missing required fields.
500 Internal Server Error: Server encountered an unexpected condition.

{\n    \"body\": \"663bb53d719582c3eef93687\",\n    \"message\": \"Group chat created succesfully!\",\n    \"status\": 200\n}\n\n

\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","chats","groups","create"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"2cf1d287-ef13-4828-abcc-aedcb7c861ab"},{"name":"Add friend to group","id":"abfe0944-2925-4a72-88f9-7d3ab2dc3081","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"adminEmail\": \"mohanad@mail.com\", \n \"userEmail\": \"mo'men@mail.com\",\n \"chatID\": \"663bb53d719582c3eef93687\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/api/v1/chats/groups/add-friend","description":"

Description

Adds a user to an existing group chat as a member.

Endpoint

POST /api/v1/chats/groups/add-friend

Request Body

The request body should be a JSON object with the following properties:

adminEmail (string, required): The email address of the user who is the admin of the group chat.
userEmail (string, required): The email address of the user to be added to the group chat.
chatID (string, required): The unique identifier of the group chat to which the user will be added.

Method

POST

Responses

200 OK: User successfully added to the group chat.
400 Bad Request: Invalid input or missing required fields or user already in group.
404 Not Found: Group chat or user not found.
500 Internal Server Error: Server encountered an unexpected condition.

{\n    \"body\": null,\n    \"message\": \"User added to group chat succesfully!\",\n    \"status\": 200\n}\n\n

\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","chats","groups","add-friend"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"abfe0944-2925-4a72-88f9-7d3ab2dc3081"},{"name":"Get group details","id":"49943274-e749-4acd-9dfd-89a8fb4cf79c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:3000/api/v1/chats/groups/details/66357acd8f7fe6945e491bc6","description":"

http://localhost:3000/api/v1/chats/groups/details/{groupID}

Get Group Chat Details

Description

Retrieves detailed information about a group chat based on the provided groupID.

Parameters

groupID: The unique identifier of the group chat for which details are being requested.

Method

GET

Responses

200 OK: Successfully retrieved group chat details.
400 Bad Request: Invalid input or missing required fields.
404 Not Found: Group chat not found.
500 Internal Server Error: Server encountered an unexpected condition.

{\n    \"message\": \"Group chat details retreived succesfully!\",\n    \"status\": 200,\n    \"body\": {\n        \"_id\": \"66357acd8f7fe6945e491bc8\",\n        \"chat_id\": \"66357acd8f7fe6945e491bc6\",\n        \"group_name\": \"Group1\",\n        \"group_description\": \"\",\n        \"admin_email\": \"mohanad@mail.com\",\n        \"createdAt\": \"2024-05-04T00:01:17.332Z\",\n        \"updatedAt\": \"2024-05-04T00:01:17.332Z\",\n        \"__v\": 0\n    }\n}\n\n

\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","chats","groups","details","66357acd8f7fe6945e491bc6"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"49943274-e749-4acd-9dfd-89a8fb4cf79c"},{"name":"Delete group","id":"db2af48d-9c6c-40ce-9199-f1cabe254fed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"mohanad@mail.com\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/api/v1/chats/groups/66357acd8f7fe6945e491bc6","description":"

Description

Retrieves details about a specific group chat identified by its unique ID.

Endpoint

DELETE /api/v1/chats/groups/66357acd8f7fe6945e491bc6

Parameters

GroupID: The unique identifier of the group chat to be deleted.
email: The email address of the user who is attempting to delete the group chat.

Responses

200 OK: Group chat deleted successfully.
400 Bad Request: Invalid input or missing required fields.
404 Not Found: Group chat not found.
500 Internal Server Error: Server encountered an unexpected condition.

\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","chats","groups","66357acd8f7fe6945e491bc6"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"db2af48d-9c6c-40ce-9199-f1cabe254fed"}],"id":"f540e9e2-a9de-4389-bf72-043fa7daac2b","_postman_id":"f540e9e2-a9de-4389-bf72-043fa7daac2b","description":""},{"name":"Get private chats by mail","id":"227971ed-c257-4b3d-9e6e-f3e4faa24438","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{auth_token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/api/v1/chats/private/bishosedra0@gmail.com","description":"

http://localhost:3000/api/v1/chats/private/test@mail

Description:

This endpoint allows you to get chat messages by providing email address associated with account.

Parameters:

email - email address associated with account

Method: GET

Headers:

Content-Type: application/json

Response:

200 OK Succefssful response
\n
400 Bad Request Invalid request
\n
500 Internal server error Server encountered an error
\n

200 response example

{\n    \"message\": \"Private chats of user retreived succesfully!\",\n    \"status\": 200,\n    \"body\": [\n        {\n            \"_id\": \"66356204908b4bb1bdd6aa7e\",\n            \"users\": [\n                \"mo'men@mail.com\",\n                \"bishoy@mail.com\"\n            ],\n            \"chat_type\": \"PRIVATE\",\n            \"messages\": [\n                {\n                    \"text\": \"frfr\",\n                    \"sender_email\": \"bishoy@mail.com\",\n                    \"_id\": \"66356291bb3234a2d0284184\",\n                    \"createdAt\": \"2024-05-03T22:17:53.231Z\",\n                    \"updatedAt\": \"2024-05-03T22:17:53.231Z\"\n                },\n                {\n                    \"text\": \"not frfr\",\n                    \"sender_email\": \"mo'men@mail.com\",\n                    \"_id\": \"663562a5bb3234a2d0284196\",\n                    \"createdAt\": \"2024-05-03T22:18:13.419Z\",\n                    \"updatedAt\": \"2024-05-03T22:18:13.419Z\"\n                }\n            ],\n            \"createdAt\": \"2024-05-03T22:15:32.288Z\",\n            \"updatedAt\": \"2024-05-03T22:19:09.409Z\",\n            \"__v\": 6\n        }\n    ]\n}\n\n

Message that contains imageUrl example:

{\n                    \"text\": \"test\",\n                    \"imageUrl\": \"https://res.cloudinary.com/dvi7vuujv/image/upload/v1715269261/d9yfp4mqihkmgfsfr3ce.jpg\",\n                    \"sender_email\": \"mohanad@mail.com\",\n                    \"_id\": \"663cee726dc96d7c6894433d\",\n                    \"createdAt\": \"2024-05-09T15:40:36.619Z\",\n                    \"updatedAt\": \"2024-05-09T15:40:36.619Z\"\n                },\n\n

Code Snippet

curl --location --request GET 'http://localhost:3000/api/v1/chats/private/test@mail

\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","chats","private","bishosedra0@gmail.com"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"227971ed-c257-4b3d-9e6e-f3e4faa24438"},{"name":"Get group chats by mail","id":"d6a74d20-d3d0-41a3-8443-673d41443eb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:3000/api/v1/chats/groups/mazen@gmail.com","description":"

http://localhost:3000/api/v1/chats/groups/test@mail

Description:

This endpoint allows you to get group chat messages by providing email address associated with account.

Parameters:

email - email address associated with account

Method GET

Headers:

Content-Type: application/json

Response:

200 OK Succefssful response
400 Bad Request Invalid request
401 Invalid Access
404 Not found User with provided mail address not found
500 Internal server error Server encountered an error

200 OK example:

{\n    \"message\": \"Group chats of user retreived succesfully!\",\n    \"status\": 200,\n    \"body\": [\n        {\n            \"_id\": \"66357acd8f7fe6945e491bc6\",\n            \"users\": [\n                \"mohanad@mail.com\",\n                \"mo'men@mail.com\"\n            ],\n            \"chat_type\": \"GROUP\",\n            \"messages\": [\n                {\n                    \"text\": \"not frfffffffffffr\",\n                    \"sender_email\": \"mo'men@mail.com\",\n                    \"_id\": \"663582b0c4448a411876a04a\",\n                    \"createdAt\": \"2024-05-04T00:34:56.794Z\",\n                    \"updatedAt\": \"2024-05-04T00:34:56.794Z\"\n                }\n            ],\n            \"createdAt\": \"2024-05-04T00:01:17.189Z\",\n            \"updatedAt\": \"2024-05-04T00:34:56.795Z\",\n            \"__v\": 2\n        }\n    ]\n}\n\n

Message that contains imageUrl example:

{\n                    \"text\": \"test\",\n                    \"imageUrl\": \"https://res.cloudinary.com/dvi7vuujv/image/upload/v1715269261/d9yfp4mqihkmgfsfr3ce.jpg\",\n                    \"sender_email\": \"mohanad@mail.com\",\n                    \"_id\": \"663cee726dc96d7c6894433d\",\n                    \"createdAt\": \"2024-05-09T15:40:36.619Z\",\n                    \"updatedAt\": \"2024-05-09T15:40:36.619Z\"\n                },\n\n

Code snippet

curl --location --request GET http://localhost:3000/api/v1/chats/groups/test@mail

\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","chats","groups","mazen@gmail.com"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"d6a74d20-d3d0-41a3-8443-673d41443eb8"}],"id":"815ca4fb-adf1-462c-9d2d-3051cd87c133","_postman_id":"815ca4fb-adf1-462c-9d2d-3051cd87c133","description":""},{"name":"Message","item":[{"name":"Send message","id":"59c18b07-fccd-4b31-8da3-9ed8f8c8b45b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{auth_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"message\": \"This is a test message!\",\r\n \"is_reply\": true,\r\n \"reply_to\": \"6883ea3d66a39d379a0049a8\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/api/v1/messages/bishosedra0@gmail.com/send/6883b44e8987ba9a50f91303","description":"

http://localhost:3000/api/v1/messages/{senderEmail}/send/{chatID}

Description:

Send message from user with {senderID} to chat with {chatID}

Parameters:

senderID - ID of the sender
chatID - ID of the chat

Method POST

Headers:

Content-Type: application/json

Response:

200 OK Succefssful response
400 Bad Request Invalid request
401 Invalid Access
404 Not found User with provided mail address not found
500 Internal server error Server encountered an error

Code snippet

curl --location --request POST http://localhost:3000/api/v1/messages/{senderID}/send/{chatID}

\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","messages","bishosedra0@gmail.com","send","6883b44e8987ba9a50f91303"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"59c18b07-fccd-4b31-8da3-9ed8f8c8b45b"},{"name":"Delete message","id":"e468ec74-b628-4b84-8f0e-da58823fb65b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/api/v1/messages/mazen@gmail.com/delete/6637e78cf88910d2316a71ef/663a6b178c5ea7f1774acffe","description":"

http://localhost:3000/api/v1/messages/{senderMail}/delete/{chatID}/{messageID}

Description:

Delete message from user with {senderID} to chat with {chatID}

Parameters:

senderID - ID of the sender
chatID - ID of the chat

Method POST

Headers:

Content-Type: application/json

Response:

200 OK Succefssful response
400 Bad Request Invalid request
401 Invalid Access
404 Not found User with provided mail address not found
500 Internal server error Server encountered an error

Code snippet

curl --location --request POST http://localhost:3000/api/v1/messages/{senderID}/delete/{chatID}

\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","messages","mazen@gmail.com","delete","6637e78cf88910d2316a71ef","663a6b178c5ea7f1774acffe"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"e468ec74-b628-4b84-8f0e-da58823fb65b"}],"id":"a3b74a69-c248-4e96-9fba-0b046846a26b","_postman_id":"a3b74a69-c248-4e96-9fba-0b046846a26b","description":""}]}