مین مواد پر جائیں

Session Link

Session Link icon
ڈیولپر API

اپنے سسٹمز سے گاہک کی گفتگو کا براہ راست لنک حاصل کریں؛ اگر گاہک اور گفتگو موجود نہ ہوں تو بنا دیے جاتے ہیں۔

  • WhatsApp
  • Instagram
  • REST API

جائزہ​

ایک چینل اور گاہک کے فون نمبر یا ای میل کے ساتھ ایک API کال ایسا لنک واپس کرتی ہے جو MonoChat میں اس گاہک کی گفتگو کھولتا ہے۔ اگر گاہک یا گفتگو ابھی موجود نہ ہو تو وہ بنا دیے جاتے ہیں۔

لنک کو اپنے CRM، ہیلپ ڈیسک یا آرڈر اسکرین میں رکھیں اور آپ کی ٹیم وہاں سے سیدھا چیٹ میں پہنچ جائے گی۔

نمایاں خصوصیات​

  • کھولیں یا بنائیں۔ کسی مخصوص WhatsApp، Instagram یا دوسرے چینل کے گاہک کے لیے کام کرتا ہے، فون نمبر یا ای میل کے ذریعے۔
  • راستے میں روٹ کریں۔ اسی کال میں گفتگو کو آئی ڈی یا ای میل کے ذریعے کسی ایجنٹ کو، یا کسی ورک گروپ کو تفویض کریں۔
  • وہی گاہک، وہی گفتگو۔ اسی گاہک اور چینل کے لیے دوبارہ کال کرنے پر موجودہ گفتگو ہی واپس ملتی ہے۔

انسٹال اور سیٹ اپ​

  1. Session Link کو ترتیبات › MonoStore › ایپس سے انسٹال کریں، یا انسٹال لنک app.monochat.ai/apps/vvKJe8Nbp4EQNy2KA کھولیں۔ اگر آپ کے پاس MonoChat اکاؤنٹ نہیں ہے تو لنک آپ کو پہلے سائن اپ کرنے دیتا ہے اور پھر آپ کے لیے ایپ انسٹال کر دیتا ہے۔
  2. پروفائل › API ٹوکنز کے تحت ایک API ٹوکن بنائیں۔ ٹوکن صرف ایک بار دکھایا جاتا ہے، اس لیے اسے فوراً کاپی کر لیں۔ دیکھیں API ٹوکنز۔
  3. ترتیبات › Session Link API کھولیں۔ وہاں کی دستاویزات میں آپ کے ورک اسپیس کا درست اینڈ پوائنٹ ایڈریس اور کاپی کے لیے تیار مثالی درخواستیں ہیں۔ مثال کو اپنے کسی چینل کے ساتھ آزما کر دیکھیں۔
  4. اپنے CRM، ہیلپ ڈیسک یا آرڈر اسکرین میں "Chat on WhatsApp" بٹن شامل کریں جو API کو کال کرے اور واپس ملنے والا url کھولے۔
نوٹ
  • لنک ان لوگوں کے لیے MonoChat کھولتا ہے جو سائن ان ہیں اور جنہیں وہ گفتگو دیکھنے کی اجازت ہے۔
  • کال صرف گفتگو کھولتی ہے؛ یہ گاہک کو کوئی میسج نہیں بھیجتی۔ پہلے لکھنے کے لیے WhatsApp Template API استعمال کریں۔

خصوصیات​

جواب میں وہ لنک ملتا ہے جو MonoChat میں گفتگو کھولتا ہے اور گفتگو کی آئی ڈی بھی۔

ضرورت ہو تو گاہک بنا دیا جاتا ہے​

آپ کے بھیجے ہوئے پہلے اور آخری نام سے نیا گاہک بنتا ہے؛ جواب بتاتا ہے کہ گاہک پہلے سے معلوم تھا یا نہیں۔

تفویض​

آئی ڈی یا ای میل کے ذریعے کسی ایجنٹ کو، یا کسی ورک گروپ کو تفویض کریں۔

ڈاکیومنٹیشن اسکرین​

API ریفرنس، جس میں آپ کے ورک اسپیس کا درست اینڈ پوائنٹ ایڈریس اور کاپی کے لیے تیار مثالی درخواستیں ہیں۔

API ریفرنس​

یہ کال JSON باڈی کے ساتھ ایک POST ہے، جس کی تصدیق API ٹوکن سے ہوتی ہے۔

