डॉक्युमेंटेशन

संपर्क गुणधर्म

संपर्कांसाठी स्वतःची फील्ड ठरवा — उदाहरणार्थ खात्याचा प्रकार, प्रदेश किंवा कराराची पातळी — आणि ती विजेटमधून पाठवा. गुणधर्म संपर्काच्या प्रोफाइलवर दिसतात, प्रतिनिधींना बदलता येतात आणि इनबॉक्समध्ये त्यांवरून फिल्टर करता येते.

आढावा#

अंगभूत फील्डपलीकडे (email, name, userId) संभाषणाला रचनाबद्ध डेटा जोडण्यासाठी संपर्क गुणधर्म वापरा. मुक्त स्वरूपाच्या metadata पेक्षा वेगळ्या — गुणधर्मांना प्रकार, लेबल आणि पडताळणीसह ठरावीक स्कीमा असते, अगदी HubSpot किंवा Salesforce मधील कस्टम फील्डसारखी.

स्कीमा ठरवा

Agent Settings मध्ये string, number, enum, boolean, date, url अशा प्रकारांसह गुणधर्मांच्या व्याख्या तयार करा

विजेटमधून पाठवा

Respondo.identify() मधून गुणधर्मांची मूल्ये पाठवा — ती आपोआप साठवली आणि दाखवली जातात

फिल्टर आणि संपादन

इनबॉक्समध्ये गुणधर्मांच्या मूल्यांनुसार संभाषणे फिल्टर करा. प्रतिनिधी संपर्काच्या प्रोफाइलवर संपर्काची ॲट्रिब्यूट पाहू आणि बदलू शकतात.

गुणधर्म ठरवणे#

प्रत्येक एजंटसाठी गुणधर्म Agent Settings → Contact Properties मध्ये ठरवले जातात. प्रत्येक गुणधर्माला असते:

फील्डवर्णन
keyकोडमध्ये वापरला जाणारा एकमेव ओळखकर्ता. लेबलवरून आपोआप तयार होतो (बदलता येतो). लोअरकेस अक्षरे, अंक आणि अंडरस्कोअर; सुरुवात अक्षरानेच; 2-63 अक्षरे. सिस्टम की (user_id, visitor_id, timezone, page_url, …) राखीव आहेत. उदाहरण: account_type
labelडॅशबोर्डमध्ये दिसणारे माणसाला वाचता येणारे नाव. उदाहरण: "Account Type"
typeमूल्याचा प्रकार: string, number, boolean, enum, date, url
enum_valuesenum प्रकारासाठी — मान्य मूल्यांची यादी. उदाहरण: ["starter", "pro", "enterprise"]
is_filterableभविष्यातील फिल्टर नियंत्रणासाठी राखीव; व्याख्येसोबत साठवले जाते, पण इनबॉक्सचा फिल्टर पिकर सध्या ठरवलेले सर्व गुणधर्म दाखवतो (डीफॉल्ट: true)
is_visibleभविष्यातील दर्शन नियंत्रणासाठी राखीव; व्याख्येसोबत साठवले जाते, पण UI मध्ये अजून लागू होत नाही (डीफॉल्ट: true)
प्रत्येक एजंटसाठी जास्तीत जास्त 50 गुणधर्म. सेटिंग्जच्या इंटरफेसमध्ये ड्रॅग-अँड-ड्रॉपने गुणधर्मांचा क्रम बदलता येतो.

विजेटमधून पाठवणे#

गुणधर्मांची मूल्ये Respondo.identify() च्या properties फील्डमध्ये पाठवा. की Agent Settings मधील गुणधर्मांच्या व्याख्यांशी तंतोतंत जुळल्या पाहिजेत.

विजेट इंटिग्रेशनjavascript
Respondo.identify({
  email: 'user@example.com',
  name: 'Jane Smith',
  userId: 'usr_456',
  properties: {
    account_type: 'enterprise',   // enum
    region: 'eu-west',            // string
    monthly_spend: '15000',       // number (passed as string)
    is_partner: 'true',           // boolean (passed as string)
    contract_end: '2026-12-31',   // date
    dashboard_url: 'https://app.example.com/org/123'  // url
  }
});
गुणधर्मांची सर्व मूल्ये स्ट्रिंग म्हणून पाठवली जातात. प्रकारानुसार ती कशी दाखवायची हे डॅशबोर्ड ठरवतो (उदा. boolean → Yes/No, url → क्लिक करता येणारी लिंक, enum → बॅज).

