{ "components": { "requestBodies": { "AddonsCreateUserAddonV2Body": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddonsCreateUserAddonV2Body" } } }, "required": true }, "ChatAPIChatBotSendMessageBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatAPIChatBotSendMessageBody" } } }, "required": true }, "SemanticCreateUserSemanticBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SemanticCreateUserSemanticBody" } } }, "required": true } }, "schemas": { "AddonSemanticCarVerificationStage": { "enum": [ "CARVERIFICATIONSTAGE_NOT_STARTED", "CARVERIFICATIONSTAGE_SHAHKAR", "CAR_CARD_VERIFICATION", "CAR_MODEL_VERIFICATION" ], "type": "string" }, "AddonSemanticIdentityVerificationResult": { "enum": [ "FACE_AND_ID_MATCHED" ], "title": "- FACE_AND_ID_MATCHED: ID به معنای کارت ملی است، این مقدار منجر به نشان در تطبیق می‌شود", "type": "string" }, "AddonSemanticIdentityVerificationStage": { "enum": [ "IDENTITYVERIFICATIONSTAGE_NOT_STARTED", "NATIONAL_INFO_VERIFICATION", "IMAGE_VERIFICATION", "VIDEO_VERIFICATION" ], "type": "string" }, "AddonSemanticInspectionResult": { "enum": [ "INSPECTION_APPROVED" ], "type": "string" }, "AddonSemanticNewFaceVerificationResult": { "enum": [ "NEW_FACE_VERIFICATION_FAILED" ], "type": "string" }, "AddonSemanticOnlineReservationCapability": { "enum": [ "ONLINE_RESERVATION_AVAILABLE" ], "type": "string" }, "AddonSemanticOwnershipResult": { "enum": [ "OWNERSHIP_CONFIRMED", "OWNERSHIP_DELEGATION_CONFIRMED" ], "type": "string" }, "AddonSemanticPostVerificationResult": { "enum": [ "POST_INFORMATION_MATCHED" ], "type": "string" }, "AddonsCreateBusinessAddonBody": { "properties": { "widgets": { "items": { "$ref": "#/components/schemas/addonsWidget" }, "type": "array" } }, "type": "object" }, "AddonsCreatePostAddonV2Body": { "properties": { "notes": { "type": "string" }, "semantic": { "additionalProperties": { "type": "string" }, "type": "object" }, "widgets": { "items": { "$ref": "#/components/schemas/addonsWidget" }, "type": "array" } }, "type": "object" }, "AddonsCreateUserAddonV2Body": { "properties": { "categories": { "items": { "type": "string" }, "type": "array" }, "cost": { "format": "int32", "type": "integer" }, "phone": { "type": "string" }, "semantic": { "additionalProperties": { "type": "string" }, "type": "object" }, "ticket_uuid": { "type": "string" }, "widgets": { "items": { "$ref": "#/components/schemas/addonsWidget" }, "type": "array" } }, "type": "object" }, "ChatAPIChatBotSendMessageBody": { "properties": { "buttons": { "$ref": "#/components/schemas/chatapiChatButtonGrid" }, "media_token": { "description": "توکن فایل ضمیمه شده (در صورت وجود)", "example": "media_token_12345", "type": "string" }, "text_message": { "description": "محتوای پیام متنی برای ارسال توسط ربات", "example": "Thank you for your inquiry. How can I help you?", "type": "string" }, "user_id": { "description": "شناسه منحصر به فرد کاربر برای شروع یا ادامه مکالمه", "example": "user_789012", "type": "string" } }, "required": [ "text_message" ], "type": "object" }, "ChatAPIConversationSendMessageBody": { "properties": { "media_token": { "description": "توکن فایل ضمیمه شده (در صورت وجود)", "example": "media_token_12345", "type": "string" }, "message": { "description": "محتوای پیام متنی برای ارسال", "example": "Hello, I'm interested in your product", "type": "string" }, "receiver_buttons": { "$ref": "#/components/schemas/chatapiChatButtonGrid" }, "sender_buttons": { "$ref": "#/components/schemas/chatapiChatButtonGrid" } }, "required": [ "message" ], "type": "object" }, "DivarIconsIconName": { "enum": [ "KEYBOARD_ARROW_RIGHT", "KEYBOARD_ARROW_LEFT", "ARROW_FORWARD", "REFRESH", "REMOVE", "SEND", "DELETE", "PHOTO_LIBRARY", "ADD", "CLOSE", "CHECKED", "CHECK_BOX", "CHECK_BOX_OUTLINE_BLANK", "CHAT_DOUBLE", "CONTENT_COPY", "REPORT", "CAT_VEHICLES", "PERSON", "CALL", "CAT_ELECTRONIC_DEVICES", "PLACE", "HISTORY", "CHECK_CIRCLE", "ACCESS_TIME", "INFO_OUTLINE", "PAYMENT", "SHOW_CHART", "CONTACT_PHONE", "TRENDING_UP", "CAR_BODY", "INSPECT", "CAR_TIRES", "CAR_ELECTRONICS", "CAR_ENGINE", "CAR_HYDRAULICS", "CAR_OPTIONS", "CAR_DOCUMENTS", "CANCEL", "WARNING", "HELP", "MONEY", "KARNAMEH", "EDIT", "SUPPORT", "CAR_INSPECTED", "TERMS", "LADDER_COLLECTION", "HOUSE_INSPECTION", "ADD_CIRCLE", "GAVEL", "LADDER_GROUP", "VISIBILITY", "TIMER", "LOCK", "BLOCK", "EMAIL_OUTLINE", "ASSIGNMENT_IND", "TOC", "EXIT_TO_APP", "HELP_OUTLINE", "TELEPHONE", "EVENT_NOTE", "COMMUNITY", "REAL_ESTATE", "VR", "NUM_1", "NUM_2", "NUM_3", "NUM_4", "NUM_5", "NUM_6", "NUM_7", "NUM_8", "NUM_9", "ELEVATOR", "PARKING", "CABINET", "BALCONY", "TEXTURE", "WC", "SNOWFLAKE", "SUNNY", "THERMOMETER", "VERIFIED", "SETTINGS", "CREDIT_ACCOUNT", "CAR_AUCTION", "CONCIERGE_SALE", "INFO", "MARKETPLACE_GENERAL", "MARKETPLACE_HOME", "MARKETPLACE_PERSONAL", "MARKETPLACE_ELECTRONIC_DEVICES", "INDICATOR_F", "SHARE", "CAR_INSPECTION", "VERIFIED_USER", "MARKETPLACE_LIST", "BINDER", "STAR", "CAR_AMENITY", "CAR_SAFETY", "CAR_EQUIPMENT", "BUSINESS_REAL_ESTATE_AGENCY", "BUSINESS_MARKETPLACE", "BUSINESS_AUTO_DEALERSHIP", "LOCAL_SHIPPING", "MOPED", "TEXT_SMS_OUTLINE", "PLACE_F", "MOBILE_FRIENDLY", "STAR_BORDER", "IMAGE_OUTLINE", "ARTICLE_OUTLINE", "POST_FEEDBACK", "DOWNLOAD", "FILTER", "SUPPORT_AGENT", "MORE_VERT", "BOOKMARK", "BOOKMARK_BORDER", "GIFT", "ANALYTICS", "STORE", "STORE_OUTLINE", "CAT_BUSINESSES", "CAT_FOR_THE_HOME", "CAT_SERVICES", "CAT_PERSONAL", "CAT_LEISURE_HOBBIES", "CAT_JOBS", "SCHOOL", "NOTE", "LOGOUT", "PERSON_ADD", "ADVERT", "ADVERT_OUTLINE", "ACCESS_TIME_OUTLINE", "NOTE_OUTLINE", "PAYMENT_OUTLINE", "INSTAGRAM", "TAG_CHECK_CIRCLE", "FULLSCREEN", "ADD_CIRCLE_OUTLINE", "NOTE_ADD_OUTLINE", "BRAND_ALFA_ROMEO", "BRAND_AMICO", "BRAND_ARIO", "BRAND_ARISAN", "BRAND_AUDI", "BRAND_BAIC", "BRAND_BESTURN", "BRAND_BISU", "BRAND_BMW", "BRAND_BORGWARD", "BRAND_BRILLIANCE", "BRAND_BUICK", "BRAND_BYD", "BRAND_CAPRA", "BRAND_CHANGAN", "BRAND_CHERY", "BRAND_CHEVROLET", "BRAND_CITROEN", "BRAND_DAEWOO", "BRAND_DATSUN", "BRAND_DEER", "BRAND_DELICA", "BRAND_DENA", "BRAND_DIGNITY", "BRAND_DODGE", "BRAND_DOMY", "BRAND_DONGFENG", "BRAND_DS", "BRAND_FARDA", "BRAND_FAW", "BRAND_FIAT", "BRAND_FIDELITY", "BRAND_FORD", "BRAND_FOTON", "BRAND_GAC_GONOW", "BRAND_GEELY", "BRAND_GREATWALL", "BRAND_HAFEI_LOBO", "BRAND_HAIMA", "BRAND_HANTENG", "BRAND_HAVAL", "BRAND_HILLMAN", "BRAND_HONDA", "BRAND_HUMMER", "BRAND_HYOSOW", "BRAND_HYUNDAI", "BRAND_IRANKHODRO_VAN", "BRAND_ISUZU", "BRAND_IVECO", "BRAND_JAC", "BRAND_JAGUAR", "BRAND_JEEP", "BRAND_JMC", "BRAND_JOYLONG", "BRAND_KIA", "BRAND_KMC", "BRAND_LADA", "BRAND_LAMBORGHINI", "BRAND_LAND_ROVER", "BRAND_LANDMARK", "BRAND_LEXUS", "BRAND_LIFAN", "BRAND_LOTUS", "BRAND_LUXGEN", "BRAND_MASERATI", "BRAND_MAXUS", "BRAND_MAZDA", "BRAND_MERCEDESBENZ", "BRAND_MG", "BRAND_MINI", "BRAND_MITSUBISHI", "BRAND_MVM", "BRAND_NARVAN", "BRAND_NISSAN", "BRAND_OLDSMOBILE", "BRAND_OPEL", "BRAND_PAYKAN", "BRAND_PAZHAN", "BRAND_PEUGEOT", "BRAND_PONTIAC", "BRAND_PORSCHE", "BRAND_PRIDE", "BRAND_PROTON", "BRAND_QUICK", "BRAND_RAYEN", "BRAND_RENAULT", "BRAND_RICH", "BRAND_RIGAN", "BRAND_RUNNA", "BRAND_SAINA", "BRAND_SAIPA", "BRAND_SAMAND", "BRAND_SEAT", "BRAND_SHAHIN", "BRAND_SINAD", "BRAND_SMART", "BRAND_SSANGYONG", "BRAND_SUBARU", "BRAND_SUZUKI", "BRAND_SWM", "BRAND_TARA", "BRAND_TIBA", "BRAND_TOYOTA", "BRAND_UAZ", "BRAND_VOLKSWAGEN", "BRAND_VOLVO", "BRAND_ZAMYAD", "BRAND_ZOTYE", "BRAND_SOUEAST", "ARCHWAY", "METRO", "POI", "STREET_SIGN", "TREES", "EARNEST", "RESTAURANT", "BACKPACK", "STETHOSCOPE", "MOSQUE", "HOSPITAL", "CAPSULE", "BANK", "CART", "SHOPPING", "BRAND_CHRYSLER", "BRAND_DAIHATSU", "BRAND_FOWNIX", "BRAND_ROLLSROYCE", "TUNE", "EXCHANGE", "BABY", "BAGUETTE", "BUS", "COFFEE", "FRUIT", "GAS_STATION", "GYM", "HAMBURGER", "HIGHWAY", "MEDIC", "SCHOOL_OUTLINE", "TAXI", "CAMERA", "CAMERA_O", "EYE_OFF", "BRAND_DAYUN", "BRAND_MAXMOTOR", "VIDEOCAM", "BRAND_ACER", "BRAND_ALCATEL", "BRAND_AMAZON", "BRAND_APPLE", "BRAND_ARCHOS", "BRAND_ASUS", "BRAND_BLACKBERRY", "BRAND_BLU", "BRAND_CATERPILLAR", "BRAND_ENERGIZER", "BRAND_GIGABYTE", "BRAND_GIONEE", "BRAND_GLX", "BRAND_GOOGLE", "BRAND_GPLUS", "BRAND_HONOR", "BRAND_HTC", "BRAND_HUAWEI", "BRAND_LENOVO", "BRAND_LG", "BRAND_MEIZU", "BRAND_MICROMAX", "BRAND_MICROSOFT", "BRAND_MOTOROLA", "BRAND_NOKIA", "BRAND_ONEPLUS", "BRAND_OPPO", "BRAND_PANASONIC", "BRAND_PHILIPS", "BRAND_PIXEL", "BRAND_PRESTIGIO", "BRAND_RAZER", "BRAND_REALME", "BRAND_SAMSUNG", "BRAND_SHARP", "BRAND_SONY_ERICSSON", "BRAND_SONY", "BRAND_VERTU", "BRAND_VIVO", "BRAND_XIAOMI", "BRAND_YOTA", "BRAND_ZTE", "BRAND_INROADS", "VIDEOCAM_O", "SHIELD_PHONE", "SHIELD_PHONE_O", "BRAND_LAMARI", "VERIFIED_GREEN", "CHART", "CHART_O", "LAUNCH", "WALLET", "TRASH_O", "TRASH_F", "BRAND_RESPECT", "BRAND_TIGARD", "FILE", "FILE_O", "IMAGE_OUTLINE_O", "CONTACT_PHONE_O", "PUZZLE", "PUZZLE_OUTLINE", "CALL_OUTGOING", "CALL_INCOMING", "CALL_MISSED", "CALL_BLOCKED", "ARCHIVE", "ARCHIVE_O", "CHAT_BUBBLE", "CHAT_BUBBLE_F", "MOBILE_1", "MOBILE_2", "MOBILE_3", "MOBILE_4", "MOBILE_5", "MOBILE_6", "MOBILE_7", "CARPET_1", "CARPET_2", "CARPET_3", "CARPET_4", "CARPET_5", "CARPET_6", "SOFA_1", "SOFA_2", "SOFA_3", "SOFA_4", "SOFA_5", "SOFA_6", "LIGHTS_2", "LIGHTS_1", "LIGHTS_3", "LIGHTS_4", "LIGHTS_5", "BATTERY_CHARGING", "BATTERY_HORIZ_075", "BATTERY_PROFILE", "BUILD_CIRCLE", "HEADPHONES", "INVENTORY", "SMARTPHONE", "HOME_INSPECTION", "MOBILE_INSPECTION", "CAR_COLOR_BLUE", "CAR_COLOR_CHERRY", "CAR_COLOR_PERSIANBLUE", "CAR_COLOR_EGGPLANT", "CAR_COLOR_BRONZE", "CAR_COLOR_BEIGE", "CAR_COLOR_PURPLE", "CAR_COLOR_ONIONSKIN", "CAR_COLOR_TITANIUM", "CAR_COLOR_GRAY", "CAR_COLOR_KHAKI", "CAR_COLOR_SLATEGRAY", "CAR_COLOR_CHARCOAL", "CAR_COLOR_YELLOW", "CAR_COLOR_CRIMSON", "CAR_COLOR_OLIVE", "CAR_COLOR_GREEN", "CAR_COLOR_LIGHTSLATEGRAY", "CAR_COLOR_NAVYBLUE", "CAR_COLOR_WHITE", "CAR_COLOR_OYSTERWHITE", "CAR_COLOR_GOLDEN", "CAR_COLOR_LIGHTGRAY", "CAR_COLOR_WARMGRAY", "CAR_COLOR_JUJUBE", "CAR_COLOR_RED", "CAR_COLOR_BROWN", "CAR_COLOR_CARBONBLACK", "CAR_COLOR_DARKRED", "CAR_COLOR_COPPER", "CAR_COLOR_BLACK", "CAR_COLOR_MOCHA", "CAR_COLOR_ORANGE", "CAR_COLOR_BLUESILVER", "CAR_COLOR_SILVER", "CAR_COLOR_DIMGRAY", "CAR_COLOR_JADEGREEN", "DIVAR_LOGO", "CAR_COLOR_CREAM", "CAR_FRONT_SIDE", "CAR_BACK_SIDE", "CAR_DRIVER_SIDE", "CAR_PASSENGER_SIDE", "CAR_ODOMETER", "CRAFTSMEN", "KITCHEN_UTENSILS", "STOVES_HEATERS_FIREPLACES", "TRAVEL_PACKAGES", "WATER_HEATER_PACKAGE_RADIATOR", "STAIRS", "ACCESSIBILITY", "MAP_VIEW", "THUMB_DOWN", "THUMB_UP", "VIDEOCAM_PLUS", "BADGE", "BADGE_F", "RADIO_BUTTON_UNCHECKED", "POLICE", "SORT_ASCENDING", "BUSINESS_PERSONAL", "BRAND_XTRIM", "BRAND_BESTUNE", "BRAND_GAC", "BRAND_VENUCIA", "BRAND_VGV", "BRAND_ZX_AUTO", "BRAND_QINGLING", "BUSINESS_JOBS", "SHIELD_CHECK_CIRCLE", "SCRIPT_TEXT", "DOT_INDICATOR", "CLOCK", "MAP_MARKER", "TOMAN_SIGN", "CHECK_DECOGRAM", "LADDER", "RUNNING_MAN", "CALENDAR_TEXT", "HOME", "ADMINISTRATIVE_DOC", "ANALOG_WATCH", "ANKLE_BOOTS", "BARTER", "BOOTS", "BRIEFCASE", "CAPACITY", "CARPET_DIMENSIONS", "CHAIRS", "CHANDELIER", "COLOR_BEAKER", "CONDITION", "CONTROLLER", "COSMETICS", "CPU", "DIGITAL_WATCH", "DOOR", "DRESS_SHOES", "ELECTRICAL", "FAKE_BADGE", "FANNY_PACK", "FURNITURE", "FURNITURE_CLASSIC", "FURNITURE_SOFA", "HANDBAG", "HDMI", "HERBAL_PILLS", "HOME_AREA", "INSTALLMENT_SALE", "IRANCELL", "IRAN_MAP", "JEWELRY_ANKLET", "JEWELRY_BRACELET", "JEWELRY_EARRINGS", "JEWELRY_NECKLACE", "JEWELRY_RING", "JEWELRY_SET", "LAN", "LOAFERS", "MAN", "MAN_AND_WOMAN", "MATERIAL", "MCI", "MEDICAL", "MEMORY", "MODEM", "MONEY_BILLS", "NINTENDO", "ORIGINAL_BADGE", "PAPER_DEED", "PARKING_LOT", "PERFUMES", "PLAY_STATION", "RAM", "RECEIVING_HAND", "RIGHTEL", "SANDALS", "SCISSORS", "SCREEN_SIZE", "SHAKING_HANDS", "SHOULDER_BAG", "SIDE_TABLE", "SIM", "SIM_HOLDER", "SKIN_CARE", "SLIPPERS", "SMART_WATCH", "SNEAKERS", "SPEEDOMETER", "SPORT_BAG", "STAIRCASE", "STORAGE", "UMBRELLA", "USB", "WOMAN", "WORLD_MAP", "XBOX", "SHIELD_CHECK", "CAR", "BUILDING", "STOP_WATCH", "CHATBOT", "CHATBOT_OUTLINE", "APARTMENT_RENT", "APARTMENT_SELL", "COMMERCIAL_RENT", "COMMERCIAL_SELL", "HOUSE_VILLA_RENT", "HOUSE_VILLA_SELL", "INDUSTRY_AGRICULTURE_BUSINESS_RENT", "INDUSTRY_AGRICULTURE_BUSINESS_SELL", "OFFICE_RENT", "OFFICE_SELL", "PARTNERSHIP", "PLOT_OLD", "PRESELL", "REAL_ESTATE_SERVICES", "RESIDENTIAL_RENT", "RESIDENTIAL_SELL", "SHOP_RENT", "SHOP_SELL", "SUITE_APARTMENT", "TEMPORARY_RENT", "VILLA", "WORKSPACE", "IMAGE_MULTIPLE", "SHATEL_MOBILE", "MEGAPHONE_F", "MEGAPHONE", "YEKTANET", "TAPSELL", "DAART", "CLOSE_CIRCLE", "CLOSE_CIRCLE_F", "ACCESSORIES", "ACCOUNTING_AND_FINANCE", "ACCOUNTING_FINANCE_LEGAL", "ADMINISTRATION_AND_HR", "AIR_CONDITIONING_FAN_COIL", "ANIMALS", "APPLIANCE", "ARTIFICIAL_FLOWER", "AUDIO_VIDEO", "BABY_AND_TOYS", "BALL_SPORTS", "BARBERSHOP_AND_BEAUTYSALON", "BATCH", "BATHROOMS", "BATHROOM_ACCESSORIES", "BEAUTY_AND_HAIRCARE", "BED_PILLOW_BLANKET", "BED_SERVICE", "BED_SHEET", "BICYCLE", "BIRDS", "BOAT", "BOOKCASE_SHELF", "BOOK_STUDENT_LITERATURE", "BUFFET_SHOWCASES", "BUILDING_EQUIPMENT", "BUS_METRO_TRAIN", "CAFE_AND_RESTAURANT", "CAMERA_CAMCODERS", "CAMPING_OUTDOOR", "CARE_HEALTH_BEAUTY", "CARPET", "CARPET_MOQUETTE", "CARS", "CAR_AND_MOTOR", "CAT", "CATERING", "CCTV", "CHAIR_BENCH", "CHANDELIERS", "CHILDRENS_CLOTHING_AND_SHOE", "CHILDRENS_FURNITURE", "CHILD_CAR_SEAT", "CLASSIC", "CLEANING", "CLEANING_SUPPLIES", "CLOTHES_RACK", "CLOTHING", "CLOTHING_AND_SHOES", "COIN_STAMP", "COMPUTERS", "COMPUTER_AND_IT", "COMPUTER_AND_MOBILE", "CONCERT", "CONFERENCE_MEETING", "CONSTRUCTION_CRAFT", "CONTAINERS", "CONTAINER_ORGANIZERS", "COOKING_UTENSILS", "CRAFTS", "CURTAINS_TABLE_COVER", "DECORATION", "DESK", "DESKTOPS", "DETERGENT_TISSUE", "DINING_TABLE", "DISHWASHER", "DIVING_WATERSPORTS", "DOG", "DRINK_MAKER", "DRUMS_PERCUSSION", "EDUCATION", "EDUCATIONAL", "EVENT", "EVENTS_SPORTS", "FAN_VENTILATOR_HUMIDIFIER", "FARM_ANIMALS", "FIGURINES", "FISH", "FISHING", "FOOD_AND_DRINK", "FOOD_MILL", "FOR_SALE", "FURNITURE_WOOD", "GAME_CONSOLES_AND_VIDEO_GAMES", "GARDEN_AND_LANDSCAPING", "GIFT_CERTIFICATE", "GUITAR_BASS_AMPLIFIER", "HEALTH_BEAUTY", "HEAVY", "HISTORICAL", "HISTORICAL_OBJECTS", "HOBBY_COLLECTIBLES", "HOME_CATERING", "HOME_LIGHTING", "HORSES_EQUESTRIAN", "INDUSTRIAL_MACHINERY", "INDUSTRIAL_TECHNOLOGY", "JANITORIAL_CLEANING", "JEWELRY", "JEWELRY_AND_WATCHES", "JUICERS", "LAMPS", "LAMPSHADE", "LAPTOPS", "LEISURE_HOBBIES_TOYS", "LIGHT", "LITERARY", "LOST_AND_FOUND", "LOST_ANIMALS", "LOST_THINGS", "LUMBAR_PILLOW", "MAGAZINES", "MAT", "MATTRESS", "MEDIA_ADVERTISING", "MEDICAL_EQUIPMENT", "MIRROR", "MOBILE_PHONES", "MOBILE_TABLET", "MOBILE_TABLET_ACCESSORIES", "MODEM_AND_NETWORK_EQUIPMENT", "MOQUETTE", "MOTORCYCLES", "MOVIES_AND_MUSIC", "MP3_PLAYER", "MUSICAL_INSTRUMENTS", "NATURAL_PLANTS", "OFFICES", "OFFICE_DECORATION", "OTHER_APPLIANCES", "OVEN_BAKING_APPLIANCES", "PAINTINGS_PICTURE", "PARTS_ACCESSORIES", "PARTS_AND_ACCESSORIES", "PERSONAL_TOYS", "PHONE_DESK", "PIANO_KEYBOARD", "PICTORIAL_CARPET", "POT_KETTLE", "PRINTER_SCANER_COPIER", "RANGE_HOOD", "REFRIGERATOR_FREEZER", "RELIGIOUS", "RENTAL", "REPTILE", "RESEARCH", "RHINESTONES", "RODENTS_RABBITS", "RUBBER_CARPET", "RUGS_WOOLEN_CLOTH", "SALES_MARKETING", "SEWING_ACCESSORIES", "SEWING_KNITTING", "SEWING_MACHINE", "SHOES_BELT_BAG", "SHOE_RACK_DRAWER", "SHOP_AND_CASH", "SHOP_RESTAURANT", "SIM_CARD", "SLEEP_GOODS", "SPORT", "SPORT_LEISURE", "STATIONERY", "STEAM_IRON", "STEREO_SURROUND", "STROLLERS_AND_ACCESSORIES", "TABLECLOTHS", "TABLET", "TEACHING", "THEATRE_AND_CINEMA", "TICKET", "TICKETS_SPORTS", "TOOLBOX", "TRADITIONAL", "TRAINING", "TRANSPORT", "TRANSPORTATION", "TV_PROJECTOR", "TV_STAND", "VACUUMS_CLEANER", "VENTILATION_COOLING_HEATING", "VIDEO_DVDPLAYER", "VIOLINS", "VOLUNTEERS", "WALL_CLOCK", "WASHING_CLEANING", "WASHING_MACHINES", "WATCHES", "WATER_COOLER", "WATER_COOLER_REFINERY", "WC_ACCESSORIES", "WIND", "WINTER_SPORTS", "WORK_EQUIPMENT", "YARN_LIGHTS", "ARTICLE_MAGNIFIER", "ARTICLE_MAGNIFIER_F", "FOOTNOTE", "SPARKLES_F", "HAND_CLICK", "WHATS_APP", "CHAT_SPARKLES", "PUZZLE_SPARKLES", "AI_STARS", "CRISIS_SUPPORT", "TEMPORARY_SHELTER", "VOLUNTEER_AID", "EMERGENCY_EQUIPMENT", "RIDE_SHARING", "LINK", "BUSINESS_SERVICES", "BELL", "THUMB_DOWN_BORDER", "THUMB_UP_BORDER", "CALL_MADE", "CALL_RECEIVED", "CALL_O", "AI_STARS_F", "CHEVRON_DOWN", "TAG_O", "PHONE_SPARKLES", "PAINT_BRUSH", "VIDEO_LIBRARY", "MAGNIFIER_SPARKLE", "PIN_VARIANT", "MORE_HORIZONTAL_O" ], "type": "string" }, "GetPostPricingResponseRenew": { "properties": { "available": { "description": "نشان می‌دهد که آیا آگهی قابل تمدید است. اگر false باشد، API تمدید خطا برمی‌گرداند", "type": "boolean" }, "cost_rials": { "description": "هزینه تمدید به ریال", "format": "int64", "type": "string" } }, "type": "object" }, "GetPostPricingResponseReorder": { "properties": { "available": { "description": "نشان می‌دهد که آیا آگهی قابل نردبان است. اگر false باشد، API نردبان خطا برمی‌گرداند", "type": "boolean" }, "cost_rials": { "description": "هزینه نردبان به ریال", "format": "int64", "type": "string" } }, "type": "object" }, "GetPostPricingResponseSubmit": { "properties": { "available": { "description": "نشان می‌دهد که آیا آگهی قابل ثبت است. اگر false باشد، API ثبت خطا برمی‌گرداند", "type": "boolean" }, "cost_rials": { "description": "هزینه ثبت آگهی به ریال", "format": "int64", "type": "string" } }, "type": "object" }, "GetPostStatsResponseDailyStats": { "properties": { "count": { "description": "تعداد روزانه آمار (مثلاً بازدید)", "example": 239, "format": "int32", "type": "integer" }, "date": { "description": "تاریخ به فرمت YYYY-MM-DD", "example": "2025-06-03", "type": "string" } }, "type": "object" }, "GetPostStatsResponsePostStats": { "properties": { "daily": { "description": "مقدار روزانه آمار در هفت روز گذشته", "items": { "$ref": "#/components/schemas/GetPostStatsResponseDailyStats" }, "type": "array" }, "total": { "description": "مجموع آمار (مثلاً بازدید)", "example": 239, "format": "int32", "type": "integer" } }, "type": "object" }, "GetServiceTypesResponseServiceTypeData": { "properties": { "display": { "type": "string" }, "slug": { "$ref": "#/components/schemas/appsServiceType" } }, "type": "object" }, "GetUploadURLsV2ResponseUploadFormat": { "properties": { "http_method": { "$ref": "#/components/schemas/open_platformpostHTTPMethod" }, "url": { "type": "string" } }, "type": "object" }, "ImageCarouselRowImageItem": { "properties": { "description": { "type": "string" }, "image_id": { "type": "string" } }, "type": "object" }, "MessageContactData": { "properties": { "name": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" }, "MessageFileData": { "properties": { "link": { "type": "string" }, "name": { "type": "string" }, "size_bytes": { "format": "uint64", "type": "string" } }, "type": "object" }, "MessageImageData": { "properties": { "height_px": { "format": "int64", "type": "integer" }, "link": { "type": "string" }, "size_bytes": { "format": "uint64", "type": "string" }, "width_px": { "format": "int64", "type": "integer" } }, "type": "object" }, "MessageLocationData": { "properties": { "latitude": { "description": "عرض جغرافیایی به درجه. باید در محدوده [-90.0, +90.0] باشد.", "format": "double", "type": "number" }, "longitude": { "description": "طول جغرافیایی به درجه. باید در محدوده [-180.0, +180.0] باشد.", "format": "double", "type": "number" } }, "type": "object" }, "MessageSender": { "properties": { "side": { "$ref": "#/components/schemas/chatapiMessageSenderSide" }, "type": { "$ref": "#/components/schemas/chatapiMessageSenderType" } }, "type": "object" }, "MessageVideoData": { "properties": { "link": { "type": "string" }, "size_bytes": { "format": "uint64", "type": "string" }, "thumbnail_link": { "type": "string" } }, "type": "object" }, "MessageVoiceData": { "properties": { "link": { "type": "string" }, "size_bytes": { "format": "uint64", "type": "string" } }, "type": "object" }, "OAuthScopeScope": { "enum": [ "POST_ADDON_CREATE", "USER_PHONE", "USER_ID", "USER_ADDON_CREATE", "CHAT_MESSAGE_SEND", "CHAT_CONVERSATION_READ", "USER_POSTS_GET", "USER_POSTS_STATS_READ", "CHAT_POST_CONVERSATIONS_READ", "CHAT_POST_CONVERSATIONS_MESSAGE_SEND", "CHAT_SUPPLIER_ALL_CONVERSATIONS_READ", "CHAT_SUPPLIER_ALL_CONVERSATIONS_MESSAGE_SEND", "CHAT_BOT_USER_MESSAGE_SEND", "USER_VERIFICATION_CREATE", "OFFLINE_ACCESS", "OPENID", "PAYMENT_ALL_POSTS_PRICING_READ", "PAYMENT_ALL_POSTS_REORDER", "PAYMENT_ALL_POSTS_RENEW", "MANAGEMENT_APPS_READ", "MANAGEMENT_APPS_WRITE", "POST_ONGOING_IMAGES_GET", "USER_POSTS_ADDON_CREATE", "POST_EDIT", "CONVERSATION_SEND_MESSAGE", "BUSINESS_ADDON_CREATE", "POST_SEMANTIC_CREATE", "NOTIFICATION_ACCESS_REVOCATION", "SEND_EVENT", "CREATE_WALLET_PAYMENT", "SUBMIT_USER_POST", "SUBMIT_USER_PAYMENT", "USER_SET_CUSTOMIZED_BUTTON", "BUSINESS_CREATE_CUSTOMIZED_BUTTON", "DELETE_USER_POST", "EDIT_USER_POST", "USER_BUSINESSES_READ" ], "type": "string" }, "PaymentPublishUserPostBody": { "properties": { "extra_details": { "description": "اطلاعات تکمیلی که می‌خواهید به کنار ارسال کنید. این فیلد اختیاری است و برای رفع مغایرت‌های احتمالی در تراکنش کاربرد دارد.", "type": "string" }, "id": { "description": "یک UUID نسخه ۴ که باید برای هر پرداخت یکتا باشد. این UUID باید در سمت شما ساخته شده و در درخواست ارسال شود. اگر id ارسال‌شده قبلاً تراکنش موفق یا نیمه‌موفقی در کنار داشته باشد، خطا دریافت می‌کنید.", "type": "string" } }, "type": "object" }, "PaymentRenewPostBody": { "properties": { "extra_details": { "description": "اطلاعات تکمیلی که می‌خواهید به کنار ارسال کنید. این فیلد اختیاری است و برای رفع مغایرت‌های احتمالی در تراکنش کاربرد دارد.", "type": "string" }, "id": { "description": "یک UUID نسخه ۴ که باید برای هر پرداخت یکتا باشد. این UUID باید در سمت شما ساخته شده و در درخواست ارسال شود. اگر id ارسال‌شده قبلاً تراکنش موفق یا نیمه‌موفقی در کنار داشته باشد، خطا دریافت می‌کنید.", "type": "string" } }, "type": "object" }, "PaymentReorderPostBody": { "properties": { "extra_details": { "description": "اطلاعات تکمیلی که می‌خواهید به کنار ارسال کنید. این فیلد اختیاری است و برای رفع مغایرت‌های احتمالی در تراکنش کاربرد دارد.", "type": "string" }, "id": { "description": "یک UUID نسخه ۴ که باید برای هر پرداخت یکتا باشد. این UUID باید در سمت شما ساخته شده و در درخواست ارسال شود. اگر id ارسال‌شده قبلاً تراکنش موفق یا نیمه‌موفقی در کنار داشته باشد، خطا دریافت می‌کنید.", "type": "string" } }, "type": "object" }, "PostCreateBusinessCustomizedButtonBody": { "properties": { "customized_button": { "$ref": "#/components/schemas/postCustomizedButton" } }, "required": [ "customized_button" ], "type": "object" }, "PostEditPostBody": { "properties": { "description": { "type": "string" }, "image_paths": { "items": { "type": "string" }, "type": "array" }, "title": { "type": "string" } }, "required": [ "title", "description" ], "type": "object" }, "PostEditPostV2Body": { "properties": { "category_data": { "description": "فیلدهای مختص دسته‌بندی که باید مطابق schema تکمیل شوند. schema را اینجا ببینید: https://kenar.divar.dev/openapi-doc/assets-get-submit-schema/", "type": "object" }, "general_data": { "$ref": "#/components/schemas/postPostGeneralData" }, "update_mask": { "description": "مشخص می‌کند کدام فیلدها به‌روزرسانی شوند. از مسیرهای تودرتو مانند 'general_data.title' یا 'category_data.price' استفاده کنید. این کار تمایز بین پاک کردن یک فیلد و تغییر ندادن آن را ممکن می‌سازد.", "example": [ "general_data.title", "general_data.description", "general_data.video", "category_data.price" ], "items": { "type": "string" }, "type": "array" } }, "required": [ "update_mask" ], "type": "object" }, "PostGeneralDataPostVideo": { "properties": { "duration": { "description": "زمان ویدیو به ثانیه", "example": 34, "format": "uint64", "type": "string" }, "name": { "description": "نام ویدیو (از فیلد `video_name` در پاسخ آپلود)", "example": "raw/4786eb10-eac6-4077-b622-78c1c42855c7.mp4", "type": "string" }, "thumbnail_name": { "description": "کاور ویدیو (از فیلد `thumbnail_name` در پاسخ آپلود). فریم اول ویدیوی آپلود‌شده است.", "example": "thumbnail/4786eb10-eac6-4077-b622-78c1c42855c7.jpg", "type": "string" } }, "required": [ "name", "thumbnail_name", "duration" ], "type": "object" }, "PostSetPostCustomizedButtonBody": { "properties": { "customized_button": { "$ref": "#/components/schemas/postCustomizedButton" } }, "required": [ "customized_button" ], "type": "object" }, "PremiumPanelBusinessDataSubBusinessType": { "enum": [ "CAR", "REAL_ESTATE", "JOBS", "MARKETPLACE", "SERVICES", "PERSONAL" ], "type": "string" }, "SearchPostItemCommunityFields": { "type": "object" }, "SearchPostItemElectronicDevicesFields": { "type": "object" }, "SearchPostItemHomeKitchenFields": { "type": "object" }, "SearchPostItemJobsFields": { "type": "object" }, "SearchPostItemLeisureHobbiesFields": { "type": "object" }, "SearchPostItemPersonalGoodsFields": { "type": "object" }, "SearchPostItemPrice": { "properties": { "mode": { "type": "string" }, "value": { "format": "uint64", "type": "string" } }, "type": "object" }, "SearchPostItemRealEstateFields": { "properties": { "credit": { "$ref": "#/components/schemas/SearchPostItemPrice" }, "daily_rent": { "format": "uint64", "type": "string" }, "floor": { "format": "int32", "type": "integer" }, "has_elevator": { "type": "boolean" }, "has_parking": { "type": "boolean" }, "rent": { "$ref": "#/components/schemas/SearchPostItemPrice" }, "rooms": { "type": "string" }, "size": { "format": "int32", "type": "integer" }, "year": { "format": "int64", "type": "integer" } }, "type": "object" }, "SearchPostItemToolsMaterialsEquipmentFields": { "type": "object" }, "SearchPostItemVehiclesFields": { "properties": { "custom_post_subtitle": { "type": "string" }, "installment_sale": { "type": "string" }, "usage": { "format": "uint64", "type": "string" } }, "type": "object" }, "SemanticCreatePostSemanticBody": { "properties": { "cost": { "description": "هزینه مرتبط با عملیات", "format": "int32", "type": "integer" }, "semantic": { "additionalProperties": { "type": "string" }, "description": "مپ key-value اطلاعات معنایی برای ذخیره", "type": "object" }, "ticket_uuid": { "description": "UUID تیکت پرداخت (اختیاری)", "type": "string" } }, "required": [ "semantic" ], "type": "object" }, "SemanticCreateUserSemanticBody": { "properties": { "cost": { "description": "هزینه مرتبط با عملیات", "format": "int32", "type": "integer" }, "phone": { "description": "شماره موبایل کاربر", "type": "string" }, "semantic": { "additionalProperties": { "type": "string" }, "description": "مپ key-value اطلاعات معنایی برای ذخیره", "type": "object" }, "ticket_uuid": { "description": "UUID تیکت پرداخت (اختیاری)", "type": "string" } }, "required": [ "phone", "semantic" ], "type": "object" }, "addonsAction": { "description": "نمایانگر یک Action که می‌تواند انجام شود", "properties": { "get_dynamic_action": { "$ref": "#/components/schemas/addonsGetDynamicAction" }, "open_direct_link": { "description": "عملیاتی برای هدایت مستقیم کاربر به URL شما (در صورت وجود resource id)", "example": "https://your-site.com/some-path", "type": "string" }, "open_post_manage_page": { "$ref": "#/components/schemas/addonsOpenPostManagePage" }, "open_post_page": { "$ref": "#/components/schemas/addonsOpenPostPage" }, "open_server_link": { "$ref": "#/components/schemas/addonsOpenServerLink" } }, "title": "عملیات", "type": "object" }, "addonsAddonLinkage": { "enum": [ "POST_DETAILS", "POST_MANAGEMENT" ], "type": "string" }, "addonsAddonMetaData": { "properties": { "app": { "$ref": "#/components/schemas/appsApp" }, "created_at": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "last_modified": { "format": "date-time", "type": "string" }, "service_tags": { "items": { "$ref": "#/components/schemas/appsServiceTag" }, "type": "array" }, "status": { "$ref": "#/components/schemas/addonsStatus" } }, "type": "object" }, "addonsAddonSecondaryLinkage": { "properties": { "position": { "$ref": "#/components/schemas/addonsAddonSecondaryLinkagePosition" }, "widgets": { "$ref": "#/components/schemas/addonsWidgets" } }, "type": "object" }, "addonsAddonSecondaryLinkagePosition": { "enum": [ "POST_SPEC_HEAD", "POST_SPEC_TAIL", "POST_PRICE_SPEC", "POST_DESC_TAIL" ], "type": "string" }, "addonsAddonSecondaryLinks": { "properties": { "secondary_linkages": { "items": { "$ref": "#/components/schemas/addonsAddonSecondaryLinkage" }, "type": "array" } }, "type": "object" }, "addonsAddonSelector": { "properties": { "brand_models": { "items": { "type": "string" }, "type": "array" }, "categories": { "items": { "type": "string" }, "type": "array" }, "cities": { "items": { "type": "string" }, "type": "array" }, "districts": { "items": { "type": "string" }, "type": "array" }, "tokens": { "items": { "type": "string" }, "title": "(OR) آگهی انتخاب می‌شود اگر آرایه زیر شامل فیلد مربوطه باشد", "type": "array" } }, "title": "(AND) آگهی توسط این انتخابگر انتخاب می‌شود اگر تمام شرایط زیر\nبرقرار باشند", "type": "object" }, "addonsAddonSemantic": { "description": "پیام استخراج‌شده توسط OpenPlatform از semantic ارائه‌دهنده سرویس.\nراهنما:\n- قبل از افزودن enum جدید، بررسی کنید که آیا مقدار مناسبی وجود دارد.\n- مقدار صفر هر enum باید {ENUM_NAME}_UNSPECIFIED باشد.\n- مقادیر Enum نباید مختص آگهی یا شخص خاصی باشند.", "properties": { "car_verification_failure_reason": { "$ref": "#/components/schemas/AddonSemanticCarVerificationStage" }, "car_verification_last_successful_stage": { "$ref": "#/components/schemas/AddonSemanticCarVerificationStage" }, "identity_verification_failure_reason": { "$ref": "#/components/schemas/AddonSemanticIdentityVerificationStage" }, "identity_verification_last_successful_stage": { "$ref": "#/components/schemas/AddonSemanticIdentityVerificationStage" }, "identity_verification_result": { "$ref": "#/components/schemas/AddonSemanticIdentityVerificationResult" }, "inspection_result": { "$ref": "#/components/schemas/AddonSemanticInspectionResult" }, "new_face_verification_result": { "$ref": "#/components/schemas/AddonSemanticNewFaceVerificationResult" }, "online_reservation_capability": { "$ref": "#/components/schemas/AddonSemanticOnlineReservationCapability" }, "ownership_result": { "$ref": "#/components/schemas/AddonSemanticOwnershipResult" }, "payment_method": { "$ref": "#/components/schemas/addonsAddonSemanticPaymentMethod" }, "post_verification_result": { "$ref": "#/components/schemas/AddonSemanticPostVerificationResult" }, "status": { "$ref": "#/components/schemas/addonsAddonSemanticStatus" } }, "type": "object" }, "addonsAddonSemanticPaymentMethod": { "enum": [ "SECURE" ], "title": "- SECURE: این مقدار منجر به نشان در تطبیق می‌شود", "type": "string" }, "addonsAddonSemanticStatus": { "enum": [ "SUCCEEDED", "FAILED", "EXPIRED", "PENDING" ], "type": "string" }, "addonsBackFillBusinessAddonResponse": { "type": "object" }, "addonsBusinessAddon": { "properties": { "business_ref": { "type": "string" }, "meta_data": { "$ref": "#/components/schemas/addonsAddonMetaData" }, "widgets": { "$ref": "#/components/schemas/addonsWidgets" } }, "type": "object" }, "addonsButtonBar": { "properties": { "action": { "$ref": "#/components/schemas/addonsAction" }, "title": { "type": "string" } }, "type": "object" }, "addonsCreateBusinessAddonResponse": { "properties": { "id": { "type": "string" } }, "type": "object" }, "addonsCreatePostAddonRequest": { "properties": { "link_in_spec": { "type": "string" }, "notes": { "title": "داده‌های دلخواه ارائه شده توسط سازنده افزونه", "type": "string" }, "selector": { "$ref": "#/components/schemas/addonsAddonSelector" }, "semantic": { "additionalProperties": { "type": "string" }, "type": "object" }, "semantic_sensitives": { "items": { "type": "string" }, "type": "array" }, "token": { "type": "string" }, "widgets": { "$ref": "#/components/schemas/addonsWidgets" } }, "type": "object" }, "addonsCreatePostAddonResponseV2": { "type": "object" }, "addonsCreateUserAddonResponseV2": { "properties": { "id": { "type": "string" } }, "type": "object" }, "addonsDescriptionRow": { "properties": { "expandable": { "type": "boolean" }, "has_divider": { "type": "boolean" }, "text": { "type": "string" } }, "type": "object" }, "addonsEvaluationRow": { "properties": { "icon_name": { "$ref": "#/components/schemas/DivarIconsIconName" }, "indicator_percentage": { "format": "int32", "type": "integer" }, "indicator_text": { "type": "string" }, "left": { "$ref": "#/components/schemas/addonsEvaluationRowSection" }, "middle": { "$ref": "#/components/schemas/addonsEvaluationRowSection" }, "right": { "$ref": "#/components/schemas/addonsEvaluationRowSection" } }, "type": "object" }, "addonsEvaluationRowSection": { "properties": { "section_color": { "$ref": "#/components/schemas/addonsWidgetColor" }, "text": { "type": "string" } }, "type": "object" }, "addonsEventRow": { "properties": { "has_divider": { "type": "boolean" }, "icon_name": { "$ref": "#/components/schemas/DivarIconsIconName" }, "image_id": { "type": "string" }, "label": { "type": "string" }, "subtitle": { "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "addonsGetBusinessAddonsResponse": { "properties": { "addons": { "items": { "$ref": "#/components/schemas/addonsBusinessAddon" }, "type": "array" } }, "type": "object" }, "addonsGetDynamicAction": { "description": "نمایانگر یک Action پویا که می‌تواند در دستگاه کاربر دریافت و اجرا شود", "properties": { "data": { "description": "داده‌ای که می‌توانید مقداردهی کنید و هنگام کلیک کاربر به شما برگردانده می‌شود", "example": { "your-internal-id": "something" }, "type": "object" } }, "title": "دریافت Action پویا", "type": "object" }, "addonsGetPostAddonsResponse": { "properties": { "addons": { "items": { "$ref": "#/components/schemas/addonsPostAddon" }, "type": "array" } }, "type": "object" }, "addonsGetUserAddonsResponse": { "properties": { "user_addons": { "items": { "$ref": "#/components/schemas/addonsUserAddon" }, "type": "array" } }, "type": "object" }, "addonsGetUserPostAddonsResponse": { "properties": { "addons": { "items": { "$ref": "#/components/schemas/addonsPostAddon" }, "type": "array" } }, "type": "object" }, "addonsGroupInfoRow": { "properties": { "has_divider": { "type": "boolean" }, "items": { "items": { "$ref": "#/components/schemas/addonsGroupInfoRowGroupInfoItem" }, "type": "array" } }, "type": "object" }, "addonsGroupInfoRowGroupInfoItem": { "properties": { "title": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "addonsImageCarouselRow": { "properties": { "has_divider": { "type": "boolean" }, "items": { "items": { "$ref": "#/components/schemas/ImageCarouselRowImageItem" }, "type": "array" } }, "type": "object" }, "addonsOpenPostManagePage": { "description": "عملیاتی برای باز کردن صفحه مدیریت آگهی در اپلیکیشن", "properties": { "post_token": { "description": "توکن آگهی برای هدایت به صفحه مدیریت آن", "example": "AJIEWcw", "type": "string" } }, "required": [ "post_token" ], "title": "باز کردن صفحه مدیریت آگهی", "type": "object" }, "addonsOpenPostPage": { "description": "عملیاتی برای باز کردن صفحه آگهی در اپلیکیشن", "properties": { "post_token": { "description": "توکن آگهی برای باز کردن", "example": "AJIEWcw", "type": "string" } }, "required": [ "post_token" ], "title": "باز کردن صفحه آگهی", "type": "object" }, "addonsOpenServerLink": { "description": "عملیاتی برای ارسال داده‌های کامل session و دریافت آدرس redirect از سرور شما", "properties": { "data": { "description": "داده‌ای که می‌توانید مقداردهی کنید و هنگام کلیک کاربر به شما برگردانده می‌شود", "example": { "your-internal-id": "something" }, "type": "object" } }, "title": "باز کردن لینک سرور", "type": "object" }, "addonsPostAddon": { "properties": { "app": { "$ref": "#/components/schemas/appsApp" }, "linkage": { "$ref": "#/components/schemas/addonsAddonLinkage" }, "meta_data": { "$ref": "#/components/schemas/addonsAddonMetaData" }, "score": { "format": "int64", "type": "string" }, "secondary_links": { "$ref": "#/components/schemas/addonsAddonSecondaryLinks" }, "selector": { "$ref": "#/components/schemas/addonsAddonSelector" }, "semantic": { "additionalProperties": { "type": "string" }, "title": "منسوخ شده", "type": "object" }, "semantic_data": { "$ref": "#/components/schemas/addonsAddonSemantic" }, "semantic_sensitives": { "items": { "type": "string" }, "title": "منسوخ شده", "type": "array" }, "sensitive_semantic": { "additionalProperties": { "type": "string" }, "type": "object" }, "token": { "type": "string" }, "widgets": { "$ref": "#/components/schemas/addonsWidgets" }, "widgets_semantic": { "type": "object" } }, "type": "object" }, "addonsScoreRow": { "properties": { "action": { "$ref": "#/components/schemas/addonsAction" }, "descriptive_score": { "type": "string" }, "has_divider": { "type": "boolean" }, "icon_name": { "$ref": "#/components/schemas/DivarIconsIconName" }, "percentage_score": { "format": "int32", "type": "integer" }, "score_color": { "$ref": "#/components/schemas/addonsWidgetColor" }, "title": { "type": "string" } }, "type": "object" }, "addonsSelectorRow": { "properties": { "action": { "$ref": "#/components/schemas/addonsAction" }, "has_divider": { "type": "boolean" }, "icon_name": { "$ref": "#/components/schemas/DivarIconsIconName" }, "image_id": { "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "addonsSendAddonDeletionEventsResponse": { "type": "object" }, "addonsStatus": { "enum": [ "ACTIVE", "HIDDEN", "DELETED" ], "type": "string" }, "addonsSubtitleRow": { "properties": { "has_divider": { "type": "boolean" }, "text": { "type": "string" } }, "type": "object" }, "addonsTitleRow": { "properties": { "has_divider": { "type": "boolean" }, "text": { "type": "string" } }, "type": "object" }, "addonsUserAddon": { "properties": { "divar_user_id": { "type": "string" }, "filters": { "$ref": "#/components/schemas/addonsUserAddonFilters" }, "meta_data": { "$ref": "#/components/schemas/addonsAddonMetaData" }, "phone": { "title": "منسوخ شده. از divar_user_id استفاده کنید", "type": "string" }, "semantic": { "additionalProperties": { "type": "string" }, "title": "منسوخ شده", "type": "object" }, "semantic_data": { "$ref": "#/components/schemas/addonsAddonSemantic" }, "sensitive_semantic": { "additionalProperties": { "type": "string" }, "type": "object" }, "widgets": { "$ref": "#/components/schemas/addonsWidgets" }, "widgets_semantic": { "type": "object" } }, "type": "object" }, "addonsUserAddonFilters": { "properties": { "categories": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "addonsWidget": { "properties": { "button_bar": { "$ref": "#/components/schemas/addonsButtonBar" }, "description_row": { "$ref": "#/components/schemas/addonsDescriptionRow" }, "evaluation_row": { "$ref": "#/components/schemas/addonsEvaluationRow" }, "event_row": { "$ref": "#/components/schemas/addonsEventRow" }, "group_info_row": { "$ref": "#/components/schemas/addonsGroupInfoRow" }, "image_carousel_row": { "$ref": "#/components/schemas/addonsImageCarouselRow" }, "score_row": { "$ref": "#/components/schemas/addonsScoreRow" }, "selector_row": { "$ref": "#/components/schemas/addonsSelectorRow" }, "semantic_paths": { "additionalProperties": { "type": "string" }, "type": "object" }, "subtitle_row": { "$ref": "#/components/schemas/addonsSubtitleRow" }, "title_row": { "$ref": "#/components/schemas/addonsTitleRow" } }, "type": "object" }, "addonsWidgetColor": { "enum": [ "WARNING_SECONDARY", "WARNING_PRIMARY", "ERROR_PRIMARY", "SUCCESS_PRIMARY", "SUCCESS_SECONDARY" ], "type": "string" }, "addonsWidgets": { "type": "object" }, "appsApp": { "properties": { "avatar": { "type": "string" }, "display": { "type": "string" }, "divar_identification_key": { "type": "string" }, "service_tags": { "items": { "$ref": "#/components/schemas/appsServiceTag" }, "title": "منسوخ شده - از AddonMetaData.service_tags استفاده کنید", "type": "array" }, "service_type": { "$ref": "#/components/schemas/appsServiceType" }, "slug": { "type": "string" }, "status": { "$ref": "#/components/schemas/appsAppStatus" } }, "type": "object" }, "appsAppStatus": { "properties": { "status": { "$ref": "#/components/schemas/appsAppStatusStatus" } }, "type": "object" }, "appsAppStatusStatus": { "enum": [ "ACTIVE", "INACTIVE", "SUSPENDED", "DEVELOPMENT" ], "type": "string" }, "appsServiceTag": { "enum": [ "VERIFIED", "IDENTITY_VERIFIED", "POST_VERIFIED", "SECURE_PAYMENT", "POST_OWNERSHIP_VERIFIED", "EXPERT_INSPECTED", "CAR_EXPERT_INSPECTED", "HOME_EXPERT_INSPECTED", "MOBILE_EXPERT_INSPECTED", "ONLINE_RESERVATION" ], "type": "string" }, "appsServiceType": { "enum": [ "FUNC_CLICK_AND_COLLECT", "FUNC_DELIVERY", "FUNC_SECURE_PAYMENT", "LEAD_GEN_PURE", "LEAD_GEN_LOAN", "REPORT_INSPECTION", "REPORT_PRICE_EVALUATION", "REPORT_VERIFICATION", "FUNC_CONTRACT", "FUNC_FINANCING", "USER_FACE_ID_VERIFICATION", "POST_VERIFICATION", "INTERNAL", "USER_BACKGROUND_VERIFICATION", "USER_BUSINESS_VERIFICATION", "CHARITY", "SECURE_PAYMENT_POST_PROMOTION", "PHOTOGRAPHY", "DOWNLOADABLE_CONTENT_GENERATION", "REPORT_INSPECTION_CHAT", "ADDITIONAL_INFORMATION", "ACCOUNTING", "ASSISTANT", "ADVERTISEMENT", "CONTRACT_POST", "SITE_BUILDER", "FORM_BUILDER", "AUCTION", "POST_DETAIL_ENHANCER", "POST_REORDER" ], "type": "string" }, "assetsEnumOption": { "properties": { "display": { "type": "string" }, "slug": { "type": "string" } }, "type": "object" }, "assetsGetBodyStatusesResponse": { "properties": { "body_status": { "items": { "$ref": "#/components/schemas/assetsEnumOption" }, "type": "array" } }, "type": "object" }, "assetsGetBrandModelsResponse": { "properties": { "brand_models": { "items": { "$ref": "#/components/schemas/assetsEnumOption" }, "type": "array" } }, "type": "object" }, "assetsGetCategoriesResponse": { "properties": { "categories": { "items": { "$ref": "#/components/schemas/assetsEnumOption" }, "type": "array" } }, "type": "object" }, "assetsGetCitiesResponse": { "properties": { "cities": { "items": { "$ref": "#/components/schemas/assetsEnumOption" }, "type": "array" } }, "type": "object" }, "assetsGetColorsResponse": { "properties": { "colors": { "items": { "$ref": "#/components/schemas/assetsEnumOption" }, "type": "array" } }, "type": "object" }, "assetsGetDistrictsResponse": { "properties": { "districts": { "items": { "$ref": "#/components/schemas/assetsEnumOption" }, "type": "array" } }, "type": "object" }, "assetsGetInternalStoragesResponse": { "properties": { "internal_storages": { "items": { "$ref": "#/components/schemas/assetsEnumOption" }, "type": "array" } }, "type": "object" }, "assetsGetOAuthScopesResponse": { "properties": { "scopes": { "items": { "$ref": "#/components/schemas/assetsGetOAuthScopesResponseAppOauthScope" }, "type": "array" } }, "type": "object" }, "assetsGetOAuthScopesResponseAppOauthScope": { "properties": { "description": { "type": "string" }, "display": { "type": "string" }, "lifecycle_state": { "$ref": "#/components/schemas/assetsGetOAuthScopesResponseLifeCycleState" }, "slug": { "$ref": "#/components/schemas/OAuthScopeScope" } }, "type": "object" }, "assetsGetOAuthScopesResponseLifeCycleState": { "enum": [ "EXPERIMENTAL", "ACTIVE", "DEPRECATING_SOON", "DEPRECATED" ], "type": "string" }, "assetsGetPermissionsResponse": { "properties": { "permissions": { "items": { "$ref": "#/components/schemas/assetsGetPermissionsResponsePermission" }, "type": "array" } }, "type": "object" }, "assetsGetPermissionsResponseLifeCycleState": { "enum": [ "EXPERIMENTAL", "ACTIVE", "DEPRECATING_SOON", "DEPRECATED" ], "type": "string" }, "assetsGetPermissionsResponsePermission": { "properties": { "description": { "type": "string" }, "display": { "type": "string" }, "lifecycle_state": { "$ref": "#/components/schemas/assetsGetPermissionsResponseLifeCycleState" }, "slug": { "type": "string" } }, "type": "object" }, "assetsGetRamMemoriesResponse": { "properties": { "ram_memories": { "items": { "$ref": "#/components/schemas/assetsEnumOption" }, "type": "array" } }, "type": "object" }, "assetsGetServiceTypesResponse": { "properties": { "service_types": { "items": { "$ref": "#/components/schemas/GetServiceTypesResponseServiceTypeData" }, "type": "array" } }, "type": "object" }, "assetsGetSubmitSchemaResponse": { "properties": { "schema": { "type": "object" } }, "type": "object" }, "authorizationAPICallerInfo": { "properties": { "api_key_id": { "format": "int32", "type": "integer" }, "api_key_id_v2": { "type": "string" }, "app": { "$ref": "#/components/schemas/appsApp" }, "scopes": { "items": { "$ref": "#/components/schemas/authorizationOAuthScope" }, "type": "array" } }, "type": "object" }, "authorizationOAuthScope": { "properties": { "resource_id": { "type": "string" }, "scope": { "$ref": "#/components/schemas/OAuthScopeScope" } }, "title": "OAuth اسکوپ استاندارد با فرمت `PERMISSION_ENUM__{resource_id}`.\nمثال: EDIT_POST__AZrOi1eL", "type": "object" }, "baseBusinessType": { "enum": [ "REAL_ESTATE_BUSINESS", "CAR_BUSINESS", "MARKETPLACE_BUSINESS", "CAR_CONCIERGE_SALE", "PERSONAL", "JOBS_BUSINESS", "PREMIUM_PANEL" ], "type": "string" }, "chatapiChatBotSendMessageResponse": { "properties": { "conversation_id": { "description": "شناسه مکالمه ایجاد شده یا به‌روزرسانی شده", "example": "conv_123456", "readOnly": true, "type": "string" } }, "type": "object" }, "chatapiChatButton": { "properties": { "action": { "$ref": "#/components/schemas/addonsAction" }, "caption": { "type": "string" }, "icon": { "$ref": "#/components/schemas/DivarIconsIconName" }, "icon_name": { "title": "منسوخ شده", "type": "string" } }, "type": "object" }, "chatapiChatButtonGrid": { "properties": { "rows": { "items": { "$ref": "#/components/schemas/chatapiChatButtonRow" }, "type": "array" } }, "type": "object" }, "chatapiChatButtonRow": { "properties": { "buttons": { "items": { "$ref": "#/components/schemas/chatapiChatButton" }, "type": "array" } }, "type": "object" }, "chatapiConversation": { "properties": { "id": { "type": "string" }, "post_token": { "type": "string" }, "type": { "$ref": "#/components/schemas/chatapiConversationType" } }, "type": "object" }, "chatapiConversationSendMessageResponse": { "properties": { "message": { "type": "string" }, "status": { "format": "int32", "type": "integer" } }, "type": "object" }, "chatapiConversationType": { "enum": [ "POST", "BOT" ], "type": "string" }, "chatapiGenerateUploadTokenRequest": { "type": "object" }, "chatapiGenerateUploadTokenResponse": { "properties": { "token": { "description": "توکن با کدگذاری base64 که می‌توان در endpoint آپلود از آن استفاده کرد", "example": "some_random_base64", "readOnly": true, "type": "string" } }, "type": "object" }, "chatapiGetConversationResponse": { "properties": { "conversation": { "$ref": "#/components/schemas/chatapiConversation" }, "messages": { "description": "فهرست پیام‌های مکالمه", "items": { "$ref": "#/components/schemas/chatapiMessage" }, "type": "array" } }, "required": [ "conversation", "messages" ], "type": "object" }, "chatapiMessage": { "properties": { "contact_data": { "$ref": "#/components/schemas/MessageContactData" }, "conversation": { "$ref": "#/components/schemas/chatapiConversation" }, "file_data": { "$ref": "#/components/schemas/MessageFileData" }, "id": { "type": "string" }, "image_data": { "$ref": "#/components/schemas/MessageImageData" }, "location_data": { "$ref": "#/components/schemas/MessageLocationData" }, "sender": { "$ref": "#/components/schemas/MessageSender" }, "sent_at": { "format": "date-time", "type": "string" }, "text": { "type": "string" }, "type": { "$ref": "#/components/schemas/chatapiMessageType" }, "video_data": { "$ref": "#/components/schemas/MessageVideoData" }, "voice_data": { "$ref": "#/components/schemas/MessageVoiceData" } }, "type": "object" }, "chatapiMessageSenderSide": { "enum": [ "BUYER", "SELLER" ], "type": "string" }, "chatapiMessageSenderType": { "enum": [ "HUMAN", "BOT" ], "type": "string" }, "chatapiMessageType": { "enum": [ "TEXT", "IMAGE", "FILE", "VOICE", "LOCATION", "VIDEO", "CONTACT" ], "type": "string" }, "eventsRegisterEventSubscriptionRequest": { "properties": { "event_resource_id": { "type": "string" }, "event_type": { "$ref": "#/components/schemas/eventsRegisterEventSubscriptionRequestEventType" }, "metadata": { "type": "object" } }, "type": "object" }, "eventsRegisterEventSubscriptionRequestEventType": { "enum": [ "NEW_MESSAGE_ON_POST", "POST_UPDATE" ], "type": "string" }, "eventsRegisterEventSubscriptionResponse": { "type": "object" }, "finderGetAllDevelopmentPostsResponse": { "properties": { "development_posts": { "items": { "$ref": "#/components/schemas/managementDevelopmentPost" }, "type": "array" } }, "type": "object" }, "finderGetPostResponse": { "properties": { "business_data": { "$ref": "#/components/schemas/finderGetPostResponseBusinessData" }, "category": { "type": "string" }, "chat_enabled": { "type": "boolean" }, "city": { "type": "string" }, "data": { "type": "object" }, "district": { "type": "string" }, "first_published_at": { "format": "date-time", "type": "string" }, "is_phone_hidden": { "title": "این فیلد فقط در درخواست‌های webhook در دسترس است", "type": "boolean" }, "last_modified_at": { "format": "date-time", "type": "string" }, "state": { "$ref": "#/components/schemas/finderPostExtState" }, "supplier_chat_assistant_enabled": { "type": "boolean" }, "token": { "type": "string" } }, "type": "object" }, "finderGetPostResponseBusinessData": { "properties": { "business_name": { "type": "string" }, "business_type": { "$ref": "#/components/schemas/PremiumPanelBusinessDataSubBusinessType" } }, "type": "object" }, "finderGetUserBusinessesResponse": { "properties": { "businesses": { "description": "فهرست کسب‌وکارهای مرتبط با کاربر احراز هویت شده", "items": { "$ref": "#/components/schemas/finderGetUserBusinessesResponseBusiness" }, "type": "array" } }, "type": "object" }, "finderGetUserBusinessesResponseBusiness": { "properties": { "brand_description": { "description": "توضیحات کسب‌وکار", "example": "Business description", "type": "string" }, "brand_name": { "description": "نام کسب‌وکار/برند", "example": "My Business", "type": "string" }, "business_token": { "description": "شناسه توکن کسب‌وکار", "example": "xYzAbC123", "type": "string" }, "business_type": { "$ref": "#/components/schemas/baseBusinessType" }, "user_role": { "$ref": "#/components/schemas/premium_panelUserRole" } }, "type": "object" }, "finderGetUserIDByPhoneRequest": { "properties": { "phone": { "type": "string" } }, "type": "object" }, "finderGetUserIDByPhoneResponse": { "properties": { "user_id": { "type": "string" } }, "type": "object" }, "finderGetUserPostsResponse": { "properties": { "posts": { "items": { "$ref": "#/components/schemas/finderGetUserPostsResponsePost" }, "type": "array" } }, "type": "object" }, "finderGetUserPostsResponsePost": { "properties": { "category": { "type": "string" }, "images": { "items": { "type": "string" }, "type": "array" }, "is_phone_hidden": { "type": "boolean" }, "title": { "type": "string" }, "token": { "type": "string" } }, "type": "object" }, "finderGetUserRequest": { "type": "object" }, "finderPostExtState": { "enum": [ "PUBLISHED", "REVIEW_REQ", "PAYMENT_REQ", "RETIRED" ], "type": "string" }, "finderSearchPostItem": { "properties": { "category": { "type": "string" }, "city": { "type": "string" }, "community_fields": { "$ref": "#/components/schemas/SearchPostItemCommunityFields" }, "electronic_devices_fields": { "$ref": "#/components/schemas/SearchPostItemElectronicDevicesFields" }, "home_kitchen_fields": { "$ref": "#/components/schemas/SearchPostItemHomeKitchenFields" }, "jobs_fields": { "$ref": "#/components/schemas/SearchPostItemJobsFields" }, "last_modified_at": { "format": "date-time", "type": "string" }, "leisure_hobbies_fields": { "$ref": "#/components/schemas/SearchPostItemLeisureHobbiesFields" }, "personal_goods_fields": { "$ref": "#/components/schemas/SearchPostItemPersonalGoodsFields" }, "price": { "$ref": "#/components/schemas/SearchPostItemPrice" }, "real_estate_fields": { "$ref": "#/components/schemas/SearchPostItemRealEstateFields" }, "services_fields": { "$ref": "#/components/schemas/finderSearchPostItemServicesFields" }, "title": { "type": "string" }, "token": { "type": "string" }, "tools_materials_equipment_fields": { "$ref": "#/components/schemas/SearchPostItemToolsMaterialsEquipmentFields" }, "vehicles_fields": { "$ref": "#/components/schemas/SearchPostItemVehiclesFields" } }, "type": "object" }, "finderSearchPostItemServicesFields": { "type": "object" }, "finderSearchPostV2Response": { "properties": { "posts": { "items": { "$ref": "#/components/schemas/finderSearchPostItem" }, "type": "array" } }, "type": "object" }, "finderSearchPostsV2Request": { "properties": { "category": { "type": "string" }, "city": { "type": "string" }, "districts": { "items": { "type": "string" }, "type": "array" }, "query": { "$ref": "#/components/schemas/finderSearchQuery" } }, "type": "object" }, "finderSearchQuery": { "properties": { "brand_model": { "items": { "type": "string" }, "type": "array" }, "credit": { "$ref": "#/components/schemas/finderSearchQueryNumberRange" }, "only_with_parking": { "type": "boolean" }, "production_year": { "$ref": "#/components/schemas/finderSearchQueryNumberRange" }, "rent": { "$ref": "#/components/schemas/finderSearchQueryNumberRange" }, "rooms": { "items": { "type": "string" }, "type": "array" }, "size": { "$ref": "#/components/schemas/finderSearchQueryNumberRange" }, "usage": { "$ref": "#/components/schemas/finderSearchQueryNumberRange" } }, "type": "object" }, "finderSearchQueryNumberRange": { "properties": { "max": { "format": "int64", "type": "string" }, "min": { "format": "int64", "type": "string" } }, "type": "object" }, "finderUser": { "properties": { "phone_number": { "type": "string" }, "phone_numbers": { "description": "منسوخ شده", "items": { "type": "string" }, "title": "نیاز به OAuth اسکوپ: USER_PHONE", "type": "array" }, "user_id": { "type": "string" } }, "type": "object" }, "googlerpcStatus": { "properties": { "code": { "format": "int32", "type": "integer" }, "details": { "items": { "$ref": "#/components/schemas/protobufAny" }, "type": "array" }, "message": { "type": "string" } }, "type": "object" }, "managementDevelopmentPost": { "properties": { "category": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "mng_token": { "type": "string" }, "token": { "type": "string" } }, "type": "object" }, "open_platformpostHTTPMethod": { "enum": [ "GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS" ], "type": "string" }, "open_platformpostPostState": { "enum": [ "POST_STATE_IN_PUBLISH_QUEUE", "POST_STATE_PUBLISHED", "POST_STATE_WAITING_FOR_EDIT", "POST_STATE_WAITING_FOR_PAYMENT", "POST_STATE_WAITING_FOR_REVIEW", "POST_STATE_PUBLISHED_AND_EDIT_REJECTED", "POST_STATE_REJECTED", "POST_STATE_DELETED", "POST_STATE_RETIRED" ], "type": "string" }, "paymentCommitWalletTransactionRequest": { "properties": { "token": { "description": "توکن تراکنشی که می‌خواهید نهایی کنید", "type": "string" } }, "type": "object" }, "paymentCommitWalletTransactionResponse": { "properties": { "transaction": { "$ref": "#/components/schemas/paymentWalletTransaction" } }, "type": "object" }, "paymentCreateWalletPaymentRequest": { "properties": { "amount_rials": { "description": "مبلغ تراکنش به ریال", "format": "int64", "type": "string" }, "description": { "description": "توضیحات تراکنش", "type": "string" }, "redirect_url": { "description": "آدرسی که کاربر باید بعد از پرداخت مبلغ به آن هدایت شود", "type": "string" } }, "required": [ "amount_rials", "description", "redirect_url" ], "type": "object" }, "paymentCreateWalletPaymentResponse": { "properties": { "payment_url": { "description": "آدرسی که باید کاربر را به آن هدایت کنید", "type": "string" }, "token": { "description": "توکن تراکنش. برای عملیات‌های بعدی استفاده می‌شود", "type": "string" } }, "type": "object" }, "paymentGetBalanceResponse": { "properties": { "balance_rials": { "description": "موجودی اپلیکیشن به ریال", "format": "int64", "type": "string" } }, "type": "object" }, "paymentGetPostPricingResponse": { "properties": { "renew": { "$ref": "#/components/schemas/GetPostPricingResponseRenew" }, "reorder": { "$ref": "#/components/schemas/GetPostPricingResponseReorder" }, "submit": { "$ref": "#/components/schemas/GetPostPricingResponseSubmit" } }, "type": "object" }, "paymentGetTransactionResponse": { "properties": { "transaction": { "$ref": "#/components/schemas/paymentTransaction" } }, "type": "object" }, "paymentListTransactionsResponse": { "properties": { "next_page_token": { "description": "توکن برای صفحه بعدی نتایج.", "type": "string" }, "transactions": { "description": "فهرست تراکنش‌هایی که با درخواست مطابقت دارند", "items": { "$ref": "#/components/schemas/paymentTransaction" }, "type": "array" } }, "type": "object" }, "paymentPublishUserPostResponse": { "properties": { "transaction": { "$ref": "#/components/schemas/paymentTransaction" } }, "type": "object" }, "paymentRenewPostResponse": { "properties": { "transaction": { "$ref": "#/components/schemas/paymentTransaction" } }, "type": "object" }, "paymentReorderPostResponse": { "properties": { "cost_rials": { "description": "هزینه تراکنش به ریال برای اپلیکیشن شما", "format": "int64", "type": "string" }, "id": { "description": "همان uuid هنگام ایجاد تراکنش", "type": "string" } }, "type": "object" }, "paymentRetrieveWalletTransactionResponse": { "properties": { "transaction": { "$ref": "#/components/schemas/paymentWalletTransaction" } }, "type": "object" }, "paymentSubmitUserPaymentRequest": { "properties": { "amount_rials": { "description": "مبلغ کل پرداختی کاربر به ریال", "format": "uint64", "type": "string" }, "profit_rials": { "description": "سود یا کمیسیون شما از این تراکنش، به ریال. اگر چنین مفهومی در فرایند پرداخت شما وجود ندارد، مقدار این پارامتر را برابر amount_rials قرار دهید.", "format": "uint64", "type": "string" }, "reference_id": { "description": "شناسه منحصر به فرد بین دیوار و ارائه‌دهنده برای فاکتور یا تراکنش. این شناسه مرجع درگاه پرداخت نیست.", "type": "string" }, "services": { "description": "لیست slug خدماتی که کاربر برای آنها پرداخت کرده (مثلاً 'banner'، 'title_refinement')", "items": { "type": "string" }, "type": "array" } }, "required": [ "amount_rials", "profit_rials", "services", "reference_id" ], "type": "object" }, "paymentSubmitUserPaymentResponse": { "type": "object" }, "paymentTransaction": { "properties": { "app_slug": { "description": "شناسه اپلیکیشنی که تراکنش را ایجاد کرده است", "type": "string" }, "cost_rials": { "description": "هزینه تراکنش به ریال برای اپلیکیشن شما", "format": "int64", "type": "string" }, "created_at": { "description": "زمان ایجاد تراکنش", "format": "date-time", "type": "string" }, "extra_details": { "description": "همان جزئیات اضافی که در درخواست ارسال کردید", "type": "string" }, "id": { "description": "همان uuid هنگام ایجاد تراکنش", "type": "string" }, "state": { "$ref": "#/components/schemas/paymentTransactionState" }, "type": { "$ref": "#/components/schemas/paymentTransactionType" } }, "type": "object" }, "paymentTransactionState": { "enum": [ "TRANSACTION_STATE_PENDING", "TRANSACTION_STATE_COMPLETED", "TRANSACTION_STATE_FAILED", "TRANSACTION_STATE_REFUNDED" ], "type": "string" }, "paymentTransactionType": { "enum": [ "TRANSACTION_TYPE_REORDER", "TRANSACTION_TYPE_SUBMIT", "TRANSACTION_TYPE_RENEW" ], "type": "string" }, "paymentWalletTransaction": { "properties": { "amount_rials": { "format": "int64", "type": "string" }, "status": { "$ref": "#/components/schemas/paymentWalletTransactionStatus" }, "token": { "type": "string" } }, "type": "object" }, "paymentWalletTransactionStatus": { "description": "وضعیت‌های مختلف تراکنش کیف پول: UNKNOWN (پیش‌فرض - نباید استفاده شود)، CREATED (در انتظار پرداخت)، EXPIRED (منقضی شده)، PAID (پرداخت شده، در انتظار تایید نهایی)، COMMITTED (نهایی شده).", "enum": [ "CREATED", "EXPIRED", "PAID", "COMMITTED" ], "type": "string" }, "payment_ticketGenerateResponse": { "properties": { "ticket_uuid": { "type": "string" } }, "type": "object" }, "payment_ticketValidateRequest": { "properties": { "phone_number": { "description": "شماره تلفن کاربر (به جای آن از user_id استفاده کنید)", "type": "string" }, "service_cost": { "description": "هزینه سرویس به ریال", "format": "int32", "type": "integer" }, "ticket_uuid": { "description": "شناسه منحصر به فرد تیکت پرداخت", "type": "string" }, "user_id": { "description": "شناسه منحصر به فرد کاربر", "type": "string" } }, "required": [ "ticket_uuid", "service_cost" ], "type": "object" }, "payment_ticketValidateResponse": { "properties": { "issuer_payload": { "description": "داده payload ارائه شده توسط صادرکننده تیکت", "type": "object" } }, "type": "object" }, "postCanUserSubmitPostResponse": { "properties": { "can_submit": { "type": "boolean" } }, "type": "object" }, "postCreateBusinessCustomizedButtonResponse": { "type": "object" }, "postCustomizedButton": { "properties": { "action": { "$ref": "#/components/schemas/addonsAction" }, "type": { "$ref": "#/components/schemas/postCustomizedButtonType" } }, "required": [ "type", "action" ], "type": "object" }, "postCustomizedButtonType": { "description": "نوع دکمه اختصاصی که هدف و رفتار آن را تعیین می‌کند. ویژگی‌هایی مانند عنوان دکمه بر اساس نوع آن تعیین می‌شوند.\n\nانواع موجود:\n- `ACCOMMODATION_BOOKING`: برای رزرو اقامتگاه\n- `EXTERNAL_PRODUCT_STORE`: برای مشاهده و خرید محصولات در فروشگاه‌های آنلاین\n- `RESUME_SUBMISSION`: برای ارسال رزومه\n- `ONLINE_CALL`: برای تماس آنلاین با فروشنده", "enum": [ "ACCOMMODATION_BOOKING", "EXTERNAL_PRODUCT_STORE", "RESUME_SUBMISSION", "ONLINE_CALL" ], "type": "string" }, "postDeleteBusinessCustomizedButtonResponse": { "type": "object" }, "postDeleteCustomizedButtonsOffloadedResponse": { "type": "object" }, "postDeletePostCustomizedButtonResponse": { "type": "object" }, "postDeleteUserPostResponse": { "type": "object" }, "postEditPostResponse": { "type": "object" }, "postGetBusinessCustomizedButtonResponse": { "properties": { "app_name": { "type": "string" }, "app_slug": { "type": "string" }, "is_active": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/postCustomizedButtonType" } }, "type": "object" }, "postGetImageUploadURLResponse": { "properties": { "upload_url": { "type": "string" } }, "type": "object" }, "postGetPostStatsResponse": { "properties": { "chats": { "$ref": "#/components/schemas/GetPostStatsResponsePostStats" }, "impressions": { "$ref": "#/components/schemas/GetPostStatsResponsePostStats" }, "views": { "$ref": "#/components/schemas/GetPostStatsResponsePostStats" } }, "type": "object" }, "postGetUploadURLsV2Response": { "properties": { "image": { "$ref": "#/components/schemas/GetUploadURLsV2ResponseUploadFormat" }, "video": { "$ref": "#/components/schemas/GetUploadURLsV2ResponseUploadFormat" } }, "type": "object" }, "postGetUserPostResponse": { "properties": { "business_data": { "$ref": "#/components/schemas/postGetUserPostResponseBusinessData" }, "category_data": { "type": "object" }, "general_data": { "$ref": "#/components/schemas/postPostGeneralData" }, "reject_reason": { "type": "string" }, "state": { "$ref": "#/components/schemas/open_platformpostPostState" } }, "type": "object" }, "postGetUserPostResponseBusinessData": { "properties": { "business_name": { "type": "string" }, "business_type": { "$ref": "#/components/schemas/PremiumPanelBusinessDataSubBusinessType" } }, "type": "object" }, "postLocationType": { "description": "نوع موقعیت", "enum": [ "LOCATION_TYPE_EMPTY", "LOCATION_TYPE_EXACT", "LOCATION_TYPE_APPROXIMATE" ], "example": "LOCATION_TYPE_EXACT", "type": "string" }, "postPostGeneralData": { "properties": { "category_slug": { "description": "slug دسته‌بندی. لیست دسته‌بندی‌ها: https://kenar.divar.dev/openapi-doc/assets-get-categories/", "example": "apartment-sell", "type": "string" }, "chat_enabled": { "description": "فعال بودن چت", "example": true, "type": "boolean" }, "city": { "description": "شهر آگهی", "example": "tehran", "type": "string" }, "description": { "description": "توضیحات آگهی", "example": "I'm available only in chat.", "type": "string" }, "district": { "description": "محله آگهی", "example": "abshar", "type": "string" }, "hide_phone": { "description": "مخفی کردن شماره تماس از کاربران", "example": true, "type": "boolean" }, "images": { "items": { "type": "string" }, "type": "array" }, "latitude": { "description": "عرض جغرافیایی آگهی", "example": 35.7152, "format": "double", "type": "number" }, "location_type": { "$ref": "#/components/schemas/postLocationType" }, "longitude": { "description": "طول جغرافیایی آگهی", "example": 51.4043, "format": "double", "type": "number" }, "title": { "description": "عنوان آگهی", "example": "Temporary Residence for Rent in Tehran", "type": "string" }, "video": { "$ref": "#/components/schemas/PostGeneralDataPostVideo" } }, "required": [ "category_slug", "title", "description", "images", "city", "location_type", "hide_phone", "chat_enabled" ], "type": "object" }, "postSetPostCustomizedButtonResponse": { "type": "object" }, "postSubmitPostResponse": { "properties": { "post_token": { "type": "string" } }, "type": "object" }, "postSubmitPostV2Request": { "properties": { "business_token": { "description": "توکن کسب‌وکاری که این آگهی متعلق به آن می‌شود", "example": "xYzAbC123", "type": "string" }, "category_fields": { "description": "فیلدهای مختص دسته‌بندی که باید مطابق schema تکمیل شوند. schema را اینجا ببینید: https://kenar.divar.dev/openapi-doc/assets-get-submit-schema/", "type": "object" }, "general_data": { "$ref": "#/components/schemas/postPostGeneralData" }, "landline_numbers": { "description": "شماره‌های ثابت برای افزودن به آگهی", "example": [ "02188888888", "02188888889" ], "items": { "type": "string" }, "type": "array" } }, "required": [ "category_fields", "general_data", "business_token" ], "type": "object" }, "postSubmitUserPostRequest": { "properties": { "business_token": { "description": "توکن کسب‌وکاری که این آگهی متعلق به آن می‌شود", "example": "xYzAbC123", "type": "string" }, "category_fields": { "description": "فیلدهای مختص دسته‌بندی که باید مطابق schema تکمیل شوند. schema را اینجا ببینید: https://kenar.divar.dev/openapi-doc/assets-get-submit-schema/", "type": "object" }, "general_data": { "$ref": "#/components/schemas/postPostGeneralData" } }, "required": [ "category_fields", "general_data", "business_token" ], "type": "object" }, "premium_panelUserRole": { "enum": [ "ROLE_ADMIN", "ROLE_AGENT", "ROLE_OWNER" ], "type": "string" }, "protobufAny": { "additionalProperties": {}, "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n\nExample 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\nExample 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", "properties": { "@type": { "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", "type": "string" } }, "type": "object" }, "protobufNullValue": { "description": "`NullValue` یک شمارش singleton برای نمایش مقدار null برای\nاتحادیه نوع `Value` است.\n\n نمایش JSON برای `NullValue` JSON `null` است.", "type": "string" }, "semanticCreatePostSemanticResponse": { "type": "object" }, "semanticCreateUserSemanticResponse": { "properties": { "id": { "type": "string" } }, "type": "object" }, "semanticDeleteUserSemanticResponse": { "type": "object" }, "semanticPostSemanticDeleted": { "properties": { "app_slug": { "type": "string" }, "post_token": { "type": "string" } }, "type": "object" }, "semanticSendSemanticDeletionEventsResponse": { "type": "object" }, "semanticUserSemanticDeleted": { "properties": { "app_slug": { "type": "string" }, "divar_user_id": { "type": "string" }, "id": { "type": "string" }, "phone": { "title": "منسوخ شده. از divar_user_id استفاده کنید", "type": "string" } }, "type": "object" } }, "securitySchemes": { "APIKey": { "description": "API Key retrieved from kenar management panel", "in": "header", "name": "X-API-Key", "type": "apiKey" }, "OAuth": { "description": "OAuth2 access token retrieved from user", "flows": { "authorizationCode": { "authorizationUrl": "oauth.divar.ir/oauth2/auth", "refreshUrl": "oauth.divar.ir/oauth2/token", "scopes": { "BUSINESS_ADDON_CREATE.resource_id": "BUSINESS_ADDON_CREATE.resource_id", "BUSINESS_CREATE_CUSTOMIZED_BUTTON.resource_id": "BUSINESS_CREATE_CUSTOMIZED_BUTTON.resource_id", "CHAT_BOT_USER_MESSAGE_SEND": "CHAT_BOT_USER_MESSAGE_SEND", "CHAT_CONVERSATION_READ.resource_id": "CHAT_CONVERSATION_READ.resource_id", "CHAT_MESSAGE_SEND.resource_id": "CHAT_MESSAGE_SEND.resource_id", "CHAT_POST_CONVERSATIONS_MESSAGE_SEND.resource_id": "CHAT_POST_CONVERSATIONS_MESSAGE_SEND.resource_id", "CHAT_POST_CONVERSATIONS_READ.resource_id": "CHAT_POST_CONVERSATIONS_READ.resource_id", "CHAT_SUPPLIER_ALL_CONVERSATIONS_MESSAGE_SEND": "CHAT_SUPPLIER_ALL_CONVERSATIONS_MESSAGE_SEND", "CHAT_SUPPLIER_ALL_CONVERSATIONS_READ": "CHAT_SUPPLIER_ALL_CONVERSATIONS_READ", "CONVERSATION_SEND_MESSAGE.resource_id": "CONVERSATION_SEND_MESSAGE.resource_id", "CREATE_WALLET_PAYMENT": "CREATE_WALLET_PAYMENT", "DELETE_USER_POST": "DELETE_USER_POST", "EDIT_USER_POST": "EDIT_USER_POST", "MANAGEMENT_APPS_READ.resource_id": "MANAGEMENT_APPS_READ.resource_id", "MANAGEMENT_APPS_WRITE.resource_id": "MANAGEMENT_APPS_WRITE.resource_id", "NOTIFICATION_ACCESS_REVOCATION": "NOTIFICATION_ACCESS_REVOCATION", "PAYMENT_ALL_POSTS_PRICING_READ": "PAYMENT_ALL_POSTS_PRICING_READ", "PAYMENT_ALL_POSTS_RENEW": "PAYMENT_ALL_POSTS_RENEW", "PAYMENT_ALL_POSTS_REORDER": "PAYMENT_ALL_POSTS_REORDER", "POST_ADDON_CREATE.resource_id": "POST_ADDON_CREATE.resource_id", "POST_EDIT.resource_id": "POST_EDIT.resource_id", "POST_ONGOING_IMAGES_GET.resource_id": "POST_ONGOING_IMAGES_GET.resource_id", "POST_SEMANTIC_CREATE.resource_id": "POST_SEMANTIC_CREATE.resource_id", "SEND_EVENT": "SEND_EVENT", "SUBMIT_USER_PAYMENT": "SUBMIT_USER_PAYMENT", "SUBMIT_USER_POST": "SUBMIT_USER_POST", "USER_ADDON_CREATE": "USER_ADDON_CREATE", "USER_BUSINESSES_READ": "USER_BUSINESSES_READ", "USER_ID": "USER_ID", "USER_PHONE": "USER_PHONE", "USER_POSTS_ADDON_CREATE": "USER_POSTS_ADDON_CREATE", "USER_POSTS_GET": "USER_POSTS_GET", "USER_POSTS_STATS_READ": "USER_POSTS_STATS_READ", "USER_SET_CUSTOMIZED_BUTTON": "USER_SET_CUSTOMIZED_BUTTON", "USER_VERIFICATION_CREATE": "USER_VERIFICATION_CREATE", "offline_access": "offline_access", "openid": "openid" }, "tokenUrl": "oauth.divar.ir/oauth2/token" } }, "name": "ACCESS_TOKEN", "type": "oauth2" } } }, "info": { "title": "API کنار", "version": "1.0" }, "openapi": "3.0.0", "paths": { "/experimental/open-platform/balance": { "get": { "description": "این API امکان دریافت موجودی فعلی اپلیکیشن شما به ریال را فراهم می‌کند. برای نظارت بر موجودی حساب قبل از انجام عملیات‌های پولی استفاده کنید.\n\n**نکات مهم**:\n- این قابلیت فقط برای اپلیکیشن‌های تایید شده در دسترس است\n- موجودی به ریال ایران برگردانده می‌شود\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `BALANCE_RETRIEVE`", "operationId": "Payment_GetBalance", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentGetBalanceResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [] } ], "summary": "دریافت موجودی اپلیکیشن", "tags": [ "Payment" ] } }, "/experimental/open-platform/business/{business_token}/customized-button": { "delete": { "description": "این API تنظیمات دکمه اختصاصی را از تمام آگهی‌های کسب‌وکار حذف می‌کند.\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `BUSINESS_CUSTOMIZED_BUTTON_CREATE`", "operationId": "Post_DeleteBusinessCustomizedButton", "parameters": [ { "in": "path", "name": "business_token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postDeleteBusinessCustomizedButtonResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [] } ], "summary": "حذف دکمه اختصاصی از آگهی‌های کسب‌و‌کار", "tags": [ "Post" ] }, "post": { "description": "این API تنظیمات دکمه اختصاصی را برای تمام آگهی‌های کسب‌وکار ایجاد می‌کند.\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `BUSINESS_CUSTOMIZED_BUTTON_CREATE`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `BUSINESS_CREATE_CUSTOMIZED_BUTTON.business_token`", "operationId": "Post_CreateBusinessCustomizedButton", "parameters": [ { "in": "path", "name": "business_token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostCreateBusinessCustomizedButtonBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postCreateBusinessCustomizedButtonResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "BUSINESS_CREATE_CUSTOMIZED_BUTTON.business_token" ] } ], "summary": "ایجاد دکمه اختصاصی برای آگهی‌های کسب‌وکار", "tags": [ "Post" ] } }, "/experimental/open-platform/chat/bot/conversations/{conversation_id}/messages": { "post": { "description": "این API امکان ارسال پیام از ربات چت شما به یک مکالمه یا کاربر را فراهم می‌کند. می‌توانید این API را با conversation_id یا user_id فراخوانی کنید.\n\n**نکات مهم**:\n- هنگام استفاده از user_id، باید با شناسه مبهم شده کاربر احراز هویت شده مطابقت داشته باشد\n- یا پیام متنی یا توکن رسانه باید ارسال شود (نه هر دو)\n- می‌توان شبکه دکمه‌ها را به پیام ضمیمه کرد\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `CHAT_BOT_SEND_MESSAGE`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `CHAT_BOT_USER_MESSAGE_SEND`", "operationId": "ChatAPI_ChatBotSendMessage5", "parameters": [ { "description": "شناسه منحصر به فرد برای مکالمه", "in": "path", "name": "conversation_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/ChatAPIChatBotSendMessageBody" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chatapiChatBotSendMessageResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "CHAT_BOT_USER_MESSAGE_SEND" ] } ], "summary": "ارسال پیام به مکالمه چت‌بات", "tags": [ "ChatAPI" ] } }, "/experimental/open-platform/chat/bot/users/{user_id}/messages": { "post": { "description": "این API امکان ارسال پیام از ربات چت شما به یک مکالمه یا کاربر را فراهم می‌کند. می‌توانید این API را با conversation_id یا user_id فراخوانی کنید.\n\n**نکات مهم**:\n- هنگام استفاده از user_id، باید با شناسه مبهم شده کاربر احراز هویت شده مطابقت داشته باشد\n- یا پیام متنی یا توکن رسانه باید ارسال شود (نه هر دو)\n- می‌توان شبکه دکمه‌ها را به پیام ضمیمه کرد\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `CHAT_BOT_SEND_MESSAGE`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `CHAT_BOT_USER_MESSAGE_SEND`", "operationId": "ChatAPI_ChatBotSendMessage4", "parameters": [ { "description": "شناسه منحصر به فرد کاربر برای شروع یا ادامه مکالمه", "in": "path", "name": "user_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/ChatAPIChatBotSendMessageBody" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chatapiChatBotSendMessageResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "CHAT_BOT_USER_MESSAGE_SEND" ] } ], "summary": "ارسال پیام به مکالمه چت‌بات", "tags": [ "ChatAPI" ] } }, "/experimental/open-platform/chat/upload": { "post": { "description": "این API توکن آپلود برای بارگذاری فایل‌های رسانه‌ای در پیام‌های چت تولید می‌کند.\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `CHAT_UPLOAD_MEDIA`", "operationId": "ChatAPI_GenerateUploadToken", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chatapiGenerateUploadTokenRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chatapiGenerateUploadTokenResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [] } ], "summary": "تولید توکن آپلود", "tags": [ "ChatAPI" ] } }, "/experimental/open-platform/chatbot-conversations/{conversation_id}/messages": { "post": { "description": "این API امکان ارسال پیام از ربات چت شما به یک مکالمه یا کاربر را فراهم می‌کند. می‌توانید این API را با conversation_id یا user_id فراخوانی کنید.\n\n**نکات مهم**:\n- هنگام استفاده از user_id، باید با شناسه مبهم شده کاربر احراز هویت شده مطابقت داشته باشد\n- یا پیام متنی یا توکن رسانه باید ارسال شود (نه هر دو)\n- می‌توان شبکه دکمه‌ها را به پیام ضمیمه کرد\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `CHAT_BOT_SEND_MESSAGE`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `CHAT_BOT_USER_MESSAGE_SEND`", "operationId": "ChatAPI_ChatBotSendMessage3", "parameters": [ { "description": "شناسه منحصر به فرد برای مکالمه", "in": "path", "name": "conversation_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/ChatAPIChatBotSendMessageBody" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chatapiChatBotSendMessageResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "CHAT_BOT_USER_MESSAGE_SEND" ] } ], "summary": "ارسال پیام به مکالمه چت‌بات", "tags": [ "ChatAPI" ] } }, "/experimental/open-platform/post/{post_token}/publish": { "post": { "description": "این API امکان پرداخت هزینه انتشار آگهی ثبت شده توسط کاربر از طرف اپلیکیشن شما را فراهم می‌کند. هزینه از موجودی اپلیکیشن شما کسر می‌شود و آگهی منتشر می‌شود.\n\n**نکات مهم**:\n- ابتدا آگهی باید با API `SubmitUserPost` ایجاد شده باشد\n- یک `id` منحصر به فرد (UUID v4) برای جلوگیری از تکرار ارسال کنید\n- آگهی باید در وضعیت نیازمند پرداخت (WAITING_FOR_PAYMENT) باشد\n- از کافی بودن موجودی اپلیکیشن خود اطمینان حاصل کنید\n- هزینه‌ها بر اساس دسته‌بندی و شهر آگهی متفاوت است\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `PUBLISH_USER_POST`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `SUBMIT_USER_POST`", "operationId": "Payment_PublishUserPost", "parameters": [ { "description": "توکن آگهی دریافت شده از RPC SubmitUserPost. شناسه منحصر به فرد 8-9 کاراکتری برای آگهی ثبت شده توسط کاربر.", "in": "path", "name": "post_token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentPublishUserPostBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentPublishUserPostResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "SUBMIT_USER_POST" ] } ], "summary": "انتشار آگهی کاربر (پرداخت توسط ارائه‌دهنده)", "tags": [ "Payment" ] } }, "/experimental/open-platform/post/{post_token}/renew": { "post": { "description": "این API امکان تمدید آگهی را فراهم می‌کند که دوره نمایش آن در دیوار را افزایش می‌دهد. هزینه از موجودی اپلیکیشن شما کسر می‌شود.\n\n**نکات مهم**:\n- این قابلیت فقط برای اپلیکیشن‌های تایید شده در دسترس است\n- قبل از تمدید، از `GetPostPricing` برای بررسی هزینه استفاده کنید\n- یک `id` منحصر به فرد (UUID v4) برای جلوگیری از تکرار ارسال کنید\n- آگهی باید در وضعیت PUBLISHED و واجد شرایط تمدید باشد\n- از کافی بودن موجودی اپلیکیشن خود اطمینان حاصل کنید\n- هزینه‌ها بر اساس دسته‌بندی و شهر آگهی متفاوت است\n- تمدید، نمایش آگهی را افزایش داده و عمر آن را بازنشانی می‌کند\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `POST_RENEW`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `PAYMENT_ALL_POSTS_RENEW`", "operationId": "Payment_RenewPost", "parameters": [ { "in": "path", "name": "post_token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRenewPostBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentRenewPostResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "PAYMENT_ALL_POSTS_RENEW" ] } ], "summary": "تمدید آگهی", "tags": [ "Payment" ] } }, "/experimental/open-platform/post/{post_token}/reorder": { "post": { "description": "این API امکان نردبان کردن آگهی به بالای لیست را فراهم می‌کند. هزینه از موجودی اپلیکیشن شما کسر می‌شود.\n\n**نکات مهم**:\n- این قابلیت فقط برای اپلیکیشن‌های تایید شده در دسترس است\n- قبل از نردبان، از `GetPostPricing` برای بررسی هزینه استفاده کنید\n- یک `id` منحصر به فرد (UUID v4) برای جلوگیری از تکرار ارسال کنید\n- آگهی باید در وضعیت PUBLISHED باشد\n- از کافی بودن موجودی اپلیکیشن خود اطمینان حاصل کنید\n- هزینه‌ها بر اساس دسته‌بندی و شهر آگهی متفاوت است\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `POST_REORDER`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `PAYMENT_ALL_POSTS_REORDER`", "operationId": "Payment_ReorderPost", "parameters": [ { "in": "path", "name": "post_token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentReorderPostBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentReorderPostResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "PAYMENT_ALL_POSTS_REORDER" ] } ], "summary": "نردبان آگهی", "tags": [ "Payment" ] } }, "/experimental/open-platform/posts/new-v2": { "post": { "description": "این API امکان ثبت آگهی با استفاده از اعتبارسنجی JSON schema را فراهم می‌کند. داده‌های آگهی در برابر قالب دسته‌بندی مشخص شده اعتبارسنجی می‌شوند.\n\n**نکات مهم**:\n- فیلدهای ویژه دسته‌بندی باید از [قالب](https://kenar.divar.dev/openapi-doc/assets-get-submit-schema/) پیروی کنند\n- تمام فیلدهای اجباری ذکر شده در قالب باید ارسال شوند، در غیر این صورت ثبت ناموفق خواهد بود\n- این برای ثبت در سطح اپلیکیشن است (آگهی‌های ارائه‌دهنده)\n- آگهی‌های ثبت شده توسط ارائه‌دهندگان باید آگهی‌های کسب‌وکار باشند، بنابراین توکن کسب‌وکار الزامی است\n- کاربر احراز هویت شده باید به کسب‌وکار دسترسی داشته باشد\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `SUBMIT_POST`", "operationId": "Post_SubmitPostV2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postSubmitPostV2Request" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postSubmitPostResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [] } ], "summary": "ثبت آگهی", "tags": [ "Post" ] } }, "/experimental/open-platform/posts/{post_token}/customized-button": { "delete": { "description": "این API تنظیمات دکمه اختصاصی را از یک آگهی حذف می‌کند.\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `SET_CUSTOMIZED_BUTTON`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `USER_SET_CUSTOMIZED_BUTTON`", "operationId": "Post_DeletePostCustomizedButton", "parameters": [ { "in": "path", "name": "post_token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postDeletePostCustomizedButtonResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "USER_SET_CUSTOMIZED_BUTTON" ] } ], "summary": "حذف دکمه اختصاصی از آگهی", "tags": [ "Post" ] }, "post": { "description": "این API تنظیمات دکمه اختصاصی را برای یک آگهی تعیین می‌کند. اگر دکمه وجود نداشته باشد، ایجاد می‌شود. اگر از قبل وجود داشته باشد، داده‌های آن به‌روزرسانی می‌شوند.\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `SET_CUSTOMIZED_BUTTON`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `USER_SET_CUSTOMIZED_BUTTON`", "operationId": "Post_SetPostCustomizedButton", "parameters": [ { "in": "path", "name": "post_token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostSetPostCustomizedButtonBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postSetPostCustomizedButtonResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "USER_SET_CUSTOMIZED_BUTTON" ] } ], "summary": "تنظیم دکمه اختصاصی روی آگهی", "tags": [ "Post" ] } }, "/experimental/open-platform/posts/{post_token}/stats": { "get": { "description": "این API امکان دریافت آمار یک آگهی شامل بازدیدها، نمایش‌ها و چت‌ها را فراهم می‌کند. آمار روزانه برای 7 روز اخیر و تعداد کل برمی‌گردد.\n\n**نکات مهم**:\n- فقط آمار آگهی‌های متعلق به کاربر احراز هویت شده برگردانده می‌شود\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `POST_STATS_RETRIEVE`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `USER_POSTS_STATS_READ`", "operationId": "Post_GetPostStats", "parameters": [ { "description": "توکن آگهی", "in": "path", "name": "post_token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postGetPostStatsResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "USER_POSTS_STATS_READ" ] } ], "summary": "دریافت آمارهای آگهی", "tags": [ "Post" ] } }, "/experimental/open-platform/semantic/post/{token}": { "post": { "description": "این API امکان ذخیره اطلاعات درباره یک آگهی در دیوار بدون افزودن افزونه را فراهم می‌کند.\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `POST_SEMANTIC_CREATE`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `POST_SEMANTIC_CREATE.post_token`", "operationId": "Semantic_CreatePostSemantic", "parameters": [ { "description": "توکن آگهی", "in": "path", "name": "token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SemanticCreatePostSemanticBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/semanticCreatePostSemanticResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "POST_SEMANTIC_CREATE.post_token" ] } ], "summary": "ایجاد اطلاعات معنایی آگهی", "tags": [ "Semantic" ] } }, "/experimental/open-platform/transactions": { "get": { "description": "این API امکان دریافت لیست صفحه‌بندی شده از تراکنش‌های اپلیکیشن شما را فراهم می‌کند. برای تاریخچه تراکنش، ممیزی و تسویه حساب استفاده کنید.\n\n**نکات مهم**:\n- این قابلیت فقط برای اپلیکیشن‌های تایید شده در دسترس است\n- نتایج صفحه‌بندی شده هستند - از `page_size` برای کنترل تعداد آیتم‌ها در هر صفحه استفاده کنید\n- از `page_token` در پاسخ برای دریافت صفحه بعدی استفاده کنید\n- تراکنش‌ها بر اساس زمان ایجاد مرتب می‌شوند (جدیدترین اول)\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `TRANSACTION_LIST`", "operationId": "Payment_ListTransactions", "parameters": [ { "description": "تعداد تراکنش‌ها در هر صفحه", "in": "query", "name": "page_size", "schema": { "format": "int32", "type": "integer" } }, { "description": "توکن برای صفحه بعدی نتایج", "in": "query", "name": "page_token", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentListTransactionsResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [] } ], "summary": "لیست تراکنش‌ها", "tags": [ "Payment" ] } }, "/experimental/open-platform/transactions/{id}": { "get": { "description": "این API امکان دریافت اطلاعات دقیق یک تراکنش خاص با شناسه آن را فراهم می‌کند. برای پیگیری وضعیت تراکنش، هزینه‌ها و متادیتا استفاده کنید.\n\n**نکات مهم**:\n- این قابلیت فقط برای اپلیکیشن‌های تایید شده در دسترس است\n- شناسه تراکنش همان UUID است که هنگام ایجاد تراکنش ارسال کردید\n- وضعیت‌های تراکنش: PENDING، COMPLETED، FAILED، REFUNDED\n- انواع تراکنش: REORDER، SUBMIT، RENEW\n- برای تایید تکمیل تراکنش پس از عملیات‌های پولی استفاده کنید\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `TRANSACTION_RETRIEVE`", "operationId": "Payment_GetTransaction", "parameters": [ { "description": "شناسه منحصر به فرد برای تراکنش، همان id در درخواست", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentGetTransactionResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [] } ], "summary": "دریافت جزئیات تراکنش", "tags": [ "Payment" ] } }, "/experimental/open-platform/user-posts/can-submit": { "get": { "description": "این API بررسی می‌کند که آیا کاربر واجد شرایط ثبت آگهی است. تایید می‌کند که کاربر در لیست سیاه نیست، متخلف نیست و احراز هویت شده است.\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `CAN_USER_SUBMIT_POST`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `SUBMIT_USER_POST`", "operationId": "Post_CanUserSubmitPost", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postCanUserSubmitPostResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "SUBMIT_USER_POST" ] } ], "summary": "بررسی اینکه آیا کاربر می‌تواند آگهی ارسال کند", "tags": [ "Post" ] } }, "/experimental/open-platform/user-posts/new": { "post": { "description": "این API امکان ثبت آگهی از طرف کاربر احراز هویت شده با استفاده از اعتبارسنجی JSON schema را فراهم می‌کند. آگهی متعلق به کاربر احراز هویت شده خواهد بود و می‌توان از طریق APIهای مختص کاربر مدیریت کرد.\n\n**نکات مهم**:\n- فیلدهای ویژه دسته‌بندی باید از [قالب](https://kenar.divar.dev/openapi-doc/assets-get-submit-schema/) پیروی کنند\n- تمام فیلدهای اجباری ذکر شده در قالب باید ارسال شوند، در غیر این صورت ثبت ناموفق خواهد بود\n- آگهی‌های ثبت شده توسط ارائه‌دهندگان باید آگهی‌های کسب‌وکار باشند، بنابراین توکن کسب‌وکار الزامی است\n- کاربر احراز هویت شده باید به کسب‌وکار دسترسی داشته باشد\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `SUBMIT_USER_POST`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `SUBMIT_USER_POST`", "operationId": "Post_SubmitUserPost", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postSubmitUserPostRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postSubmitPostResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "SUBMIT_USER_POST" ] } ], "summary": "ثبت آگهی به عنوان کاربر", "tags": [ "Post" ] } }, "/experimental/open-platform/wallet/payments/commit": { "post": { "description": "این API تراکنش پرداخت کیف پول را پس از پرداخت موفق نهایی می‌کند.\n\n**نکات مهم**:\n- این قابلیت آزمایشی است و فقط برای اپلیکیشن‌های تایید شده در دسترس است\n- فقط تراکنش‌هایی که در وضعیت PAID هستند را نهایی کنید\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `WALLET_PAYMENT`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `CREATE_WALLET_PAYMENT`", "operationId": "Payment_CommitWalletTransaction", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentCommitWalletTransactionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentCommitWalletTransactionResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "CREATE_WALLET_PAYMENT" ] } ], "summary": "نهایی کردن تراکنش کیف پول", "tags": [ "Payment" ] } }, "/experimental/open-platform/wallet/payments/create": { "post": { "description": "این API امکان شروع تراکنش پرداخت از کیف پول دیوار کاربر را فراهم می‌کند. کاربر برای تکمیل پرداخت هدایت می‌شود و می‌توانید وضعیت تراکنش را پیگیری کنید.\n\n**نکات مهم**:\n- این قابلیت آزمایشی است و فقط برای اپلیکیشن‌های تایید شده در دسترس است\n- کاربر برای تکمیل تراکنش به آدرس پرداخت هدایت می‌شود\n- پس از پرداخت، کاربر به `redirect_url` مشخص شده شما هدایت می‌شود\n- از `RetrieveWalletTransaction` برای بررسی وضعیت پرداخت استفاده کنید\n- از `CommitWalletTransaction` برای نهایی کردن تراکنش پس از پرداخت موفق استفاده کنید\n\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `WALLET_PAYMENT`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `CREATE_WALLET_PAYMENT`", "operationId": "Payment_CreateWalletPayment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentCreateWalletPaymentRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentCreateWalletPaymentResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "CREATE_WALLET_PAYMENT" ] } ], "summary": "ایجاد پرداخت کیف پول", "tags": [ "Payment" ] } }, "/experimental/open-platform/wallet/payments/{token}": { "get": { "description": "این API امکان دریافت وضعیت فعلی و جزئیات تراکنش پرداخت کیف پول را فراهم می‌کند. برای تایید تکمیل پرداخت قبل از commit کردن تراکنش استفاده کنید.\n\n**نکات مهم**:\n- این قابلیت آزمایشی است و فقط برای اپلیکیشن‌های تایید شده در دسترس است\n- وضعیت‌های تراکنش: UNKNOWN، CREATED، EXPIRED، PAID، COMMITTED\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `WALLET_PAYMENT`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `CREATE_WALLET_PAYMENT`", "operationId": "Payment_RetrieveWalletTransaction", "parameters": [ { "description": "توکن تراکنشی که می‌خواهید دریافت کنید", "in": "path", "name": "token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentRetrieveWalletTransactionResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "CREATE_WALLET_PAYMENT" ] } ], "summary": "دریافت تراکنش کیف پول", "tags": [ "Payment" ] } }, "/v1/open-platform/add-ons/post/{token}": { "delete": { "description": "این API امکان حذف افزونه از یک آگهی را فراهم می‌کند. تمام افزونه‌های ایجاد شده توسط اپلیکیشن شما برای توکن آگهی مشخص شده حذف می‌شوند.\n\n**نکات مهم**:\n- فقط افزونه‌های ایجاد شده توسط اپلیکیشن شما قابل حذف هستند\n\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `ADD_ON_DELETE`", "operationId": "Addons_DeletePostAddon", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [] } ], "summary": "حذف افزونه آگهی", "tags": [ "Addons" ] } }, "/v1/open-platform/addons/business/{business_token}": { "post": { "description": "این API امکان ایجاد افزونه کسب‌وکار را فراهم می‌کند که روی تمام آگهی‌های منتشر شده یک کسب‌وکار نمایش داده می‌شود.\n\n**نکات مهم**:\n- ویجت‌ها باید معتبر بوده و از مشخصات فرمت ویجت پیروی کنند\n- مالکیت کسب‌وکار قبل از ایجاد افزونه بررسی می‌شود\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `BUSINESS_ADDON_CREATE`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `BUSINESS_ADDON_CREATE.business_token`", "operationId": "Addons_CreateBusinessAddon", "parameters": [ { "in": "path", "name": "business_token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddonsCreateBusinessAddonBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addonsCreateBusinessAddonResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "BUSINESS_ADDON_CREATE.business_token" ] } ], "summary": "ایجاد افزونه کسب‌وکار", "tags": [ "Addons" ] } }, "/v1/open-platform/addons/post/{token}": { "delete": { "description": "این API امکان حذف افزونه از یک آگهی را فراهم می‌کند. تمام افزونه‌های ایجاد شده توسط اپلیکیشن شما برای توکن آگهی مشخص شده حذف می‌شوند.\n\n**نکات مهم**:\n- فقط افزونه‌های ایجاد شده توسط اپلیکیشن شما قابل حذف هستند\n\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `ADD_ON_DELETE`", "operationId": "Addons_DeletePostAddon2", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [] } ], "summary": "حذف افزونه آگهی", "tags": [ "Addons" ] } }, "/v1/open-platform/addons/user/{id}": { "delete": { "description": "این API امکان حذف افزونه کاربر با شناسه را فراهم می‌کند. این کار افزونه کاربر و تمام افزونه‌های آگهی مرتبط را حذف می‌کند.\n\n**نکات مهم**:\n- فقط افزونه‌های کاربر ایجاد شده توسط اپلیکیشن شما قابل حذف هستند\n\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `USER_ADDON_DELETE`", "operationId": "Addons_DeleteUserAddon", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [] } ], "summary": "حذف افزونه کاربر", "tags": [ "Addons" ] } }, "/v1/open-platform/assets/body-status": { "get": { "description": "این API امکان دریافت گزینه‌های وضعیت بدنه موجود برای دسته‌بندی‌های خودرو را فراهم می‌کند.", "operationId": "Assets_GetBodyStatuses", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/assetsGetBodyStatusesResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "summary": "لیست گزینه‌های وضعیت بدنه", "tags": [ "Assets" ] } }, "/v1/open-platform/assets/brand-model/{category}": { "get": { "description": "این API امکان دریافت مدل برندها برای یک دسته‌بندی خاص را فراهم می‌کند. دسته‌بندی‌های پشتیبانی شده: `light` (خودرو) و `mobile-phones`.\n\n**نکات مهم**:\n- مدل برندها با نام‌های فارسی برگردانده می‌شوند\n- دسته‌بندی باید یکی از دسته‌بندی‌های پشتیبانی شده باشد، در غیر این صورت خطا برمی‌گردد", "operationId": "Assets_GetBrandModels", "parameters": [ { "in": "path", "name": "category", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/assetsGetBrandModelsResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "summary": "لیست مدل برندها بر اساس دسته‌بندی", "tags": [ "Assets" ] } }, "/v1/open-platform/assets/category": { "get": { "description": "این API امکان دریافت همه دسته‌بندی‌های دیوار را فراهم می‌کند. شناسه دسته‌بندی‌ها و نام‌های فارسی آنها برای استفاده در ثبت و جستجوی آگهی برمی‌گردد.", "operationId": "Assets_GetCategories", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/assetsGetCategoriesResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "summary": "لیست همه دسته‌بندی‌ها", "tags": [ "Assets" ] } }, "/v1/open-platform/assets/city": { "get": { "description": "این API امکان دریافت همه شهرهای دیوار را فراهم می‌کند. شناسه شهرها و نام‌های فارسی آنها برای استفاده در ثبت و جستجوی آگهی برمی‌گردد.", "operationId": "Assets_GetCities", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/assetsGetCitiesResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "summary": "لیست همه شهرها", "tags": [ "Assets" ] } }, "/v1/open-platform/assets/color/{category}": { "get": { "description": "این API امکان دریافت رنگ‌های موجود برای یک دسته‌بندی خاص را فراهم می‌کند. دسته‌بندی‌های پشتیبانی شده: `light` (خودرو) و `mobile-phones`.\n\n**نکات مهم**:\n- رنگ‌ها با نام‌های فارسی برگردانده می‌شوند\n- دسته‌بندی باید یکی از دسته‌بندی‌های پشتیبانی شده باشد، در غیر این صورت خطا برمی‌گردد", "operationId": "Assets_GetColors", "parameters": [ { "in": "path", "name": "category", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/assetsGetColorsResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "summary": "لیست رنگ‌ها بر اساس دسته‌بندی", "tags": [ "Assets" ] } }, "/v1/open-platform/assets/district": { "get": { "description": "این API امکان دریافت محله‌های دیوار را فراهم می‌کند. می‌توان بدون پارامتر برای دریافت همه محله‌ها یا با city_slug برای دریافت محله‌های یک شهر خاص فراخوانی کرد.", "operationId": "Assets_GetDistricts", "parameters": [ { "in": "query", "name": "city_slug", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/assetsGetDistrictsResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "summary": "لیست محله‌ها", "tags": [ "Assets" ] } }, "/v1/open-platform/assets/district/{city_slug}": { "get": { "description": "این API امکان دریافت محله‌های دیوار را فراهم می‌کند. می‌توان بدون پارامتر برای دریافت همه محله‌ها یا با city_slug برای دریافت محله‌های یک شهر خاص فراخوانی کرد.", "operationId": "Assets_GetDistricts2", "parameters": [ { "in": "path", "name": "city_slug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/assetsGetDistrictsResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "summary": "لیست محله‌ها", "tags": [ "Assets" ] } }, "/v1/open-platform/assets/internal-storage": { "get": { "description": "این API امکان دریافت گزینه‌های حافظه داخلی موجود برای دسته‌بندی‌های موبایل، تبلت و لپ‌تاپ را فراهم می‌کند.", "operationId": "Assets_GetInternalStorages", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/assetsGetInternalStoragesResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "summary": "لیست گزینه‌های حافظه داخلی", "tags": [ "Assets" ] } }, "/v1/open-platform/assets/oauth-scope": { "get": { "description": "این API لیست OAuth اسکوپ‌های موجود برای کنار دیوار را برمی‌گرداند. از این اسکوپ‌ها در جریان OAuth برای درخواست دسترسی به داده‌های کاربر استفاده کنید.\n\n**نکات مهم**:\n- هر اسکوپ شامل وضعیت چرخه حیات است (آزمایشی، فعال، در حال منسوخ شدن، منسوخ شده)\n- برخی اسکوپ‌ها نیاز به resource id دارند (مثلاً توکن آگهی، شناسه مکالمه)", "operationId": "Assets_GetOAuthScopes", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/assetsGetOAuthScopesResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "summary": "لیست دامنه‌های OAuth", "tags": [ "Assets" ] } }, "/v1/open-platform/assets/permission": { "get": { "description": "این API امکان دریافت مجوزهای موجود کنار دیوار را فراهم می‌کند. این مجوزها برای کنترل دسترسی در اپلیکیشن‌های کنار دیوار استفاده می‌شوند و با دامنه‌های OAuth متفاوت هستند.\n\n**نکات مهم**:\n- مجوزها برای استفاده داخلی هستند و اپلیکیشن‌ها نباید مستقیماً به آنها وابسته باشند\n- هر مجوز شامل وضعیت چرخه حیات آن است (آزمایشی، فعال، در حال منسوخ شدن، منسوخ شده)", "operationId": "Assets_GetPermissions", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/assetsGetPermissionsResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "summary": "لیست مجوزهای کنار دیوار", "tags": [ "Assets" ] } }, "/v1/open-platform/assets/ram-memory": { "get": { "description": "این API امکان دریافت گزینه‌های حافظه RAM موجود برای دسته‌بندی‌های موبایل، تبلت و لپ‌تاپ را فراهم می‌کند.", "operationId": "Assets_GetRamMemories", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/assetsGetRamMemoriesResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "summary": "لیست گزینه‌های حافظه RAM", "tags": [ "Assets" ] } }, "/v1/open-platform/assets/service-type": { "get": { "description": "این API امکان دریافت انواع سرویس موجود در کنار دیوار را فراهم می‌کند. انواع سرویس برای گروه‌بندی سرویس‌های مشابه استفاده می‌شوند.\n\n**نکات مهم**:\n- می‌توان انواع سرویس جدید را در صورت نیاز درخواست داد", "operationId": "Assets_GetServiceTypes", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/assetsGetServiceTypesResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "summary": "لیست انواع سرویس", "tags": [ "Assets" ] } }, "/v1/open-platform/assets/submit-schema/{category_slug}": { "get": { "description": "این API به شما امکان دریافت قالب ثبت آگهی برای یک دسته‌بندی مشخص را می‌دهد. پاسخ در قالب JSON Schema است.\n\nقالب تعریف کننده ساختار و قوانین برای فیلدهای فرم زمانی که آگهی در یک دسته‌بندی مشخص ثبت می‌شود. هر فیلد در قالب می‌تواند یکی از انواع زیر را داشته باشد:\n\n**انواع اصلی:**\n- `string`: فیلدهای ورودی متنی (مانند عنوان، توضیحات، مقادیر زمانی)\n- `integer`: فیلدهای ورودی عددی برای اعداد صحیح (مانند قیمت، تعداد، اندازه)\n- `float`: فیلدهای ورودی عددی برای اعداد اعشاری\n- `boolean`: فیلدهای ورودی بولین (صحیح/غلط)\n- `array`: فیلدهای ورودی چندگانه که امکان انتخاب چند مقدار را دارند\n\n**فیلدهای Enum:**\nفیلدها با گزینه‌های پیش‌تعریف شده از `enum` و `enumNames` استفاده می‌کنند:\n- `enum`: آرایه از مقادیر داخلی استفاده شده برای ارتباط API\n- `enumNames`: آرایه از برچسب‌های نمایشی نشان داده شده به کاربر (معمولاً به زبان فارسی)\n- اینها برای فیلدهای ورودی چندگانه (مانند انتخاب طبقه، امکان استفاده از پارکینگ) استفاده می‌شوند\n\n**فیلدهای آرایه با Enum:**\nفیلدهای ورودی چندگانه ترکیب `type: \"array\"` با کلید Enum را دارند:\n- `items.enum`: گزینه‌های موجود برای انتخاب\n- `items.enumNames`: برچسب‌های نمایشی برای هر گزینه\n- کاربران می‌توانند چند مقدار را انتخاب کنند (مانند امکانات رفاهی، سیستم‌های گرمایش)\n\n**ویژگی‌های فیلد:**\n- `title`: نام نمایشی فارسی برای فیلد\n- `required`: آرایه از نام فیلدهای اجباری که باید ارائه شوند\n- `type`: نوع داده فیلد\n\n**مثال استفاده:**\n```json\n{\n \"properties\": {\n \"size\": {\n \"title\": \"متراژ (متر مربع)\",\n \"type\": \"integer\"\n },\n \"elevator\": {\n \"enum\": [\"دارد\", \"ندارد\"],\n \"enumNames\": [\"دارد\", \"ندارد\"],\n \"title\": \"آسانسور\",\n \"type\": \"string\"\n },\n \"comfort_amenities\": {\n \"items\": {\n \"enum\": [\"اینترنت_پرسرعت\", \"تلویزیون\"],\n \"enumNames\": [\"اینترنت پرسرعت\", \"تلویزیون\"],\n \"type\": \"string\"\n },\n \"title\": \"امکانات رفاهی\",\n \"type\": \"array\"\n }\n }\n}\n```", "operationId": "Assets_GetSubmitSchema", "parameters": [ { "in": "path", "name": "category_slug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/assetsGetSubmitSchemaResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "summary": "دریافت schema ثبت آگهی", "tags": [ "Assets" ] } }, "/v1/open-platform/chat/bot/conversations/{conversation_id}/messages": { "post": { "description": "این API امکان ارسال پیام از ربات چت شما به یک مکالمه یا کاربر را فراهم می‌کند. می‌توانید این API را با conversation_id یا user_id فراخوانی کنید.\n\n**نکات مهم**:\n- هنگام استفاده از user_id، باید با شناسه مبهم شده کاربر احراز هویت شده مطابقت داشته باشد\n- یا پیام متنی یا توکن رسانه باید ارسال شود (نه هر دو)\n- می‌توان شبکه دکمه‌ها را به پیام ضمیمه کرد\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `CHAT_BOT_SEND_MESSAGE`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `CHAT_BOT_USER_MESSAGE_SEND`", "operationId": "ChatAPI_ChatBotSendMessage", "parameters": [ { "description": "شناسه منحصر به فرد برای مکالمه", "in": "path", "name": "conversation_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/ChatAPIChatBotSendMessageBody" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chatapiChatBotSendMessageResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "CHAT_BOT_USER_MESSAGE_SEND" ] } ], "summary": "ارسال پیام به مکالمه چت‌بات", "tags": [ "ChatAPI" ] } }, "/v1/open-platform/chat/bot/users/{user_id}/messages": { "post": { "description": "این API امکان ارسال پیام از ربات چت شما به یک مکالمه یا کاربر را فراهم می‌کند. می‌توانید این API را با conversation_id یا user_id فراخوانی کنید.\n\n**نکات مهم**:\n- هنگام استفاده از user_id، باید با شناسه مبهم شده کاربر احراز هویت شده مطابقت داشته باشد\n- یا پیام متنی یا توکن رسانه باید ارسال شود (نه هر دو)\n- می‌توان شبکه دکمه‌ها را به پیام ضمیمه کرد\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `CHAT_BOT_SEND_MESSAGE`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `CHAT_BOT_USER_MESSAGE_SEND`", "operationId": "ChatAPI_ChatBotSendMessage2", "parameters": [ { "description": "شناسه منحصر به فرد کاربر برای شروع یا ادامه مکالمه", "in": "path", "name": "user_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/ChatAPIChatBotSendMessageBody" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chatapiChatBotSendMessageResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "CHAT_BOT_USER_MESSAGE_SEND" ] } ], "summary": "ارسال پیام به مکالمه چت‌بات", "tags": [ "ChatAPI" ] } }, "/v1/open-platform/chat/conversations/{conversation_id}": { "get": { "description": "این API امکان دریافت مکالمه و پیام‌های آن با شناسه مکالمه را فراهم می‌کند. جزئیات مکالمه و پیام‌های متنی تا زمان انقضای توکن OAuth برمی‌گردد.\n\n**نکات مهم**:\n- فقط پیام‌های متنی برگردانده می‌شوند (سایر انواع پیام فیلتر می‌شوند)\n- پیام‌ها به ترتیب صعودی برگردانده می‌شوند\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `CHAT_READ_CONVERSATION`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `CHAT_CONVERSATION_READ.conversation_id`", "operationId": "ChatAPI_GetConversation", "parameters": [ { "description": "شناسه منحصر به فرد برای مکالمه", "in": "path", "name": "conversation_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chatapiGetConversationResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "CHAT_CONVERSATION_READ.conversation_id" ] } ], "summary": "دریافت مکالمه", "tags": [ "ChatAPI" ] } }, "/v1/open-platform/events/subscriptions": { "post": { "description": "این API امکان اشتراک در رویدادها برای دریافت اعلان‌ها از طریق webhook هنگام وقوع رویدادها را فراهم می‌کند. پس از اشتراک، هنگام وقوع رویداد مربوطه در آدرس webhook شما مطلع خواهید شد.\n\n**نکات مهم**:\n- برای رویداد `NEW_MESSAGE_ON_POST`: نیاز به اسکوپ `CHAT_POST_CONVERSATIONS_READ.post_token` یا `CHAT_SUPPLIER_ALL_CONVERSATIONS_READ`\n- برای رویداد `POST_UPDATE`: نیاز به اسکوپ `USER_POSTS_GET`\n- آدرس webhook باید در پنل ارائه‌دهندگان برای اپلیکیشن شما تنظیم شده باشد\n- برخی رویدادها به صورت پیش‌فرض فعال هستند و نیازی به اشتراک ندارند (مثل پیام‌های ربات چت)\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `EVENTS_REGISTER_SUBSCRIPTION`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `CHAT_POST_CONVERSATIONS_READ.post_token` یا `CHAT_SUPPLIER_ALL_CONVERSATIONS_READ` یا `USER_POSTS_GET`", "operationId": "Events_RegisterEventSubscription", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eventsRegisterEventSubscriptionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eventsRegisterEventSubscriptionResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "CHAT_POST_CONVERSATIONS_READ.post_token", "CHAT_SUPPLIER_ALL_CONVERSATIONS_READ", "USER_POSTS_GET" ] } ], "summary": "اشتراک در رویداد", "tags": [ "Events" ] } }, "/v1/open-platform/finder/post/{token}": { "get": { "description": "این API امکان دریافت داده‌های عمومی آگهی با توکن را فراهم می‌کند. جزئیات آگهی شامل داده‌های دسته‌بندی، موقعیت، وضعیت، زمان‌ها و اطلاعات کسب‌وکار برمی‌گردد.\n\n**نکات مهم**:\n- فقط داده‌های عمومی آگهی برگردانده می‌شوند (فیلدهای خصوصی حذف می‌شوند)\n- می‌توان هر آگهی منتشر شده‌ای را دریافت کرد، محدود به آگهی‌های خود کاربر نیست\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `GET_POST`", "operationId": "Finder_GetPost", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finderGetPostResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [] } ], "summary": "دریافت آگهی دیوار", "tags": [ "Finder" ] } }, "/v1/open-platform/finder/user-posts": { "get": { "description": "این API امکان دریافت لیست آگهی‌های متعلق به کاربر احراز هویت شده را فراهم می‌کند. اطلاعات پایه شامل توکن، عنوان، تصاویر، دسته‌بندی و وضعیت نمایش شماره تلفن برمی‌گردد.\n\n**نکات مهم**:\n- فقط آگهی‌های متعلق به کاربر احراز هویت شده برگردانده می‌شوند\n- آگهی‌ها در وضعیت‌های مختلف برگردانده می‌شوند: منتشر شده، در انتظار پرداخت، در انتظار بررسی یا نیازمند اصلاح\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `GET_USER_POSTS`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `USER_POSTS_GET`", "operationId": "Finder_GetUserPosts", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finderGetUserPostsResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "USER_POSTS_GET" ] } ], "summary": "دریافت آگهی‌های کاربر", "tags": [ "Finder" ] } }, "/v1/open-platform/get-user-id-by-phone": { "post": { "description": "این API امکان پیدا کردن شناسه کاربر با شماره تلفن را می‌دهد. مناسب برای یکپارچه‌سازی با سیستم‌های CRM یا پشتیبانی.\n\n**نکات مهم**:\n- شناسه مبهم‌شده برمی‌گردد (یکتا برای هر اپلیکیشن، نه شناسه واقعی کاربر دیوار)\n\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `GET_USER_ID_BY_PHONE`", "operationId": "Finder_GetUserIDByPhone", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finderGetUserIDByPhoneRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finderGetUserIDByPhoneResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [] } ], "summary": "دریافت شناسه کاربر", "tags": [ "Finder" ] } }, "/v1/open-platform/payment-ticket/validate": { "post": { "description": "این API امکان اعتبارسنجی تیکت پرداخت و دریافت payload صادرکننده آن را فراهم می‌کند. برای تایید تیکت‌های ارائه شده توسط کاربران جهت یکپارچه‌سازی با سرویس‌های دیوار استفاده کنید.\n\n**نکات مهم**:\n- این API توسط اپلیکیشن‌های کنار برای اعتبارسنجی تیکت‌ها استفاده می‌شود\n- پاسخ شامل payload ارائه شده توسط صادرکننده است\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `PAYMENT_TICKET_VALIDATE`", "operationId": "PaymentTicket_Validate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_ticketValidateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment_ticketValidateResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [] } ], "summary": "اعتبارسنجی تیکت پرداخت", "tags": [ "PaymentTicket" ] } }, "/v1/open-platform/post/image-upload-url": { "get": { "deprecated": true, "description": "این API آدرس آپلود برای بارگذاری تصاویر آگهی را برمی‌گرداند.\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `UPLOAD_POST_IMAGE`", "operationId": "Post_GetImageUploadURL", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postGetImageUploadURLResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [] } ], "summary": "دریافت آدرس اپلود تصاویر آگهی (منسوخ شده)", "tags": [ "Post" ] } }, "/v1/open-platform/post/{post_token}": { "delete": { "description": "این API امکان حذف آگهی را فراهم می‌کند. فقط آگهی‌های متعلق به کاربر احراز هویت شده قابل حذف هستند.\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `DELETE_USER_POST`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `DELETE_USER_POST`", "operationId": "Post_DeleteUserPost", "parameters": [ { "description": "توکن آگهی برای حذف", "in": "path", "name": "post_token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postDeleteUserPostResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "DELETE_USER_POST" ] } ], "summary": "حذف آگهی", "tags": [ "Post" ] }, "put": { "deprecated": true, "description": "این API امکان ویرایش آگهی را فراهم می‌کند. می‌توانید عنوان، توضیحات و تصاویر آگهی را به‌روزرسانی کنید.\n\n**نکات مهم**:\n- عنوان باید بین 3 تا 50 کاراکتر باشد\n- آگهی نباید منقضی شده باشد\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `EDIT_POST`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `POST_EDIT.post_token`", "operationId": "Post_EditPost", "parameters": [ { "in": "path", "name": "post_token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostEditPostBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postEditPostResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "POST_EDIT.post_token" ] } ], "summary": "ویرایش آگهی", "tags": [ "Post" ] } }, "/v1/open-platform/post/{post_token}/pricing": { "get": { "description": "این API امکان دریافت اطلاعات قیمت‌گذاری برای خدمات مرتبط با آگهی را فراهم می‌کند. قبل از انجام عملیات‌های پولی مانند نردبان، تمدید یا ثبت آگهی از این برای بررسی هزینه‌ها استفاده کنید.\n\n**نکات مهم**:\n- قیمت‌گذاری مختص اپلیکیشن شما است و ممکن است با قیمت‌گذاری استاندارد دیوار متفاوت باشد\n- قیمت‌ها ممکن است بر اساس دسته‌بندی و شهر آگهی متفاوت باشند\n- فلگ `available` نشان می‌دهد که آیا سرویس برای این آگهی قابل اعمال است\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `POST_PRICING_RETRIEVE`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `PAYMENT_ALL_POSTS_PRICING_READ`", "operationId": "Payment_GetPostPricing", "parameters": [ { "description": "شناسه منحصر به فرد 8-9 کاراکتری برای آگهی", "in": "path", "name": "post_token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentGetPostPricingResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "PAYMENT_ALL_POSTS_PRICING_READ" ] } ], "summary": "دریافت قیمت خدمات آگهی", "tags": [ "Payment" ] } }, "/v1/open-platform/semantic/user/{phone}": { "delete": { "description": "این API امکان حذف اطلاعات معنایی یک کاربر را فراهم می‌کند.\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `USER_SEMANTIC_DELETE`", "operationId": "Semantic_DeleteUserSemantic", "parameters": [ { "description": "شماره موبایل کاربر", "in": "path", "name": "phone", "required": true, "schema": { "type": "string" } }, { "description": "شناسه کاربر دیوار", "in": "query", "name": "divar_user_id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/semanticDeleteUserSemanticResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [] } ], "summary": "حذف اطلاعات معنایی کاربر", "tags": [ "Semantic" ] }, "post": { "description": "این API امکان ایجاد یا به‌روزرسانی semantic کاربر بدون افزودن افزونه را می‌دهد.\n\n**نکات مهم**:\n- امکان ارسال اطلاعات معنایی و تیکت پرداخت (اختیاری) وجود دارد\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `USER_SEMANTIC_CREATE`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `USER_VERIFICATION_CREATE`", "operationId": "Semantic_CreateUserSemantic", "parameters": [ { "description": "شماره موبایل کاربر", "in": "path", "name": "phone", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/SemanticCreateUserSemanticBody" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/semanticCreateUserSemanticResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "USER_VERIFICATION_CREATE" ] } ], "summary": "ایجاد اطلاعات معنایی کاربر", "tags": [ "Semantic" ] } }, "/v1/open-platform/semantic/users/{divar_user_id}": { "delete": { "description": "این API امکان حذف اطلاعات معنایی یک کاربر را فراهم می‌کند.\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `USER_SEMANTIC_DELETE`", "operationId": "Semantic_DeleteUserSemantic2", "parameters": [ { "description": "شناسه کاربر دیوار", "in": "path", "name": "divar_user_id", "required": true, "schema": { "type": "string" } }, { "description": "شماره موبایل کاربر", "in": "query", "name": "phone", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/semanticDeleteUserSemanticResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [] } ], "summary": "حذف اطلاعات معنایی کاربر", "tags": [ "Semantic" ] }, "post": { "description": "این API امکان ایجاد یا به‌روزرسانی semantic کاربر بدون افزودن افزونه را می‌دهد.\n\n**نکات مهم**:\n- امکان ارسال اطلاعات معنایی و تیکت پرداخت (اختیاری) وجود دارد\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `USER_SEMANTIC_CREATE`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `USER_VERIFICATION_CREATE`", "operationId": "Semantic_CreateUserSemantic2", "parameters": [ { "description": "شناسه کاربر دیوار", "in": "path", "name": "divar_user_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/SemanticCreateUserSemanticBody" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/semanticCreateUserSemanticResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "USER_VERIFICATION_CREATE" ] } ], "summary": "ایجاد اطلاعات معنایی کاربر", "tags": [ "Semantic" ] } }, "/v1/open-platform/user-payments": { "post": { "description": "این API امکان گزارش پرداخت انجام شده توسط کاربر به سرویس شما را فراهم می‌کند. از این برای اطلاع‌رسانی دیوار درباره تراکنش‌هایی که کاربران از طریق پلتفرم شما پرداخت می‌کنند استفاده کنید.\n\n**نکات مهم**:\n- باید پرداخت‌ها را در بازه زمانی توافق شده گزارش دهید\n- `reference_id` باید برای هر تراکنش منحصر به فرد باشد (برای تسویه حساب استفاده می‌شود)\n- شناسه خدماتی که کاربر برای آنها پرداخت کرده را لیست کنید (مثلاً 'banner', 'title_refinement')\n- این داده‌ها برای تقسیم درآمد و گزارش مالی استفاده می‌شوند\n\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `SUBMIT_USER_PAYMENT`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `SUBMIT_USER_PAYMENT`", "operationId": "Payment_SubmitUserPayment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentSubmitUserPaymentRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentSubmitUserPaymentResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "SUBMIT_USER_PAYMENT" ] } ], "summary": "ثبت رکورد پرداخت کاربر", "tags": [ "Payment" ] } }, "/v1/open-platform/user-post/{token}": { "get": { "description": "این API امکان دریافت اطلاعات دقیق یک آگهی شامل داده‌های عمومی، داده‌های دسته‌بندی، داده‌های کسب‌وکار، وضعیت و دلیل رد را فراهم می‌کند. فقط آگهی‌های متعلق به کاربر احراز هویت شده قابل دریافت هستند.\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `GET_USER_POST`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `USER_POSTS_GET`", "operationId": "Post_GetUserPost", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postGetUserPostResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "USER_POSTS_GET" ] } ], "summary": "دریافت آگهی با توکن", "tags": [ "Post" ] } }, "/v1/open-platform/user/businesses": { "get": { "description": "این API امکان دریافت تمام کسب‌وکارهای مرتبط با کاربر احراز هویت شده را فراهم می‌کند، همراه با نقش کاربر در هر کسب‌وکار.\n\n**نکات مهم**:\n- تمام کسب‌وکارهایی که کاربر در آنها نقش دارد (مثلاً مالک یا همکار) را برمی‌گرداند\n- شامل اطلاعات کسب‌وکار مانند business_token، business_type، brand_name و نقش کاربر است\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `GET_USER_BUSINESSES`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `USER_BUSINESSES_READ`", "operationId": "Finder_GetUserBusinesses", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finderGetUserBusinessesResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "USER_BUSINESSES_READ" ] } ], "summary": "دریافت کسب‌وکارهای کاربر", "tags": [ "Finder" ] } }, "/v1/open-platform/users": { "get": { "description": "این API اطلاعات کاربر احراز هویت شده را برمی‌گرداند. داده‌های برگشتی به OAuth اسکوپ‌های اعطا شده بستگی دارد.\n\n**نکات مهم**:\n- با اسکوپ `USER_PHONE`: شماره تلفن کاربر برمی‌گردد\n- با اسکوپ `USER_ID`: شناسه مبهم‌شده کاربر برمی‌گردد (یکتا برای هر اپلیکیشن)\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `USER_RETRIEVE`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `USER_ID` یا `USER_PHONE`", "operationId": "Finder_GetUser2", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finderUser" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "USER_ID", "USER_PHONE" ] } ], "summary": "دریافت اطلاعات کاربر", "tags": [ "Finder" ] }, "post": { "description": "این API اطلاعات کاربر احراز هویت شده را برمی‌گرداند. داده‌های برگشتی به OAuth اسکوپ‌های اعطا شده بستگی دارد.\n\n**نکات مهم**:\n- با اسکوپ `USER_PHONE`: شماره تلفن کاربر برمی‌گردد\n- با اسکوپ `USER_ID`: شناسه مبهم‌شده کاربر برمی‌گردد (یکتا برای هر اپلیکیشن)\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `USER_RETRIEVE`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `USER_ID` یا `USER_PHONE`", "operationId": "Finder_GetUser", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finderGetUserRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finderUser" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "USER_ID", "USER_PHONE" ] } ], "summary": "دریافت اطلاعات کاربر", "tags": [ "Finder" ] } }, "/v2/open-platform/addons/post/{token}": { "post": { "description": "این API امکان ایجاد افزونه متصل به یک آگهی خاص را فراهم می‌کند. افزونه در صفحه جزئیات آگهی نمایش داده می‌شود.\n\n**نکات مهم**:\n- ویجت‌ها باید معتبر بوده و از مشخصات فرمت ویجت پیروی کنند\n- مسیرهای معنایی از ویجت‌ها برای دسته‌بندی استخراج می‌شوند\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `ADD_ON_CREATE`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `POST_ADDON_CREATE.post_token` یا `USER_POSTS_ADDON_CREATE`", "operationId": "Addons_CreatePostAddonV2", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddonsCreatePostAddonV2Body" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addonsCreatePostAddonResponseV2" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "POST_ADDON_CREATE.post_token", "USER_POSTS_ADDON_CREATE" ] } ], "summary": "ایجاد افزونه آگهی", "tags": [ "Addons" ] } }, "/v2/open-platform/addons/user/{phone}": { "post": { "description": "این API امکان ایجاد افزونه کاربر را فراهم می‌کند که به صورت خودکار به تمام آگهی‌های کاربر متصل می‌شود. افزونه برای آگهی‌های آینده اعمال شده و همچنین تا 30 آگهی اخیر به عقب برمی‌گردد.\n\n**نکات مهم**:\n- می‌توان دسته‌بندی‌ها را برای فیلتر کردن آگهی‌هایی که افزونه دریافت می‌کنند مشخص کرد\n- ویجت‌ها باید معتبر بوده و از مشخصات فرمت ویجت پیروی کنند\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `USER_ADDON_CREATE`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `USER_ADDON_CREATE`", "operationId": "Addons_CreateUserAddonV2", "parameters": [ { "in": "path", "name": "phone", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/AddonsCreateUserAddonV2Body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addonsCreateUserAddonResponseV2" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "USER_ADDON_CREATE" ] } ], "summary": "ایجاد افزونه کاربر", "tags": [ "Addons" ] } }, "/v2/open-platform/addons/users/{divar_user_id}": { "post": { "description": "این API امکان ایجاد افزونه کاربر را فراهم می‌کند که به صورت خودکار به تمام آگهی‌های کاربر متصل می‌شود. افزونه برای آگهی‌های آینده اعمال شده و همچنین تا 30 آگهی اخیر به عقب برمی‌گردد.\n\n**نکات مهم**:\n- می‌توان دسته‌بندی‌ها را برای فیلتر کردن آگهی‌هایی که افزونه دریافت می‌کنند مشخص کرد\n- ویجت‌ها باید معتبر بوده و از مشخصات فرمت ویجت پیروی کنند\n\n#### دسترسی‌ها:\n\n##### OAuth اسکوپ موردنیاز:\n\n- `USER_ADDON_CREATE`", "operationId": "Addons_CreateUserAddonV22", "parameters": [ { "in": "path", "name": "divar_user_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/AddonsCreateUserAddonV2Body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addonsCreateUserAddonResponseV2" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "USER_ADDON_CREATE" ] } ], "summary": "ایجاد افزونه کاربر", "tags": [ "Addons" ] } }, "/v2/open-platform/conversations/{conversation_id}/messages": { "post": { "description": "این API امکان ارسال پیام متنی یا رسانه به یک مکالمه را فراهم می‌کند. اگر مکالمه وجود نداشته باشد، به صورت خودکار ایجاد می‌شود.\n\n**نکات مهم**:\n- یا پیام متنی یا توکن رسانه باید ارسال شود (نه هر دو)\n- می‌توان شبکه دکمه‌ها را برای فرستنده و گیرنده ضمیمه کرد\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `CHAT_SEND_MESSAGE_OAUTH`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `CHAT_POST_CONVERSATIONS_MESSAGE_SEND.post_token` یا `CHAT_SUPPLIER_ALL_CONVERSATIONS_MESSAGE_SEND` یا `CONVERSATION_SEND_MESSAGE.conversation_id`", "operationId": "ChatAPI_ConversationSendMessage", "parameters": [ { "description": "شناسه منحصر به فرد برای مکالمه", "in": "path", "name": "conversation_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatAPIConversationSendMessageBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chatapiConversationSendMessageResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "CHAT_POST_CONVERSATIONS_MESSAGE_SEND.post_token", "CHAT_SUPPLIER_ALL_CONVERSATIONS_MESSAGE_SEND", "CONVERSATION_SEND_MESSAGE.conversation_id" ] } ], "summary": "ارسال پیام به مکالمه", "tags": [ "ChatAPI" ] } }, "/v2/open-platform/finder/post": { "post": { "description": "این API امکان جستجوی آگهی‌های منتشر شده دیوار با فیلتر را فراهم می‌کند. می‌توانید بر اساس دسته‌بندی، شهر، محله و فیلدهای ویژه دسته‌بندی مانند محدوده قیمت، متراژ، تعداد اتاق و سال تولید فیلتر کنید.\n\n**نکات مهم**:\n- آگهی‌ها بر اساس زمان آخرین تغییر مرتب می‌شوند\n- فقط آگهی‌های منتشر شده برگردانده می‌شوند\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `SEARCH_POST`", "operationId": "Finder_SearchPostV2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finderSearchPostsV2Request" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finderSearchPostV2Response" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [] } ], "summary": "جستجوی آگهی‌های دیوار", "tags": [ "Finder" ] } }, "/v2/open-platform/post/upload-urls": { "get": { "description": "این API امکان دریافت آدرس‌های آپلود برای بارگذاری تصاویر و ویدیوهای آگهی را فراهم می‌کند. می‌توانید تصاویر/ویدیوها را با درخواست POST یا PUT با کدگذاری باینری به آدرس برگشتی آپلود کنید.\n\n**نکات مهم**:\n- آدرس برگشتی برای آپلود نیاز به api-key شما دارد\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `UPLOAD_POST_IMAGE`", "operationId": "Post_GetUploadURLsV2", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postGetUploadURLsV2Response" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [] } ], "summary": "دریافت آدرس آپلود تصاویر و ویدیو", "tags": [ "Post" ] } }, "/v2/open-platform/post/{post_token}": { "put": { "description": "این API امکان ویرایش آگهی با پشتیبانی از field mask را فراهم می‌کند. می‌توانید عنوان، توضیحات، تصاویر، موقعیت، فیلدهای ویژه دسته‌بندی و سایر ویژگی‌ها را به‌روزرسانی کنید.\n\n**نکات مهم**:\n- فیلدهای ویژه دسته‌بندی باید از [قالب](https://kenar.divar.dev/openapi-doc/assets-get-submit-schema/) پیروی کنند\n- از `update_mask` برای مشخص کردن فیلدهای مورد به‌روزرسانی استفاده کنید\n- هنگام استفاده از اسکوپ `EDIT_USER_POST`، آگهی باید متعلق به کاربر احراز هویت شده باشد\n- آگهی نباید منقضی شده باشد\n\n#### دسترسی‌ها:\n\n##### مجوزهای API Key مورد نیاز:\n\n- `EDIT_POST`\n\n##### OAuth اسکوپ موردنیاز:\n\n- `EDIT_USER_POST` یا `POST_EDIT.post_token`", "operationId": "Post_EditPostV2", "parameters": [ { "description": "توکن آگهی", "in": "path", "name": "post_token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostEditPostV2Body" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/postEditPostResponse" } } }, "description": "پاسخ موفقیت‌آمیز." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/googlerpcStatus" } } }, "description": "پاسخ خطای غیرمنتظره." } }, "security": [ { "APIKey": [], "OAuth": [ "EDIT_USER_POST", "POST_EDIT.post_token" ] } ], "summary": "ویرایش آگهی (پیشرفته)", "tags": [ "Post" ] } } }, "security": [ { "APIKey": [] } ], "servers": [ { "url": "https://open-api.divar.ir" } ], "tags": [ { "description": ":::warning\nلطفاً قبل از شروع توسعه برنامه، تیکت پشتیبانی ایجاد کنید و ایده کسب‌وکار خود را با تیم کنار دیوار در میان بگذارید تا از همسویی برنامه شما با سیاست‌ها و اهداف کنار دیوار اطمینان حاصل شود.\n:::", "name": "Addons", "x-displayName": "افزونه‌ها" }, { "description": ":::warning\nلطفاً قبل از شروع توسعه برنامه، تیکت پشتیبانی ایجاد کنید و ایده کسب‌وکار خود را با تیم کنار دیوار در میان بگذارید تا از همسویی برنامه شما با سیاست‌ها و اهداف کنار دیوار اطمینان حاصل شود.\n:::", "name": "Assets", "x-displayName": "اطلاعات پایه" }, { "description": ":::warning\nلطفاً قبل از شروع توسعه برنامه، تیکت پشتیبانی ایجاد کنید و ایده کسب‌وکار خود را با تیم کنار دیوار در میان بگذارید تا از همسویی برنامه شما با سیاست‌ها و اهداف کنار دیوار اطمینان حاصل شود.\n:::", "name": "ChatAPI", "x-displayName": "چت" }, { "description": ":::warning\nلطفاً قبل از شروع توسعه برنامه، تیکت پشتیبانی ایجاد کنید و ایده کسب‌وکار خود را با تیم کنار دیوار در میان بگذارید تا از همسویی برنامه شما با سیاست‌ها و اهداف کنار دیوار اطمینان حاصل شود.\n:::", "name": "Events", "x-displayName": "رویدادها" }, { "description": ":::warning\nلطفاً قبل از شروع توسعه برنامه، تیکت پشتیبانی ایجاد کنید و ایده کسب‌وکار خود را با تیم کنار دیوار در میان بگذارید تا از همسویی برنامه شما با سیاست‌ها و اهداف کنار دیوار اطمینان حاصل شود.\n:::", "name": "Finder", "x-displayName": "جستجوگر" }, { "description": ":::warning\nلطفاً قبل از شروع توسعه برنامه، تیکت پشتیبانی ایجاد کنید و ایده کسب‌وکار خود را با تیم کنار دیوار در میان بگذارید تا از همسویی برنامه شما با سیاست‌ها و اهداف کنار دیوار اطمینان حاصل شود.\n:::\n\nAPIهای پرداخت و تراکنش برای مدیریت موجودی اپلیکیشن، خدمات مرتبط با آگهی (نردبان، تمدید، انتشار) و پرداخت‌های کیف پول. برخی APIها محدود به اپلیکیشن‌های تایید شده هستند - برای دسترسی با تیم دیوار تماس بگیرید.", "name": "Payment", "x-displayName": "پرداخت" }, { "description": ":::warning\nلطفاً قبل از شروع توسعه برنامه، تیکت پشتیبانی ایجاد کنید و ایده کسب‌وکار خود را با تیم کنار دیوار در میان بگذارید تا از همسویی برنامه شما با سیاست‌ها و اهداف کنار دیوار اطمینان حاصل شود.\n:::", "name": "PaymentTicket", "x-displayName": "تیکت پرداخت" }, { "description": ":::warning\nلطفاً قبل از شروع توسعه برنامه، تیکت پشتیبانی ایجاد کنید و ایده کسب‌وکار خود را با تیم کنار دیوار در میان بگذارید تا از همسویی برنامه شما با سیاست‌ها و اهداف کنار دیوار اطمینان حاصل شود.\n:::", "name": "Post", "x-displayName": "آگهی" }, { "description": ":::warning\nلطفاً قبل از شروع توسعه برنامه، تیکت پشتیبانی ایجاد کنید و ایده کسب‌وکار خود را با تیم کنار دیوار در میان بگذارید تا از همسویی برنامه شما با سیاست‌ها و اهداف کنار دیوار اطمینان حاصل شود.\n:::", "name": "Semantic", "x-displayName": "اطلاعات معنایی" } ] }