POST https://app.monochat.ai/api/<slug>/custom-functions/<app-folder>/methods/session-link.js
Authorization: Bearer <API_TOKEN>
Content-Type: application/json
  • <slug> آپ کے ورک اسپیس کا ٹیننٹ سلگ ہے، یعنی آپ کے MonoChat ایڈریس میں /tenants/ کے بعد کا حصہ۔
  • <app-folder> وہ فولڈر ہے جس میں ایپ انسٹال ہوئی تھی۔ ترتیبات › Session Link API اسکرین دونوں کو بھر کر پورا ایڈریس دکھاتی ہے۔
  • ٹوکن پروفائل › API ٹوکنز کے تحت بنائیں۔ دیکھیں API ٹوکنز۔

درخواست کے فیلڈز​

فیلڈلازمیتفصیل
connectorBrandہاںچینل کی قسم، مثلاً whatsapp یا instagram۔
channelUsernameہاںMonoChat میں آپ کے چینل کا یوزر نیم، مثلاً آپ کا WhatsApp نمبر بغیر + کے۔
customer.identityTypeہاںphoneNumber یا email۔
customer.identityہاںگاہک کا فون نمبر (ملک کے کوڈ کے ساتھ، بغیر + کے) یا ای میل ایڈریس۔
customer.firstname, customer.lastnameنہیںجب گاہک MonoChat میں نیا ہو تو استعمال ہوتے ہیں۔ ڈیفالٹ -۔
assignment.typeنہیںagent (ایجنٹ یوزر کی آئی ڈی)، agentIdentity (ایجنٹ کی ای میل) یا workgroup (ورک گروپ کی آئی ڈی)۔
assignment.valueassignment.type کے ساتھوہ آئی ڈی یا ای میل جس کو گفتگو تفویض کرنی ہے۔

مثالی درخواست​

curl --location 'https://app.monochat.ai/api/<slug>/custom-functions/<app-folder>/methods/session-link.js' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_TOKEN>' \
--data '{
"connectorBrand": "whatsapp",
"channelUsername": "905334445566",
"customer": {
"identityType": "phoneNumber",
"identity": "905306667788",
"firstname": "Ayşe",
"lastname": "Yılmaz"
},
"assignment": { "type": "agentIdentity", "value": "sarah@yourcompany.com" }
}'

جواب​

{
"result": {
"url": "https://app.monochat.ai/tenants/<slug>?tab=messages&sessionTab=all&filter=…&_id=<sessionId>",
"sessionId": "Zeii7vpeeFFnsJepZ",
"isOldUser": true
}
}
فیلڈتفصیل
urlMonoChat میں گفتگو کھولتا ہے۔
sessionIdگفتگو کی آئی ڈی۔ ایک ہی چینل پر ایک ہی گاہک کو ہمیشہ وہی گفتگو ملتی ہے۔
isOldUserfalse جب گاہک اسی کال سے بنایا گیا ہو۔

خرابیاں​

ناکام کال ایک خرابی کے اسٹیٹس اور پیغام کے ساتھ جواب دیتی ہے:

پیغاموجہ
connectorBrand, channelUsername and customer fields are requiredکوئی لازمی اعلیٰ سطح کا فیلڈ غائب ہے۔
customer.identityType must be one of: phoneNumber, emailidentityType غائب ہے یا اس کی قدر کچھ اور ہے۔
customer.identity field is requiredگاہک کا فون نمبر یا ای میل غائب ہے۔
Channel not foundآپ کے ورک اسپیس میں اس قسم اور اس یوزر نیم کا کوئی چینل نہیں ہے۔
Customer Channel not foundگاہک کو کسی چینل شناخت سے ملایا نہیں جا سکا۔
Agent user not foundassignment.value میں دی گئی ای میل کا کوئی ایجنٹ نہیں ہے۔
401Authorization ہیڈر غائب ہے یا ٹوکن غلط ہے۔

اسکرین شاٹس​

اکثر پوچھے جانے والے سوالات​

نہیں۔ یہ صرف گفتگو کھولتا یا بناتا ہے اور اس کا لنک واپس کرتا ہے۔ گاہک کو پہلے لکھنے کے لیے WhatsApp Template API ایپ استعمال کریں۔

یہ کن چینلز کے ساتھ کام کرتا ہے؟​

WhatsApp، Instagram اور آپ کے MonoChat ورک اسپیس سے جڑے دیگر چینلز۔ درخواست میں آپ چینل کی قسم اور اپنے چینل کا یوزر نیم بتاتے ہیں۔

کیا یہ ڈپلیکیٹ گفتگو بنائے گا؟​

نہیں۔ ایک ہی چینل پر ایک ہی گاہک کو ہمیشہ وہی گفتگو ملتی ہے۔

وہ لوگ جو MonoChat میں سائن ان ہیں اور جنہیں وہ گفتگو دیکھنے کی اجازت ہے۔