• Classified Listing Docs
    • Classified Listing Plugin
    • Classified Listing All Addons
    • Classified Listing Mobile App
    • Classima Mobile APP
    • Listygo Mobile App
    • Homlisti Mobile App
  • Woocommerce Plugins Docs
    • ShopBuilder Elementor Addon
    • Woo Variation Swatches
    • Woo Variation Gallery
    • Zilly Mobile App
  • General Plugins Docs
    • The Post Grid
    • Testimonial Slider
    • Team Members
    • Food Menu
    • Review & Schema
    • Portfolio
    • Business Review
  • Our Plugins
    • The Post Grid
    • Classified Listing
    • ShopBuilder
    • Food Menu
    • Team
    • Portfolio
    • Testimonial Slider
    • Review & Schema
    • See All Plugins
×
  • Classified Listing Docs
    • Classified Listing Plugin
    • Classified Listing All Addons
    • Classified Listing Mobile App
    • Classima Mobile APP
    • Listygo Mobile App
    • Homlisti Mobile App
  • Woocommerce Plugins Docs
    • ShopBuilder Elementor Addon
    • Woo Variation Swatches
    • Woo Variation Gallery
    • Zilly Mobile App
  • General Plugins Docs
    • The Post Grid
    • Testimonial Slider
    • Team Members
    • Food Menu
    • Review & Schema
    • Portfolio
    • Business Review
  • Our Plugins
    • The Post Grid
    • Classified Listing
    • ShopBuilder
    • Food Menu
    • Team
    • Portfolio
    • Testimonial Slider
    • Review & Schema
    • See All Plugins

Getting Started

4
  • System Requirements
  • Installation
  • Permalink Settings
  • How to use(video)

Main Settings

15
  • Overview
  • General Settings
  • All Listings Page
  • Listing Details Page
  • Payments
  • Tax
  • Email
  • Account & Policy
  • Style
  • MISC Settings
  • Chat Settings Pro
  • Page Setup & Permalink
  • Tools
  • App Settings
  • Membership [Store addon] Pro

Email Settings

3
  • General Settings
  • Email Template
  • Video (How to Use)

Developer Docs

1
  • Developer Docs

Listing Management [Admin]

9
  • Admin End Ads View
  • Category
  • Locations
  • Listing Type
  • Pricing
  • Payment History
  • Export & Import Settings
  • Default Import [XML]
  • Stores [store addon]

AI Integration

5
  • Create Form with AI
  • Frontend AI Integration
  • AI Integration Settings
  • AI Semantic Search
  • AI Image Enhancement

Radius Booking Integration

10
  • How to Use (Video)
  • Integration with Radius Booking
  • Radius Booking Field in Form Builder
  • Enable Radius Booking on Existing Listing
  • Payout Settings
  • Payout Request from Front End Dashboard
  • Payout Request on Admin Panel
  • Commission Overview — Admin Panel
  • My Account – Booking
  • Appointments – Admin Panel

Theming

4
  • Add theme support for plugin templates
  • Override Ad Submission Form
  • Override ad detail page
  • Theming

REST API

54
  • Form Builder Image Sort REST API
  • Form Builder Image Delete REST API
  • Form Builder File Delete REST API
  • Form Builder File Upload REST API
  • Create Listing via Form Builder REST API
  • Email Store Owner REST API
  • Get Single Store REST API
  • Get Store Listings REST API
  • Get Stores REST API
  • Upload My Store Banner REST API
  • Upload My Store Logo REST API
  • My Store REST API
  • My Store REST API
  • Report Listing REST API
  • Update Subscription Payment Method API
  • Cancel Subscription REST API
  • Get Pricing Plans REST API
  • Get Single Payment / Order Details REST API
  • Get Payment History REST API
  • Get Checkout Data REST API
  • Create New Tag REST API
  • Change Order Status REST API
  • Manage Orders REST API
  • Mark Message as Read REST API
  • Chat Message REST API
  • Check Conversation by Listing REST API
  • Start New Conversation API
  • Get Conversation Messages API
  • My Chat List REST API
  • Toggle a favourite listing REST API
  • Get My Favourite Listings REST API
  • Upload My Profile Image REST API
  • Update My Account REST API
  • Get My Account Info REST API
  • Mark Listing as Sold REST API
  • Change Listing Status REST API
  • Renew Listing REST API
  • Delete My Listings REST API
  • Get My Listings REST API
  • Get Single Listing API
  • Create a listing API
  • User Sign Up REST API
  • Login REST API
  • Logout REST API
  • Account Delete REST API
  • Reset Password REST API
  • Contact REST API
  • Configuration API
  • Locations API
  • Categories API
  • Listing Types API
  • Email Seller API
  • Listings API
  • General

