مستندات

لیست دسته ها و محتواها

Portal.GetContactUs

از این متد برای دریافت یک تماس (با استفاده از کد پیگیری) استفاده می شود.

توجه

کد پیگیری تماس می تواند توسط یک فرم یا یک لینک یا از کوکی، دریافت شود.

طریقه استفاده از متد:

Portal.GetContactUs (RefCode, TemplateName, ElementId, AfterFunction);

ورودی های تابع

نام نوع تعریف
RefCode String کد پیگیری تماس
TemplateName String ID تگ script که با استفاده از آن ظاهر هر محتوا ساخته می شود.
ElementId String ID تگی که قرار است محتواها در آن قرار داده شوند.
AfterFunction Function تابعی که بعد از اجرا شدن این متد اجرا می شود (callback function).

مقدار دریافتی (Responce)

{
    "IsSuccess": true,
    "StatusCode": 200,
    "Message": "عملیات با موفقیت انجام شد",
    "Result": {
        "ID": 2734,
        "Name": "",
        "Email": "",
        "Subject": "تست تماس با ما",
        "Text": "آیا این تماس با ما برای تست توسط کاربران برنامه نویس سایت ایجاد شده؟",
        "IsRead": true,
        "Description": null,
        "IsActive": true,
        "CategoryId": 887,
        "Mobile": "",
        "CT": "2022-03-28T18:33:48.91",
        "RefCode": "BJOV-220328",
        "IPAddress": "",
        "IsFaq": false,
        "Answers": [
            {
                "Message": "سلام\nممنون از سوال خوب شما. بله این تماس برای استفاده توسط کاربران برنامه نویس ایجاد شده است.\nموفق باشید.",
                "CT": "2022-03-28T18:35:34.143"
            }
        ],
        "Properties": null
    }
}

توضیح مقادیر

Responce

نام نوع توضیح
IsSuccess Boolean درصورت موفقیت آمیز بودن دریافت محتوا این پارامتر true می شود.
StatusCode Number وضعیت دریافت پاسخ، اگر 200 باشد یعنی موفقیت آمیز بوده
Message String پیغام موفقیت یا عدم موفقیت دریافت پاسخ
Result Object حاوی اطلاعات تماس و پاسخ

Result

نام نوع توضیح
ID Number ID تماس
Name String نام کاربر ایجاد کننده تماس (این فیلد در حال حاضر خالی همیشه خالی است).
Email String این فیلد به دلایل امنیتی همیشه خالی است.
Subject String عنوان تماس
Text String متن تماس
IsRead Boolean آیا خوانده شده
Description String این فیلد مخصوص پنل است و همیشه null می آید.
IsActive Boolean آیا تماس فعال است
CategoryId Number ID دسته تماس
Mobile String این فیلد به دلایل امنیتی خالی می آید.
CT String تاریخ ایجاد تماس
RefCode String کد رهگیری تماس
IPAddress String این فیلد به دلایل امنیتی همیشه خالی است.
IsFaq Boolean آیا این تماس جزء پرسش و پاسخ های متداول است.
Properties object ویژگی های مربوط به این تماس
Answers object پاسخ تماس

Answers

نام نوع توضیح
Message String متن پاسخ
CT String تاریخ ایجاد پاسخ

مثال ها

مثال ساده

مثال ساده با انتخاب اولین دسته موجود به عنوان دسته ی تماس

دریافت کد رهگیری از فرم

دریافت پاسخ تماس