इंटिग्रेशन स्निपेट#

किमान एक गुणधर्म ठरवल्यावर Integration Snippet हा Agent Settings → Contact Properties मध्ये आपोआप दिसतो — तुमच्या सर्व गुणधर्मांच्या की त्यात आधीच भरलेल्या असतात. Copy वर क्लिक करून तो घ्या आणि तुमच्या ॲप्लिकेशनमध्ये चिकटवा. तयार स्निपेटमध्ये ओळख पडताळणीसाठी (HMAC-SHA256) userHash चा प्लेसहोल्डरही असतो.

मूल्ये कशी साठवली जातात#

गुणधर्मांची मूल्ये संभाषणाच्या metadata या JSONB फील्डमध्ये cp_ या उपसर्गासह साठवली जातात. उदाहरणार्थ, account_type ही की असलेला गुणधर्म cp_account_type म्हणून साठवला जातो.

प्रत्येक मेसेजसोबत गुणधर्म अद्ययावत होतात — विजेटने नवीन मूल्ये पाठवली, तर ती आधीच्यांवर लिहिली जातात. म्हणजे गुणधर्मांची मूल्ये नेहमी तुमच्या ॲप्लिकेशनमधील ताजा डेटा दाखवतात.

इनबॉक्समध्ये फिल्टर करणे#

इनबॉक्सची फिल्टर पट्टी किंवा जतन केलेले View वापरून गुणधर्मांच्या मूल्यांनुसार संभाषणे फिल्टर करा. Property अट जोडा, नावाने गुणधर्म निवडा — पिकरमध्ये तुमच्या सर्व एजंटमधल्या सगळ्या व्याख्या दिसतात आणि व्याख्या नसलेली कच्ची की सुद्धा चालते — आणि मग मूल्य निवडा. मूल्याचे फील्ड टाइप करता करता पाहिलेली मूल्ये आणि enum ची मूल्ये सुचवते.

API वरून, संभाषणांच्या यादीचे एंडपॉइंट cp.<key>=<value> हा क्वेरी पॅरामीटर स्वीकारतात (attr.<key> चे तंतोतंत उपनाव). मुक्त मजकुराचा क्वेरी सिंटॅक्स नाही:

GET /api/v1/conversations?cp.account_type=enterprise

मूल्ये संपादित करणे#

गुणधर्मांची मूल्ये तुमचे ॲप्लिकेशन ठरवते — विजेट इंटिग्रेशनमधून किंवा API मधून — आणि संभाषणाच्या तपशील पॅनेलमध्ये ती फक्त-वाचनाची असतात. पॅनेल संपर्काच्या प्रोफाइलकडे लिंक देते, जिथे प्रतिनिधी संपर्काची ॲट्रिब्यूट पाहू आणि बदलू शकतात (Contacts → संपर्क → Attributes).

properties आणि metadata मधील फरक

वैशिष्ट्यpropertiesmetadata
स्कीमाAgent Settings मध्ये प्रकारांसह ठरवलेलीमुक्त स्वरूपाच्या की-मूल्य जोड्या
फिल्टर करता येतेहोय, फिल्टर पट्टी / जतन केलेल्या View मधून (API: cp.<key> पॅरामीटर)नाही
प्रतिनिधींना बदलता येतेनाही — मूल्ये तुमच्या ॲप्लिकेशनकडून येतात; संपर्काची ॲट्रिब्यूट संपर्काच्या प्रोफाइलवर बदलतातनाही
प्रकारानुसार दर्शनहोय (बॅज, लिंक, तारखा, boolean)फक्त साधा मजकूर
ऑटोकम्प्लीटहोय, फिल्टरच्या मूल्य फील्डमध्ये मूल्यांच्या सूचनानाही
फिल्टर किंवा प्रकारानुसार दर्शन लागत नसलेल्या तात्पुरत्या फील्डसाठी metadata वापरा. तुमची टीम विभागणी आणि कामाच्या प्रवाहात सक्रियपणे वापरणार असलेल्या रचनाबद्ध डेटासाठी properties वापरा.