Code Snippets

18
  • Mask more digits
  • Change Business Hour Start and End Time
  • Add Price Unit
  • Trim zero from payment price
  • Show mark as sold listing in the search
  • Remove required attribute for phone field
  • Remove Price Type
  • Modify listing submission success message
  • Modify checkout form fields
  • Display listing image in media library
  • Change radius unit and distance
  • Change Price Type
  • Change Favourites to Favorites
  • Change Excerpt Limit
  • Change Currency Symbol
  • Change archive page listing column
  • Add New Price Type
  • Code Snippets

Filter Hooks

15
  • rtcl_countries_all_countries
  • rtcl_checkout_fields
  • Checkout
  • rtcl_my_account_endpoint
  • rtcl_account_menu_items
  • My Account
  • rtcl_listing_pricing_types
  • Listing Form
  • rtcl_social_profiles_list
  • rtcl_registration_redirect
  • rtcl_listing_seller_contact_form_data
  • rtcl_listing_query_meta_query
  • rtcl_get_base_location
  • General
  • Filter Hooks

Action Hooks

14
  • Email
  • rtcl_payment_receipt
  • rtcl_checkout_process_success
  • Checkout
  • rtcl_account_{$menu_key}_endpoint
  • My Account
  • rtcl_listing_form_before_category_retrieve
  • rtcl_listing_form_after_save_or_update
  • Listing Form
  • rtcl_new_user_created
  • rtcl_listing_loop_item
  • rtcl_after_author_meta
  • General
  • Action Hooks

Payment

8
  • Checkout Option
  • Offline Payment
  • Paypal
  • Authorize.net [PRO]
  • Stripe [PRO]
  • WooCommerce [PRO]
  • Payfast [Addon]
  • Paystack [Addon]

Elementor Addons

11
  • Elementor Addons
  • Listing Category
  • Listing Category Slider
  • All Location
  • Single Location
  • Listings
  • Listing Slider
  • Listing Store
  • Pricing Table
  • Search Form
  • Header Button

WPML Addon

3
  • System Requirements
  • Location Translations
  • WPML Settings

AJAX Filter Builder

2
  • Add Filter Items
  • Filter Widget

Frequently Asked Questions (Faq’s)

29
  • Frequently Asked Questions(Faq’s)
  • Fix taxonomy page listing sorting issue
  • Disallow query string and specific URL [SEO]
  • Enable New Dashboard [Canvas]
  • Custom Fields for Listview
  • Custom Fields for Filter
  • Pay Per Ad
  • Admin Menu Access
  • How to change listing archive category description position
  • Category & Location Menu Link
  • Add Re-Captcha
  • Add Google Map
  • Rank Math SEO Settings
  • Enable Chat
  • Renew listing process
  • How to set Local Time for Business Hour
  • Enable WooCommerce Payment
  • Fix Custom Field Save Issue
  • Enable Mark as Sold
  • How to add Compare
  • How to clear plugin cache?
  • Change Archive Page Title
  • User don’t get Registration & Verification Email?
  • How to change custom fields order?
  • How to add Watermark
  • How to separate login and registration page?
  • How to hide contact information for non logged in users?
  • Enable Social Login
  • Enable User Registration

Listing Management [Front End]

3
  • Front End View
  • Front End Submission
  • My Account Menu

Shortcodes

9
  • Shortcodes
  • Categories Display
  • Checkout Page
  • Listing Submission Form
  • My Account Page
  • Store List
  • Location Wise Display
  • Category Wise Display
  • Listing Filter

Drag & Drop Form Builder (New)

13
  • Multi-Category Selection
  • Enable Form Builder
  • Form List
  • Add New Form
  • Preset Fields
  • Custom Fields
  • Single Listing Layout Builder New
  • Enable Multiple Forms
  • Enable Conditional Logic
  • Add Bulk Options Pro
  • Smart Dependency Pro
  • SEO-Friendly Slug Builder
  • Image Crop Feature

Gutenberg Block

10
  • Gutenberg Block
  • Listing Category
  • Listing Category Slider
  • All Location
  • Single Location
  • Listings
  • Listing Slider
  • Listing Search
  • Pricing Table
  • Stores
  • Home
  • Docs
  • Developer Docs
  • REST API
  • Start New Conversation API
View Categories

Start New Conversation API

3 min read

Endpoint #

POST /wp-json/rtcl/v1/my/chat/conversation

Description #

Start a new conversation and send the first message.

Authentication #

This endpoint is protected and requires:

  • REST API enabled
  • Valid API Key
  • Valid JWT Bearer Token

Required Headers #

HeaderValue
AuthorizationBearer YOUR_JWT_TOKEN
X-API-KEYYOUR_API_KEY
Content-Typeapplication/json

Request Parameters #

ParameterTypeRequiredDescription
listing_idinteger✅ YesListing ID to start chat
textstring✅ YesMessage text
filesarray❌ NoOptional: Images or files
temp_idnumber❌ NoTemporary frontend ID for message tracking

cURL Example (JSON Body) #

curl -X POST https://example.com/wp-json/rtcl/v1/my/chat/conversation \
-H "Authorization: Bearer YOUR_JWT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "listing_id": 101,
  "text": "Hello, is this still available?",
  "temp_id": 123
}'

Success Response (200) #

{
    "con_id": 1,
    "listing": {
        "id": 101,
        "title": "Demo Listing House",
        "url": "http://example.com/listing/demo-listing-house/",
        "images": [
            {
                "ID": 201,
                "title": "demo_image1",
                "caption": "",
                "url": "http://example.com/wp-content/uploads/demo_image1.jpg",
                "alt": "",
                "src": "http://example.com/wp-content/uploads/demo_image1-924x462.jpg",
                "srcset": false,
                "sizes": {
                    "full": { "src": "http://example.com/wp-content/uploads/demo_image1.jpg", "width": 1170, "height": 640 },
                    "medium": { "src": "http://example.com/wp-content/uploads/demo_image1.jpg", "width": 300, "height": 164 },
                    "thumbnail": { "src": "http://example.com/wp-content/uploads/demo_image1.jpg", "width": 150, "height": 82 }
                },
                "mime_type": "image/jpeg",
                "src_w": 870,
                "src_h": 435,
                "srcset_sizes": "(max-width: 870px) 100vw, 870px"
            },
            {
                "ID": 202,
                "title": "demo_image2",
                "caption": "",
                "url": "http://example.com/wp-content/uploads/demo_image2.jpg",
                "alt": "",
                "src": "http://example.com/wp-content/uploads/demo_image2-924x462.jpg",
                "srcset": false,
                "sizes": {
                    "full": { "src": "http://example.com/wp-content/uploads/demo_image2.jpg", "width": 1024, "height": 529 },
                    "medium": { "src": "http://example.com/wp-content/uploads/demo_image2.jpg", "width": 300, "height": 155 },
                    "thumbnail": { "src": "http://example.com/wp-content/uploads/demo_image2.jpg", "width": 150, "height": 77 }
                },
                "mime_type": "image/jpeg",
                "src_w": 870,
                "src_h": 435,
                "srcset_sizes": "(max-width: 870px) 100vw, 870px"
            }
        ],
        "amount": "<div class=\"rtcl-price price-type-fixed\"><span class=\"rtcl-price-amount amount\"><bdi>1,000<span class=\"rtcl-price-currencySymbol\">&#36;</span></bdi></span></div>",
        "raw_price": "1000",
        "location": [],
        "category": [
            {
                "term_id": 1,
                "name": "Demo Category",
                "slug": "demo-category",
                "term_group": 0,
                "term_taxonomy_id": 1,
                "taxonomy": "rtcl_category",
                "description": "",
                "parent": 0,
                "count": 3,
                "filter": "raw"
            }
        ]
    },
    "unread_count": 0,
    "sender": {
        "id": 1,
        "name": "Demo User 1",
        "email": "user1@example.com",
        "phone": "",
        "whatsapp": "",
        "website": "",
        "profile_picture": "https://www.gravatar.com/avatar/demo1?s=96&d=mm&r=g"
    },
    "recipient": {
        "id": 2,
        "name": "Demo User 2",
        "email": "user2@example.com",
        "phone": "",
        "whatsapp": "",
        "website": "",
        "profile_picture": "https://www.gravatar.com/avatar/demo2?s=96&d=mm&r=g"
    },
    "listing_id": 101,
    "sender_id": 1,
    "recipient_id": 2,
    "sender_delete": false,
    "recipient_delete": false,
    "last_message_id": 1,
    "sender_review": false,
    "recipient_review": false,
    "invert_review": false,
    "created_at": "2026-01-27 11:15:27",
    "updated_at": "2026-01-27 11:15:27",
    "last_message": "Hello",
    "last_message_created_at": "2026-01-27 11:15:27",
    "newMessage": {
        "message_id": 1,
        "con_id": 1,
        "source_id": 1,
        "message": "Hello",
        "meta": null,
        "attachments": null,
        "type": "text",
        "is_read": 0,
        "created_at": "2026-01-27 11:15:27",
        "temp_id": ""
    }
}

Error Responses #

Not Logged In (403) #

{
  "code": "FORBIDDEN",
  "message": "You are not logged in."
}

Invalid Conversation / No Access (403) #

{
  "code": "FORBIDDEN",
  "message": "You are not permitted to access this conversation."
}

Missing Authorization Header #

{
  "status": "error",
  "error": "MISSING_AUTHORIZATION_HEADER",
  "code": "401",
  "error_message": "Authorization header not received. Either authorization header was not sent or it was removed by your server due to security reasons."
}

Invalid Authorization Token Type #

{
  "status": "error",
  "error": "INVALID_AUTHORIZATION_HEADER_TOKEN_TYPE",
  "code": "401",
  "error_message": "Authorization header must be type of Bearer Token."
}

Invalid JWT Format (Segment Fault) #

{
  "status": "error",
  "error": "SEGMENT_FAULT",
  "code": "401",
  "error_message": "Incorrect JWT Format."
}

Invalid JWT Signature #

{
  "status": "error",
  "error": "INVALID_TOKEN",
  "code": "401",
  "error_message": "JWT signature verification failed."
}

REST API Access Disabled #

{
  "code": "DENIED_REST_API",
  "message": "Denied api call",
  "data": {
    "status": 403
  }
}
What are your Feelings

Share This Article :

  • Facebook
  • X
  • LinkedIn
  • Pinterest
Still stuck? How can we help?

How can we help?

Updated on January 27, 2026
Check Conversation by Listing REST APIGet Conversation Messages API
Table of Contents
  • Endpoint
  • Description
  • Authentication
  • Required Headers
  • Request Parameters
  • cURL Example (JSON Body)
  • Success Response (200)
  • Error Responses
    • Not Logged In (403)
    • Invalid Conversation / No Access (403)
    • Missing Authorization Header
    • Invalid Authorization Token Type
    • Invalid JWT Format (Segment Fault)
    • Invalid JWT Signature
    • REST API Access Disabled
Copyright© 2026 RadiusDocs by RadiusTheme