فهرست محتوا

مفاهیم اولیه

آدرس وب سرویس

آدرس وب سرویس یا endpoint برای هر سی آر ام به صورت یک آدرس اختصاصی می باشد

آدرس وب سرویس شما: http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger

احراز هویت

وب سرویس نسخه 2 برای احراز هویت نیازمند وارد کردن نام کاربری و کلید دسترسی می باشد. احراز هویت در API از طریق HTTP Basic Auth انجام می شود.

اطلاعات Accesskey برای هر کاربر از قسمت تنظیمات پروفایل ، اطلاعات دسترسی پیشرفته کاربر قابل دسترسی است

پاسخ

کد HTTP 200 نشان دهنده اجرای موفقیت آمیز API است. همچنین به جهت اطمینان از اجرای موفقیت آمیز و کامل دستور نیاز دارید در قالب JSON بازگشتی مقدار پارامتر success برابر با true باشد. پاسخ وب سرویس به فرمت زیر است

{
    success: true,
    result: result
}

خطا

کد پاسخ HTTP 400 نشان دهنده عدم موفقیت API است. پیام خطا در محتوای هدر پاسخ قابل مشاهده است.سایر کدهای پاسخ HTTP مانند 500 و … باید در ارورلاگ سمت سرور بررسی شوند.

شناسه رکورد

شناسه رکورد (record id) در وب سرویس ترکیبی از دو بخش است که بخش اول شناسه ماژول در وب سرویس و بخش دوم شناسه رکورد در سیستم است که با کاراکتر x با هم ترکیب شده اند.

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

این نسخه از ماژول فارسی ساز شما تعداد 118 متد فعال برای وب سرویس دارد

نسخه Soap وب سرویس

برای وب سرویس نسخه 2 می توانید از نسخه soap نیز استفاده نمایید

آدرس نسخه soap وب سرویس شما: http://Your-CRM-URL/modules/ParsVT/ws/soap.php

نحوه ارسال درخواست در نسخه soap وب سرویس به صورت زیر می باشد:

پارامتر اول و دوم وب سرویس نام کاربری و کلید دسترسی و پارامتر سوم به صورت یک آرایه از پارامتر های هر متد وب سرویس خواهد بود

پاسخ وب سرویس همیشه یک رشته json خواهد بود و پارامتر success در آن به معنی موفقیت آمیز بودن عملیات خواهد بود

{
    success: true,
    result: result
}

برای دریافت نمونه کد به زبان php به بخش بعدی مراجعه نمایید

نمونه کد فراخوانی وب سرویس به زبان PHP

برای استفاده از نمونه کد در زبان PHP کافیست فایل فشرده که حاوی کتابخانه client وب سرویس و نمونه کد جهت اتصال می‌باشد را دانلود و از حالت فشرده خارج نموده و در کنار کدهای خود قرار دهید.

دانلود

متدهای API

متد ping

بررسی صحت احراز هویت با استفاده از این API قبل از استفاده از هر متد دیگر قابل بررسی و تأیید است

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/ping

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/ping

نتیجه درخواست


{
  "success": true,
  "result": "pong"
}

متد me

این متد اطلاعات پروفایل کاربری که با آن احراز هویت انجام شده است نمایش می دهد. در صورت نیاز به شناسه مرجع کاربر ، پاسخ این API می تواند مفید باشد.

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/me

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/me

نتیجه درخواست


{
  "success": true,
  "result": {
    user_name: string,
    is_admin: string,
    first_name: string,
    last_name: string,
    roleid: string,
    email1: string,
    ...
    imagename: base64 image ...,
    id: user_record_id,
  }
}

متد fetchcompanydetails

این متد اطلاعات شرکت که در بخش تنظیمات ویتایگر وارد شده است را در دسترس قرار می دهد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/fetchcompanydetails

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/fetchcompanydetails

نتیجه درخواست


{
  "success": true,
  "result": {
      organization_id: integer,
      organizationname: string,
      address: string,
      city: string,
      state: string,
      country: string,
      code: string,
      phone: string,
      fax: string,
      website: string,
      logoname: string,
      logo: base64 image ...,
      vatid: ,
      id: company_record_id
    }
}

متد listoperations

این متد کلیه متدهای در دسترس برای استفاده در وب سرویس را در اختیار شما قرار میدهد. این متد جهت استفاده اولیه و اطمینان از صحت داده های ورودی کارآمد است

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/listoperations

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/listoperations

نتیجه درخواست


{
  "success": true,
  "result": [
      {
        Method: string,
        Content-Type: string,
        Parameters: [
          {
            parameter_name: string,
            parameter_type: string
          },
          ...
        ]
      },
      ...
 ]
}

متد listtypes

از طریق این API می توانید جزئیات مربوط به ماژول های ویتایگر را که در دسترس کاربر است مشاهده کنید.

⚠️ نوع متد وب سرویس: پیشفرض ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/default/listtypes?fieldTypeList=JSON+String

پارامترها

{
    "fieldTypeList": "JSON String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/default/listtypes?fieldTypeList=null

نتیجه درخواست


{
  "success": true,
  "result": {
        types: [
            module_name,
            ...
        ],
        information: {
            module_name: {
                isEntity: boolean,
                label: string,
                singular: string
            },
            ...
        }
    }
}

متد listmodules

این متد لیست ماژول های Entity به همراه شناسه ماژول در اختیار شما قرار میدهد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/listmodules?type=Boolean

پارامترها

{
    "type": "Boolean"
}

در صورتی که مقدار پارامتر type به صورت 1 وارد شود نحوه نمایش خروجی پاسخ تغییر خواهد کرد

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/listmodules?type=0

نتیجه درخواست


{
  "success": true,
  "result": [
    {
      idPrefix: string,
      Name: string
    },
    ......
 ]
}

متد listtabmodules

این متد لیست ماژولهای در دسترس برای کاربرفعلی به همراه دسته منوی آن ها را در اختیار شما قرار میدهد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/listtabmodules

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/listtabmodules

نتیجه درخواست


{
  "success": true,
  "result": array_list_available_modules
}

متد fetchaccessibleusersandgroups

با استفاده از این متد می توانید لیست کلیه کاربران و گروه های در دسترسی را جهت استفاده از سایر متدها در دسترس داشته باشید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/fetchaccessibleusersandgroups

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/fetchaccessibleusersandgroups

نتیجه درخواست


{
  "success": true,
  "result": {
    Users: {
      user_id: string,
      ...
    },
    Groups: {
      group_id: string,
      ...
    }
  }
}

متد getuserrelatedgroups

این متد اطلاعات گروه های کاربری که کاربر وب سرویس در آنها عضویت دارد را نمایش می دهد.

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/getuserrelatedgroups

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/getuserrelatedgroups

نتیجه درخواست


{
  "success": true,
  "result": array_of_current_user_groups
}

متد fetchallusersandgroups

این متد اطلاعات لیست کل کاربران و گروه های کاربری و اعضای آنها در سیستم را به همراه آی دی وب سرویس آنها نمایش می دهد.

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/fetchallusersandgroups

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/fetchallusersandgroups

نتیجه درخواست


{
  "success": true,
  "result": array_of_users_and_groups
}

برای دسترسی به این لیست نیاز به مدیر بودن کاربر وب سرویس می باشد

متد describe

با استفاده از این متد می توانید اطلاعات مربوط به مجوزهای دسترسی ماژول ، فیلدها و تنظیمات فیلدها جهت پیکربندی درست برای انجام عملیات های آینده را مشاهده نمایید.

⚠️ نوع متد وب سرویس: پیشفرض ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/default/describe?elementType=String

پارامترها

{
    "elementType": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/default/describe?elementType=Leads

نتیجه درخواست


{
  "success": true,
  "result": {
        label: string,
        name: string,
        createable: boolean,
        updateable: boolean,
        deleteable: boolean,
        retrieveable: boolean,
        fields: [
            name: string,
            label: string,
            mandatory: boolean,
            type: {
                name: string
            }
            nullable: boolean,
            editable: boolean,
            default: value
        ],
        idPrefix: module_id_string,
        isEntity: boolean,
        labelFields: string_or_array
        ...
    }
}

متد create

این API شما را قادر می سازد تا یک Entity رکورد جدید ایجاد کنید. برای ایجاد موفقیت آمیز رکورد ، باید تمامی فیلدهای الزامی به همراه فیلد اختیاری ارسال شوند. (برای اطلاعات بیشتر در مورد مشاهده فیلدهای اجباری از متد Describe در API استفاده کنید).

⚠️ نوع متد وب سرویس: پیشفرض ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/default/create

پارامترها

{
    "elementType": "String",
    "element": "JSON String"
}

نکته:

  • برای مقداردهی فیلد ارجاع به (assigne_user_id) می توانید از متد fetchaccessibleusersandgroups یا شناسه کاربر در متد me استفاده نمایید

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/default/create

{
    "elementType": "Leads",
    "element": "{ 
   "assigne_user_id":"19x1",
   "firstname":"\u067e\u0627\u0631\u0633",
   "phone":"03191007879",
   "lastname":"\u0648\u06cc\u062a\u0627\u06cc\u06af\u0631",
   "mobile":"09138086200"
 }"
}

نتیجه درخواست


{
  "success": true,
  "result": {
        id: record_id,
        label: string,
        field1: value1
        field2: value2
        ...
    }
}

متد createdocument

با استفاده از این متد میتوانید که سند جدید در ویتایگر در بخش ماژول اسناد ایجاد کنید. همانطور که اطلاع دارید وب سرویس پیش فرض ویتایگر امکان آپلود سند های داخلی را ندارد و این متد این نیاز را مرتفع خواهد کرد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: multipart/form-data

آدرس درخواست

POST endpoint/extended/createdocument

پارامترها

{
    "element": "JSON String",
    "file": "JSON String"
}

نکته:

  • امکان آپلود فایل با انتخاب هدر multipart با سادگی وجود دارد. در این صورت نیازی با پرکردن فیلد file در API نمی باشد. در غیر این صورت فیلد file باید به فرمت زیر مقدار دهی شود 
    {
    name: file_name,
    content: base64_content
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/createdocument

{
    "element": "{ 
   "assigned_user_id":"19x5",
   "notes_title":"test"
 }"
}

نتیجه درخواست


{
  "success": true,
  "result": {
               success : true, 
               docid: integer,
               attachid : integer
            }
}

متد createinventory

در وب سرویس پیشفرض ویتایگر برای کار با ماژول های مرتبط با انبار از جمله فاکتور، پیش فاکتور، سفارش خرید و سفارش فروش و ایجاد رکورد جدید نیازمند کار با ماژول LineItem در وب سرویس و سپس استفاده از متد Create در وب سرویس می باشید. به جهت راحتی و جلوگیری از خطاهای غیر قابل پیشبینی متد ایجاد در ماژول های انبار این عملیات را برای شما تسهیل می کند

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/createinventory

پارامترها

{
    "elementType": "String",
    "element": "JSON String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/createinventory

{
    "elementType": "Quotes",
    "element": "{ 
   "subject":"test api ...",
   "description":" des ... ",
   "quotestage":"Created",
   "account_id":"",
   "contact_id":"",
   "invoicedate":"2019-12-18",
   "validtill":"2019-12-18",
   "invoicestatus":"Created",
   "bill_street":"-",
   "bill_code":"0",
   "bill_city":"-",
   "bill_country":"-",
   "ship_street":"-",
   "ship_code":"0",
   "ship_city":"-",
   "ship_country":"-",
   "taxtype":"individual",
   "discount_amount_final":1000,
   "charges":[ 
      { 
         "value":100,
         "taxes":[ 
            9,
            10,
            0
         ]
      }
   ],
   "adjustment":1000,
   "items":[ 
      { 
         "hdnProductId":"14x2795",
         "qty":10,
         "listPrice":25000,
         "comment":"Product Comment 1",
         "discount_amount":5000,
         "tax1_percentage":9,
         "tax2_percentage":10,
         "tax3_percentage":12.5
      },
      { 
         "hdnProductId":"14x2794",
         "qty":1,
         "listPrice":2000,
         "comment":"Product Comment 2",
         "discount_amount":100,
         "tax1_percentage":9,
         "tax2_percentage":0,
         "tax3_percentage":2.5
      }
   ]
 }"
}

نتیجه درخواست


{
  "success": true,
  "result": entity_id
}

متد create_event

در وب سرویس پیش فرض ویتایگر کار با ماژول تقویم از آنجا که شامل دو ماژول رویداد و وظیفه می باشد برای کاربران مشکلاتی را ایجاد می کرد. این متد امکان ایجاد رویداد بدون نگرانی از مشاهده خطاهای رایج در زمان کار با ماژول تقویم را در اختیار کاربر قرار می دهد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/create_event

پارامترها

{
    "element": "JSON String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/create_event

{
    "element": "{
         "subject":"\u062a\u0633\u062a \u0631\u0648\u06cc\u062f\u0627\u062f 1",
         "assigned_user_id":"19x1",
         "date_start":"2020-01-22",
         "time_start":"18:28:00",
         "due_date":"2020-01-22",
         "time_end":"18:33:00",
         "duration_hours":"0",
         "duration_minutes":"5",
         "parent_id":"",
         "eventstatus":"Held",
         "sendnotification":"0",
         "activitytype":"Call",
         "location":"",
         "taskpriority":"",
         "notime":"0",
         "visibility":"Public",
         "description":"",
         "reminder_time":"0",
         "contact_id":""
 }"
}

نتیجه درخواست


{
  "success": true,
  "result": event_id
}

متد create_task

در وب سرویس پیش فرض ویتایگر کار با ماژول تقویم از آنجا که شامل دو ماژول رویداد و وظیفه می باشد برای کاربران مشکلاتی را ایجاد می کرد. این متد امکان ایجاد وظیفه بدون نگرانی از مشاهده خطاهای رایج در زمان کار با ماژول تقویم را در اختیار کاربر قرار می دهد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/create_task

پارامترها

{
    "element": "JSON String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/create_task

{
    "element": "{
         "subject":"\u062a\u0633\u062a \u0648\u0638\u06cc\u0641\u0647",
         "assigned_user_id":"19x1",
         "date_start":"2018-12-30",
         "time_start":"02:30:00",
         "time_end":"",
         "due_date":"2018-12-30",
         "parent_id":"13x1981",
         "contact_id":"",
         "taskstatus":"Not Started",
         "eventstatus":"",
         "taskpriority":"High",
         "sendnotification":"0",
         "activitytype":"Task",
         "visibility":"Private",
         "description":"\u062a\u0648\u0636\u06cc\u062d\u0627\u062a",
         "duration_hours":"-3",
         "duration_minutes":"-30",
         "location":"",
         "reminder_time":"0",
         "recurringtype":"",
         "notime":"0"
 }"
}

نتیجه درخواست


{
  "success": true,
  "result": task_id
}

متد addcomment

از نسخه ویتایگر 7 به بعد امکان ضمیمه کردن فایل به یادداشت ها افزوده شد. برای ایجاد یادداشت جدید در ماژول ها امکان استفاده از متد create وجود دارد اما این متد امکان ضمیمه کردن فایل را ندارد. برای تسهیل متد addcomment به وب سرویس اضافه شد که امکان ارسال فایل به صورت مستقیم با هدر multipart و یا پارامتر file را در اختیار کاربر قرار میدهد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: multipart/form-data

آدرس درخواست

POST endpoint/extended/addcomment

پارامترها

{
    "element": "JSON String",
    "file": "JSON String"
}

نکته:

  • امکان آپلود فایل با انتخاب هدر multipart با سادگی وجود دارد. در این صورت نیازی با پرکردن فیلد file در API نمی باشد. در غیر این صورت فیلد file باید به فرمت زیر مقدار دهی شود 
    {
    name: file_name,
    content: base64_content
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/addcomment

{
    "element": "{ 
   "related_to":"12x2768",
   "commentcontent":"\u0639\u0637\u0641 \u0628\u0647 \u06cc\u0627\u062f\u0627\u0634\u062a \u0642\u0628\u0644\u06cc - \u062a\u0633\u062a \u0645\u06cc\u0634\u0647",
   "parent_comments":"28x2869"
 }",
    "file": "[
            "name":"1.txt",
            "content":"U0dWc2JHOHVJRmx2ZFNCaGNtVWdkWE5wYm1jZ1VHRnljMVpVSUZkbFluTmxjblpwWTJVZ1ZqST0="
]"
}

نتیجه درخواست


{
  "success": true,
  "result": comment_id
}

متد addticketfaqcomment

این متد به شما اجازه کار با ماژول تیکت ها و ثبت یاداشت برای تیکت از سمت سی آر ام و پورتال را میدهد. همچنین امکان آپلود فایل نظیر متدهای قبلی وجود خواهد داشت

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: multipart/form-data

آدرس درخواست

POST endpoint/extended/addticketfaqcomment

پارامترها

{
    "record": "String",
    "element": "JSON String",
    "files": "JSON String"
}

نکته:

  • امکان آپلود فایل با انتخاب هدر multipart با سادگی وجود دارد. در این صورت نیازی با پرکردن فیلد files در API نمی باشد. در غیر این صورت فیلد files باید به فرمت زیر مقدار دهی شود 
    {
    name: file_name,
    content: base64_content
}

پارامتر record باید با شماره تیکتی که می خواهید برای آن پاسخ ثبت کنید پر شود
همچنین در پارامتر element در صورتی که مقدار from_portal برای 1 وارد شود امکان ثبت تیکت از طرف مشتری وجود خواهد داشت

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/addticketfaqcomment

{
    "record": "17x2733",
    "element": "{ 
   "commentcontent":"\u062f\u0631\u062e\u0648\u0627\u0633\u062a \u0627\u0632 \u0637\u0631\u0641 \u0645\u0634\u062a\u0631\u06cc",
   "from_portal":"1",
   "customer":"12x2586"
 }"
}

نتیجه درخواست


{
  "success": true,
  "result": true
}

متد query

با استفاده از این متد امکان انتخاب و واکشی اطلاعات یک یا چند رکورد بر اساس شرایط مشخص شده در متد query وجود دارد

⚠️ نوع متد وب سرویس: پیشفرض ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/default/query?query=String

پارامترها

{
    "query": "String"
}

کوئری دستور باید به فرمت زیر باشد

select * | field_list | count(*) 
from module where conditions
order by field_list limit m, n;

در نمونه بالا

  • field_list: لیست فیلدها باید نظیر دستورات sql با کاما از هم جدا شود
  • دستورات می توانند شامل موارد زیر باشند
    • عملگرها: <, >, <#, >#, #, !#
    • دستورات شرطی: داخل ( ), مثل ‘sql_regex’
  • limit m, n:m به عنوان offsetn برای شمارش تعداد رکورد مورد نیاز.

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/default/query?query=Select * from Leads where phone = "09138086200" limit 1;

نتیجه درخواست


{
  "success": true,
  "result": array_of_matching_records
}
  • توجه داشته باشید:
    • کوئری با حداکثر تعداد 100 رکورد در هر بار اجرا قابل استفاده است.
    • در کوئری دستورات Join بین ماژول های مختلف پشتیبانی نمی شوند.

متد retrieve

با استفاده از این متد قادر خواهید بود اطلاعات یک رکورد خاض را واکشی کنید.

⚠️ نوع متد وب سرویس: پیشفرض ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/default/retrieve?id=String

پارامترها

{
    "id": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/default/retrieve?id=12x2933

نتیجه درخواست


{
  "success": true,
  "result": {
        id: record_id,
        label: string,
        field1: value1,
        field2: value2,
        ...
    }
}

متد addpicklistvalues

با استفاده از متد قادر خواهید بود فیلد های فهرست انتخابی جدیدی به ویتایگر اضافه کنید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/addpicklistvalues

پارامترها

{
    "module": "String",
    "picklist": "String",
    "values": "JSON String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/addpicklistvalues

{
    "module": "Potentials",
    "picklist": "opportunity_type",
    "values": "["NewValue1","NewValue2"]"
}

نتیجه درخواست


{
  "success": true,
  "result": boolean value
}

متد retrievepicklistvalues

با استفاده از متد قادر خواهید بود فیلد های فهرست انتخابی را به همراه مقادیر و ترجمه آنها واکشی کنید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/retrievepicklistvalues?module=String&picklist=String&picklistdep=String

پارامترها

{
    "module": "String",
    "picklist": "String",
    "picklistdep": "String"
}

در صورتی که مقدار picklistdep برابر 1 قرارداده شود روابط میان فهرست های انتخابی نیز در خروجی وب سرویس نمایش داده خواهند شد

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/retrievepicklistvalues?module=Accounts&picklist=rating&picklistdep=1

نتیجه درخواست


{
  "success": true,
  "result": array_of_picklist_values
}

متد retrieve_module_blocks

با استفاده از متد قادر خواهید بود لیست بلاک ها وفیلدهای داخل هر ماژول را واکشی کنید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/retrieve_module_blocks?modulename=String

پارامترها

{
    "modulename": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/retrieve_module_blocks?modulename=Accounts

نتیجه درخواست


{
  "success": true,
  "result": array_of_block_with_fields
}

پاسخ به صورت یک آرایه از لیبل بلاک ها به همراه لیست فیلدهای آنها خواهد بود

متد retrieve_user_filters

با استفاده از متد قادر خواهید بود لیست نمایه های شخصی، اشتراکی و عمومی کاربر برای هر ماژول را واکشی کنید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/retrieve_user_filters?module=String

پارامترها

{
    "module": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/retrieve_user_filters?module=Leads

نتیجه درخواست


{
  "success": true,
  "result": arraylist_of_available_filters
}

پاسخ به صورت یک آرایه از لیست فیلترها به تفکیک عمومی ، اشتراکی و خصوصی خواهد بود

متد retrieve_filter_columns

با استفاده از متد قادر خواهید بود لیست ستون های قابل نمایش در نمایه درخواستی کاربر برای هر ماژول را واکشی کنید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/retrieve_filter_columns?module=String&id=String

پارامترها

{
    "module": "String",
    "id": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/retrieve_filter_columns?module=Leads&id=2

نتیجه درخواست


{
  "success": true,
  "result": array_of_filter_columns
}

پاسخ به صورت یک آرایه از لیست ستون ها به همراه لیبل و ترجمه آنها خواهد بود

متد retrieve_list_records

با استفاده از متد قادر خواهید بود لیست رکوردهای قابل نمایش براساس دخواست کاربر برای هر ماژول را واکشی کنید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/retrieve_list_records

پارامترها

{
    "params": "JSON String"
}

پارامتر module الزامی هستند و تکمیل و ارسال سایر پارامترها اختیاری می باشند

پارامتر filter_id نمایه درخواستی کاربر را برای نمایش رکورد ها مشخص می کند و در صورتی که مقدار دهی نشود از فیلتر همه استفاده خواهد کرد

پارامتر sort_by نحوه مرتب سازی براساس صعودی یا نزولی را با پارامترهای ASC و DESC مشخص می کند

پارامتر order_by مرتب سازی براساس نام ستون درخواستی را انجام میدهد

پارامتر search_value و search_key برای جستجو در نمایه درخواستی استفاده می شوند

پارامتر search_key با نام ستون مورد نظر و پارامتر search_value به مقدار مورد جستجو تکمیل می شود

پارامتر page جهت صفحه بندی و نمایش اطلاعات در صورت وجود اطلاعات بیشتر از تعداد قابل نمایش در یک صفحه استفاده می شود

پارامتر limit برای محدود کردن تعداد رکورد بازگشتی استفاده می شود این پارامتر در صورت عدم تکمیل از مقدار پیشفرض در بخش تنظیمات ویتایگر استفاده خواهد کرد

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/retrieve_list_records

{
    "params": "{
            "module":"Leads",
            "filter_id":"1",
            "sort_by":"ASC",
            "order_by":"firstname",
            "search_key":"lastname",
            "search_value":"Majidi",
            "page":"1",
            "limit":"50"
     }"
}

نتیجه درخواست


{
  "success": true,
  "result": array_of_match_records
}

پاسخ به صورت یک آرایه از لیست رکوردها براساس پارامترهای درخواستی کاربر خواهد بود

متد retrieve_related

با استفاده از این متد قادر خواهید بود رکورد های مرتبط با یک رکورد خاص را واکشی کنید.

⚠️ نوع متد وب سرویس: پیشفرض ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/default/retrieve_related?id=String&relatedType=String&relatedLabel=String

پارامترها

{
    "id": "String",
    "relatedType": "String",
    "relatedLabel": "String"
}

نکته:

  • id: این مقدار شناسه رکوردی است که می خواهید رکوردهای مرتبط با آن را واکشی کنید
  • relatedType: این مقدار نام ماژولی است که رکوردهای آن واکشی خواهند شد
  • relatedLabel: این مقدار عنوان ماژولی است که رکوردهای آن واکشی خواهند شد

برای اطلاع از ماژول های مرتبط با ماژول مبدا از متد relatedtypes استفاده نمایید

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/default/retrieve_related?id=12x2556&relatedType=HelpDesk&relatedLabel=HelpDesk

نتیجه درخواست


{
  "success": true,
  "result": related_record_array
}

متد retrieverelatedrecords

با استفاده از این متد قادر خواهید بود رکورد های مرتبط با یک رکورد خاص را واکشی کنید. این متد مشابه متد retrieve_related است با این تفاوت که در صورتی که تعداد رکوردهای بازگشتی بیش از 100 عدد بود امکان صفحه بندی و مشاهده بقیه اطلاعات وجود خواهد داشت

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/retrieverelatedrecords?id=String&relatedType=String&relatedLabel=String&page=String

پارامترها

{
    "id": "String",
    "relatedType": "String",
    "relatedLabel": "String",
    "page": "String"
}

نکته:

  • id: این مقدار شناسه رکوردی است که می خواهید رکوردهای مرتبط با آن را واکشی کنید
  • relatedType: این مقدار نام ماژولی است که رکوردهای آن واکشی خواهند شد
  • relatedLabel: این مقدار عنوان ماژولی است که رکوردهای آن واکشی خواهند شد
  • page: در صورتی که تعداد رکوردها بالای 100 عدد بود با مقدار دهی امکان نمایش کلیه رکورد ها وجود خواهد داشت

برای اطلاع از ماژول های مرتبط با ماژول مبدا از متد relatedtypes استفاده نمایید

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/retrieverelatedrecords?id=12x2556&relatedType=HelpDesk&relatedLabel=HelpDesk&page=2

نتیجه درخواست


{
  "success": true,
  "result": related_record_array
}

متد getrelatedrecordcount

این متد تعداد رکوردهای مرتبط را به تفکیک هر ماژول برای یک رکورد نمایش میدهد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/getrelatedrecordcount?record=String

پارامترها

{
    "record": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/getrelatedrecordcount?record=12x2556

نتیجه درخواست


{
  "success": true,
  "result": related_records_counts
}

متد fetchinventorychargesandtaxes

با استفاده از این متد قادر خواهید بود لیست کامل عوارض، مالیات بر عوارض ، مالیات و همچنین مناطق مالیاتی فعال در ویتایگر را دریافت نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/fetchinventorychargesandtaxes

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/fetchinventorychargesandtaxes

نتیجه درخواست


{
  "success": true,
  "result": {
    "charges": {
    ...
    },
    "taxes_on_charges": {
    ...
    },
    "taxes":{
    ...
    },
    "regions": {
    ...
    }
  }
}

متد fetchusercurrencies

این متد اطلاعات لیست واحد های پولی فعال در سیستم را به همراه آی دی وب سرویس آنها نمایش می دهد.

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/fetchusercurrencies

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/fetchusercurrencies

نتیجه درخواست


{
  "success": true,
  "result": array_of_users_currencies
}

متد retrieve_all_document_folders

این متد اطلاعات لیست پوشه های موجود در بخش اسناد ویتایگر را در اختیار کاربر می دهد.

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/retrieve_all_document_folders

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/retrieve_all_document_folders

نتیجه درخواست


{
  "success": true,
  "result": [
    {
      "folderid": "1",
      "foldername": "Default",
      "description": "This is a Default Folder",
      "createdby": "1",
      "sequence": "1"
    }
  ]
}

متد retrieve_recentcomments

با استفاده از این متد قادر خواهید بود لیست یاداشت های مربوط به یک رکورد را مشاهده نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/retrieve_recentcomments?record=String&limit=String&page=String

پارامترها

{
    "record": "String",
    "limit": "String",
    "page": "String"
}

پارامتر های limit و page به ترتیب جهت نمایش تعداد رکورد و صفحه بندی در صورت نیاز استفاده میشوند و الزامی نمی باشند. در صورت خالی بودن limit مقدار 10 به صورت پیش فرض انتخاب میشود و حداکثر تعداد رکورد درخواستی برای این پارامتر در هر درخواست حداکثر 100 عدد می باشد

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/retrieve_recentcomments?record=12x2768&limit=5&page=1

نتیجه درخواست


{
  "success": true,
  "result": [
    {
      "id": "28x3038",
      "creator_name": "مدیر سیستم",
      "is_private": "0",
      "parent": 0,
      "related_to": "12x3024",
      "image_path": "http://url/storage/2020/January/week4/3004_download.jpg",
      "createdtime": "2020-04-10 15:21:16",
      "modifiedtime": "2020-04-10 15:21:16",
      "content": "این یک تست است",
      "files": [
        {
          "fileid": "28x3038",
          "wsid": "3039",
          "filename": "myfile.txt",
          "fileurl": "index.php?module=ModComments&action=DownloadFile&record=3038&fileid=3039"
        },
        ...
      ]
    }
  ]
}

متد sync

از این متد می توانید برای دریافت لیست رکوردهایی که از زمان مشخصی تغییر کرده اند استفاده کنید

⚠️ نوع متد وب سرویس: پیشفرض ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/default/sync?modifiedTime=DateTime&elementType=String

پارامترها

{
    "modifiedTime": "DateTime",
    "elementType": "String"
}

modifiedtime

  • زمان آخرین تغییرات که انتظار دارید رکوردهای پس از آن را دریافت کنید, این مقدار باید بر اساس یونیکس تایم unix time stamp وارد شود. برای مثال 1561718898

elementType

  • ماژول مقصد که می خواهید آخرین تغییرات آن را واکشی کنید

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/default/sync?elementType=Leads&modifiedTime=1576167822

نتیجه درخواست


{
  "success": true,
  "result": {
        updated: record_id_array,
        deleted: record_id_array,
        more: boolean,
        lastModifiedTime: timestamp
    }
}

متد update

  • زمانی که نیاز به بروزرسانی فیلدهای مشخصی از اطلاعات یک رکورد قبلی در سی آر ام به وجود می آید می توانید از متد update در وب سرویس استفاده نمایید.توجه: در این متد باید تمامی فیلدهای الزامی را مجددا به عنوانی بخشی از پارامتر element مقداردهی کنید.

⚠️ نوع متد وب سرویس: پیشفرض ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/default/update

پارامترها

{
    "element": "JSON String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/default/update

{
    "element": "{ 
   "firstname":"\u067e\u0627\u0631\u0633",
   "phone":"03191007879",
   "lastname":"\u0648\u06cc\u062a\u0627\u06cc\u06af\u0631",
   "id":"10x1436"
 }"
}

نتیجه درخواست


{
  "success": true,
  "result": {
        id: record_id,
        label: string,
        field1: revalue1,
        field2: value2,
        ...
    }
}

متد updateinventory

این متد جهت تسهیل در بروزرسانی و جلوگیری از خطاهای شایع هنگام کار با ماژول های فاکتور، پیش فاکتور ، سفارش خرید و سفارش فروش استفاده می شود و دیگر نیازی به استفاده از متد update نخواهد بود.

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/updateinventory

پارامترها

{
    "elementType": "String",
    "element": "JSON String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/updateinventory

{
    "elementType": "Quotes",
    "element": "{ 
   "id":"4x254",
   "subject":"test api ...",
   "description":" des ... ",
   "quotestage":"Created",
   "account_id":"",
   "contact_id":"",
   "invoicedate":"2019-12-18",
   "validtill":"2019-12-18",
   "invoicestatus":"Created",
   "bill_street":"-",
   "bill_code":"0",
   "bill_city":"-",
   "bill_country":"-",
   "ship_street":"-",
   "ship_code":"0",
   "ship_city":"-",
   "ship_country":"-",
   "taxtype":"individual",
   "discount_amount_final":1000,
   "charges":[ 
      { 
         "value":100,
         "taxes":[ 
            9,
            10,
            0
         ]
      }
   ],
   "adjustment":1000,
   "items":[ 
      { 
         "hdnProductId":"14x2795",
         "qty":10,
         "listPrice":25000,
         "comment":"Product Comment 1",
         "discount_amount":5000,
         "tax1_percentage":9,
         "tax2_percentage":10,
         "tax3_percentage":12.5
      },
      { 
         "hdnProductId":"14x2794",
         "qty":1,
         "listPrice":2000,
         "comment":"Product Comment 2",
         "discount_amount":100,
         "tax1_percentage":9,
         "tax2_percentage":0,
         "tax3_percentage":2.5
      }
   ]
 }"
}

نتیجه درخواست


{
  "success": true,
  "result": {
        id: record_id,
        label: string,
        field1: revalue1,
        field2: value2,
        ...
    }
}

متد revise

  • این متد شبیه متد update است با این تفاوت که دیگر نیازی به نگرانی در ارتباط با مقداردهی مجدد فیلدهای الزامی نخواهید داشت و تنها بایست فیلدهایی که میخواهید تغییر کنند را مقداردهی نمایید.

⚠️ نوع متد وب سرویس: پیشفرض ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/default/revise

پارامترها

{
    "element": "JSON String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/default/revise

{
    "element": "{ 
   "phone":"03191007879",
   "fax":"03136204754",
   "id":"10x1436"
 }"
}

نتیجه درخواست


{
  "success": true,
  "result": {
        id: record_id,
        label: string,
        field1: value1,
        field2: revalue2,
        ...
    }
}

متد delete

به وسیله این متد میتوانید یک رکورد که در سیستم وجود دارد را حذف نمایید

⚠️ نوع متد وب سرویس: پیشفرض ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/default/delete

پارامترها

{
    "id": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/default/delete

{
    "id": "12x2933"
}

نتیجه درخواست


{
  "success": true,
  "result": {
        status: "successful"
    }
}

متد massdelete

به وسیله این متد میتوانید چندین رکورد که در سیستم وجود دارند را حذف نمایید. برای این منظور هر رکورد را با کاما از هم جدا کنید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/massdelete

پارامترها

{
    "records": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/massdelete

{
    "records": "24x1900,24x2125,52x2036"
}

نتیجه درخواست


{
  "success": true,
  "result": {
        success_deletes: array_of_deleted_records,
        failed_deletes: array_of_undeleted_records,
    }
}

متد getrelatedtypes

این متد شبیه متد relatedtypes می باشد و در آن لیست ماژول های مرتبط با ماژول مبدا را به همراه نام، لیبل ، entity بودن ماژول مرتبط، شناسه ارتباط، نوع ارتباط، عملیات های در دسترس و … را در اختیار شما قرار میدهد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/getrelatedtypes?elementType=String

پارامترها

{
    "elementType": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/getrelatedtypes?elementType=Leads

نتیجه درخواست


{
  "success": true,
  "result": {
        types: module_name_array,
        information: {
            module_name: {
                name: string,
                label: string,
                translated_label: string,
                isEntity: boolean,
                relation_id: integer,
                actions: string,
                relation_field_id: integer,
                relationType: string
            }
        }
    }
}

متد relatedtypes

این متد لیست ماژول های مرتبط با ماژول مبدا را به همراه نام، لیبل و entity بودن ماژول مرتبط را در اختیار شما قرار میدهد

⚠️ نوع متد وب سرویس: پیشفرض ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/default/relatedtypes?elementType=String

پارامترها

{
    "elementType": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/default/relatedtypes?elementType=Leads

نتیجه درخواست


{
  "success": true,
  "result": {
        types: module_name_array,
        information: {
            module_name: {
                name: string,
                label: string,
                translated_label: string,
                isEntity: boolean,
                relation_id: integer,
                actions: string
            }
        }
    }
}

متد add_related_records

این متد بین دو رکورد مختلف ارتباط ایجاد می کند

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/add_related_records

پارامترها

{
    "sourceRecordId": "String",
    "relatedRecordId": "String",
    "relationIdLabel": "String"
}

پارامتر relatedRecordId را می توانید با آی دی چند رکورد مختلف از یک ماژول که با کاما از هم جداشده اند مقداردهی کنید مثلا 18×12,18×25,18×33

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/add_related_records

{
    "sourceRecordId": "12x2987",
    "relatedRecordId": "10x254",
    "relationIdLabel": "Leads"
}

نتیجه درخواست


{
  "success": true,
  "result": {
        message: "successful"
    }
}

متد queryrelatedrecords

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/queryrelatedrecords?query=String&id=String&relatedLabel=String

پارامترها

{
    "query": "String",
    "id": "String",
    "relatedLabel": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/queryrelatedrecords?query=SELECT * FROM HelpDesk WHERE ticket_title like '%تیکت #8410101%'&id=12x2586&relatedLabel=HelpDesk

نتیجه درخواست


{
  "success": true,
  "result": matching_related_record_array
}

متد query_related

با استفاده از این متد می توانید بین رکورد های مرتبط با یک رکورد مبدا جستجو و اطلاعات را واکشی نمایید

⚠️ نوع متد وب سرویس: پیشفرض ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/default/query_related?query=String&id=String&relatedLabel=String

پارامترها

{
    "query": "String",
    "id": "String",
    "relatedLabel": "String"
}
  • query: دستورات کوئری منطبق با متد query وارد می شود
  • id: شناسه ماژول مبدا می باشد
  • relatedLabel: لیبل ماژول مقصد می باشد

نکته: لیبل ماژول مقصد از طریق متد relatedtypes قابل دسترسی است

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/default/query_related?query=SELECT * FROM HelpDesk WHERE ticket_title like '%تیکت #8410101%'&id=12x2586&relatedLabel=HelpDesk

نتیجه درخواست


{
  "success": true,
  "result": matching_related_record_array
}

متد delete_related_records

این متد ارتباط بین دو رکورد مختلف را حذف می کند

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/delete_related_records

پارامترها

{
    "sourceRecordId": "String",
    "relatedRecordId": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/delete_related_records

{
    "sourceRecordId": "12x2987",
    "relatedRecordId": "10x254"
}

نتیجه درخواست


{
  "success": true,
  "result": {
        status: "successful"
    }
}

متد uploadbase64file

با استفاده از این متد می توانید یک فایل را بدون ایجاد سند در پوشه storage آپلود نمایید. از خروجی این فیلد می توانید فیلد سفارشی آپلود فایل استفاده نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/uploadbase64file

پارامترها

{
    "files": "JSON String",
    "format": "Boolean"
}

در صورتی که مقدار پارامتر format به صورت true وارد شود فرمت پاسخ به صورت آرایه خواهد بود
همچنین فرمت پارامتر files باید به فرمت زیر باشد

[ 
    { 
        name: filename,
        content: base64_content
    }
]

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/uploadbase64file

{
    "files": "[ 
   { 
      "name":"1.txt",
      "content":"U0dWc2JHOHVJRmx2ZFNCaGNtVWdkWE5wYm1jZ1VHRnljMVpVSUZkbFluTmxjblpwWTJVZ1ZqST0="
   },
   { 
      "name":"2.txt",
      "content":"TGVhZHM="
   }
]",
    "format": "0"
}

نتیجه درخواست


{
  "success": true,
  "result": array_of_uploaded_files
}

متد uploadcontactsimage

با استفاده از این متد می توانید تصویر پروفایل مخاطب را آپلود و بروزرسانی نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/uploadcontactsimage

پارامترها

{
    "record": "String",
    "files": "JSON String"
}
  • امکان آپلود فایل با انتخاب هدر multipart با سادگی وجود دارد. در این صورت نیازی با پرکردن فیلد files در API نمی باشد. در غیر این صورت فیلد files باید به فرمت زیر مقدار دهی شود 
    [ 
{ 
    name: filename,
    content: base64_content
}
]

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/uploadcontactsimage

{
    "record": "12x5874",
    "files": "[ 
   { 
      "name":"vtiger.jpg",
      "content":"\/9j\/4AAQSkZJRgABAQAAAQABAAD\/2wCEAAkGBxMSERUSEhIVFRUVGBgYFRcWGBcaFxYZFRcYFxUYHRcYICggGRolGxcWITEiJSkrLi4wGB8zODMtNygtLisBCgoKDg0OGxAQGy0mICUtNy0wODAtLystLS0tLS0tLS41LSstMy0vNS0tLS0tLy0vMS0tLS0tLS0tKystLS8tLf\/AABEIAOEA4QMBIgACEQEDEQH\/xAAcAAEAAwADAQEAAAAAAAAAAAAABQYHAwQIAgH\/xABHEAABAwICBQcHCAgGAwAAAAABAAIDBBEGIQUHEjFBIlFhcYGRsRMyQlJykqEUI2JzgrLB0RYkJTNTVMLhFRdDY4Oik9Lw\/8QAGgEBAAMBAQEAAAAAAAAAAAAAAAMEBQECBv\/EAC4RAAICAQIEBAYCAwEAAAAAAAABAgMEESEFEjFBEyJxgTJRYZGhsdHwFSPxFP\/aAAwDAQACEQMRAD8A3FERAEREAREQBERAERdXSekI6eN0srtljd58ABxKHG9N2dl7gASSABmSdwVP01j+CK7YB5Z3ODZnvcexUfE2K5axxFyyEHkxg+dzF54no3D4qGYFVsyNNolKeU29IFlrMZVkpylEY5owB\/2Nz3WUedITuN3TzHrlk\/8AbJcNBRSTG0Ubnnjsi4HWdw7Sp+nwZWEXLGt6HPF+4Kq\/Fn01PC5pfNkTFWSjdPMOqWQeDlLUWJauPdMXjmkAcO\/J3xXM7BtW0X2GHoDxf4hRtXQyQ\/vY3M6XDk+8MlFLx4b7kiTj9C56Mxsx2U7Ng+s27m9o3hWqGVr2hzXBzTuINwe0LIWtUjojSMtM7aiN2nzoz5run6Lukdt1JTxDfSz7k0ZtdTUEXT0XpJlQzbYehwO9p4ghdxaiaa1RMnqERF06EREAREQBERAEREAREQBERAEREARdOu0rBDnLMxntOAUNJjugBt5cHqa4jvAXuNU5dE2eJWQj8TSLI5wAuTYDeTwWJ4zxM6tmIaT5BhIjHrc7z18OYK\/aX0\/SVlO+COtZEZBa7gb24ixI37lRdIYFqYm7cexOz1ojc+7v7lDfCcVo0yllTlNaQ3XfQgIwtEwtgTaAlqwQDmIgbdW2R4Dt5l8auMMX\/Wp2EWNomuFsxkXkHuHatHUNdK6yPWNRtzSOKnp2RtDGNa1oyDWgADsC5URWS8F8vYHAggEHeDmD2L6RAVHTeEW2MlKNk7zF6J9n1D0bupVhjd4IIINiDkQRvBHBaqqti7RIsalgzb+9A9Jo9Lrb4XWbm4anFzgt\/wBkUo6bogNG1joJBKy5G57R6bf\/AGG8d3FaJTTtkY17DdrgC0jiDmFnDApzD2l2wB0chOzfajs0m20eW3Lpz+0VV4dl6Pw5vbsdWxb0UP8ApJBzvHXG\/wDJdul0tBJkyVpPNex7itmNsJfC0\/c98yO6iIvZ0IiIAiIgCIiAIiIAiL5e4AEk2AzJ5gEBw6Qro4I3SyuDWN3k+HSVk+JdYc05LKe8Mfrf6jh0n0R0DvUbjnE7q2azSRBGSIx6x4vPSeHQq40LZxcOMVzTW\/6MnIy3J8sOn7Pp7y47TiSTvJNz3lArlh\/V3UTgPmcIGHcCLyEezkGjrPYrdT6tKNo5Rleecvt90BTTzaYPTXX0K8cK6zfTT1MgUlonS89O7ahlczo3tPW05FWh+GtGzPdFT1pjla4t2JRkS0kEDaDS7dvBKr+m8PVFIQJmZHzXtN2O6jYWPQbFeq8mm7yp+zK8qLavMvumaNhLHLKkiKcCOU7iPMk6r+a7o+Kt8sgaLuIAG8k2C89MUhW6TmnsJpXvAAABOWQ5txPSqtvD05axeiLtXEnGGk1qzVK\/HFHGSBIZCOEbdoe8bN+KiJdZDb8imeR9N7W\/dDlnYX2FJHAqXXcgnxK59NF\/fqaBHrHF+VSuA+jICe4tHipWix1SPycXxH\/cbl7zSWjtKyxpXIAuywKX02PMeJ3x66P2\/g3GnqGSN2mOa4Hi0gj4LkIvkVilDVyQu2onuYfonI9Y3FX3DuNGyERVADHnJrx5jzwB9V3wPwVC\/BnXvHdGjj8RrtfLLZ\/giJqXyMj4eDHWb7B5TO4ED7JXIwqaxHoaZ8wliaHBzQ1wLg0gtJsc94zO7PLcUpMKuteWax9WMCw+04Eu6wG9S+Qv4bbO6XIti6tttCGcV1pWg7xdWt2FYuEkoPPtA\/AghRWkcNzx8qMiZvN5sg\/pf\/17VG+F317rR+h1v5o6dBpyaAgA+UZxY852+i\/eD0G46t6umjNJR1DNuM34EHzmnmI4FZw59\/x4EHmI4FftDXvglEse\/c5vB7fVPTzHgrWJmzg+Szp+UeFLTp0NSRcFFVtljbIw3a4XH5da51uEwREQBERAEREAVJ1q6aMFKIWmz5yW9IY2xefi0faV2WM63KrarwzhHE0W6XFzie4t7lawq1O1a9tytlz5anp32KY1ajqywqNkVkzbk\/uWngPXtznh0dazfRdN5WaOP13tb3kX+C9GQQhjWsaLBoAHUBZX8+5xioLuUsKpSk5PsciIixjWPOuII9mrqGkbppe7bcR8LK5YA006d3yCp+die12zt5uaRnYHqv1WUPrKovJaQkNspA145sxsn4j4qH0FpA09RFN\/DeCelu5w69klQJuMtUYMZOq5+u\/oS2JNCuo6h0RN2nlRu9Zh3X+kNx7+K49EaKmqX7ELNo8Tua3pc7h49C17TOgqeuYwyXIHKY5hsbOHON4OS7ujNHR08YiiaGtHeTzk8T0rb\/yOla2834LH+NTsb18v5KnonV5E0A1Ehkd6reSwfie3uVjp8O0rMm08Y+zfxUoioTvsn1ZoV49cF5YojZtA0zxZ0EZHsj8FCaSwHA8Xhc6J3vM908OohW1EhdZDo2dnRXNaSijHtL6FmpXWlbkTyXtzY7t4HoPxXS2bixW01NO2RhY9oc1wsQdxCzDE+gTSSDZuYnnkE72n1CfA8Vq4uZ4nll1\/Zg53D\/CXPX0\/RNYLxIQRTTOuDlE877+oT4Hs5leliDj\/APf351qWD9LmppwXm8jOS\/pt5ru0fG6rZ2Oo\/wCyPTuXeGZbsXhz6rp6E6iIs41is4u0JttM8Q+caLvA\/wBRo3\/aHA9iozn33LXiFk+lqfyU8sY3NebdRzHisvPpW1i9yCxaMseANIWe+nJyI8ozsIEg7y09pV2WU4cn2KyB309k9Ika5ni4HsWrK1hzcqlr22PVT20CIitEoREQBERAFh2tFhGkpCeLYyOrYA8QVuKynXLo8iWCoAyc0xOPMWkvb3hz\/dV3Alpdp80VM2OtXoynYYkDauBx3CRvivQ68zRuIIIyIzHWNy9BYU0w2rpY5Qc7bLxzPbk4fj2qxxKD2l7EGBNbx9yXREWUaRRNbGhvK07ahou6E8r2Hb+42KyNhXpSWMOaWuALXAgg7iCLEFYRjHDjqGctsTE4kxO6PVJ9Yf3UVke5lZ9LT8Re5etWGJA+MUkjuWwfNE+kz1etvh1LQF5tglLSHNJBBBBG8EbiOlaxhHHrJWiKqcGSDIPOTH9J9U\/BchPsyXEyk1ySL0i\/Ab5hfqmNAIiIAunpbR7aiF0T9zhkeLT6Lh0gqBxDjGOIFkBbJJuvvYzrI849AUPhXE8vlwyolL2yZAu2RsvPm7gLA7u5Rf8AojGainuRSsg\/KypTRuY5zHizmEtcOlpsezJTuBdIeTq2tJ5MoLD1jNvgU1gU2xWFw\/1GNd2jkn4Bqr9NPsSMf6j2u91wJ+AX0211Pqj5pJ4+Tt2f4\/4bki\/Gm4X6vnj6oLK8Vyg1k1uDgO5oBWk6Vr2wRPlecmjvO4DrJsFj00xc5z3b3EuPWTdUc6XlUSC6XRHc0KL1UA\/3Yz7rw4\/ALYFl2BKQyVrXcIWueT0uBjaO3acfsrUV7w46V+4o6NhERWycIiIAiIgCh8WaFFZSvh9LzmHmc3Nv5dqmEXqMnFpo5KKktGeaJoXRvcx4LXNJDgd4I3qbwniSShl228pjspGXycOBHM4cD0kLQ9YGCflX6xTgCYDlN3CQDd1OHxWRyxOY4se0tc02IIsQepb1VsMiGj90Yllc6J\/pnoHQmIKeraHQyAni05PHW1Si82RSFpDmktI3EEg94UzT4trmCzaqX7RDvvgqnPhr18j+5ajxBJedfY3klQlf8jr2vpjIyQ77NILmkekDzjoWMVunKmYWlqJHjmLjb3Rku3gytENdA85Db2T1PBb3XIPYuPhzUG29zy+IxlJR5dns9T5xNheaifZ42oyeRIByTzA+q5RDHL0bUQNkaWPaHNcLFrgCCOoqhad1ZxuJfSv8mf4brlnYd47brFnV8hbhSi9a+hSNEYgqabKGZzW+qeUz3XXA7LKz02sepA5ccTjzjab+JVcr8J1kHnQOcB6TOUPhn8FHOie3zmPb7TSPEKFucSKNlkNt0XiXWLUEcmKJp5ztO+FwoTSOn6moylmcW+o3ks6iG+cPauoaJrnea1x6gT4KXoMPVUvmQP63DZH\/AGUcpWy23JlOU\/qdRrl93vkrponV7udUyfYjy73n8O9V7EeH5KN+d3RE8iTwDrbneKjljziuYkcJJatEnS6Uhq4m09aS17Moqjj0B5PZe+\/rUfpPB1U1p8m0TNIOy6MjO45iVChy7FJpCWL91K9nsuIHaBkVexeK20rle6IbKq7fiW\/z7m2RjIdQXV0lpOKnbtSvDRwHE9Q3lZTJiSrcLGpkt0bLT3tAPxUbJMXHacS48S4kk9pzKilmLsi48j5Im8T4hdVvGRbEw8hnOd227ptkOa551COeuMvV6wbhF202oqW2tnHGd9+DndXAdqrRhO6erIVzTexOYJ0Oaenu8Wkl5TucC3Jb2D4kqxIi1IxUVoi7GKitEERF09BERAEREAREQBQeIsKU1YLyss8bpGZPHbucOggqcReoylF6xZ5lFSWjRkmktWFQzOGRko4A8h34j4qGkwVXNNvk7j1EEeK3RFcjxC1ddGVJYNT+aMA0ph6pp2CSaIsaTYE239NtyjF6AxDoltVTvgdltDkn1XDNp7\/xWB1dK+KR0cg2XsJa4cxH4LRxMnxk9eqM3MxfBa06M3DBenBV0rHk\/ONAbKPpD0up2\/t6FPLBcL4gfRTCRvKacpGesPwI4LbdE6UiqYhLC4Oae8HiCOBWZl4zqlquj\/uhp4eSrYaP4l\/dTur5dGDvAPYvpFTLh8iMDcB3L6REAUfp2tihgfJMA5gGbSAdsnINsd5O5dqsqmRMMkjg1rRck7gsixfiY1klm3bCw8gHe4+uRw6BwVnGx3bL6dyrlZEaYfXsSA0ZQ1WdNP8AJ3n\/AEZvNB5mneOwuHMAuvPg2sbmI2vHAscDfvsVV9+Vr9G+54Cy2bBuiHU1K1shPlHct4vcNJ3NHULDruuZvDqa1zJ9SniT8dtNaad1\/BnDcMVhy+Tv7bD8VJ0OAqp5+cLIh0naPc38wtRRZ6xoIvLGj3ZX9A4Qp6Y7djJJ677G3stGTevf0qwIinSSWiJoxUVogiIunoIiIAiIgCIiAIiIAiIgCIiAKl4\/wh8qb5eEDyzRmP4jRw9ocO5XRFJXZKuXNE8WVxsjyyPNrmkEgggg2IO8EbwQu\/ofTE1K\/bheWniN7XdY4rWsWYKirLvbaOb1wMndDhx696yjTOH6mldaaIgcHjNjupw8DYrcpya746Pr8mYN2NZRLmX3RoGh9ZsTgG1MbozxezlM6yPOHZdWemxVRSC7aqLqc4NPuusVgwK\/VHPh9UnqtUSQ4lbFaSSZvc2JqNgu6qh7HtJ7hmVXtK6yKdlxAx0zuBI2Gd55R7B2rJgV+7S5Dh1ae7bE+J2teVJE1pzEM9W68r+SDyWDJg7OJ6SozaXNozRs1Q7ZgidIegZDrccgOsrTcK4DZARLUFskozDR5jD2+cekqa26qiOn4RBVRbkS1f3Z0dX+EiC2qqG24xMO8fTcOB5h2rQ0RYd1srZc0jfppjVHliERFEShERAEREAREQBERAEREAREQBERAEREAREQBfMjA4EOAIO8EXB7F9IgK3pHA1FMSTFsE8YyW\/AZKEl1XQHzZ5R0ENP4K\/op45NsekmQSxqpdYoz+PVbD6VRKeoMH4KXoMAUURBMZkI9dxI7tytKJLKul1kzkcWmO6ijjp4GsbssaGtHBoAHcFyIigLAREQBERAEREAREQBERAEREAREQBERAEREARFkGnKp4qZhtu893pHnQGvooDA7y6jYSSTd2834qfQBFUNY8hbFDskj5w7iR6B5lCYEmcasAucRsuyJJ4IDSkREAREQBERAEREAREQBERAEREAREQBERAfPlBzjvX6DfcssxpRGCqdYnYl5bczvJ5Y9657VN6t9KX8pA4\/TZfucPAoC8oiID8LgN5X4HjnCzTHulvKVPk2nkwjZy4uObj8GjsPOu9q50eXvdUOvZvIZe+bj5x7Bl9o8yAvpeOcd6xbED\/1qb6x3iuXE0Mxq59lkpG2bWa+3ZYKDe4gkG4PG+\/tuug17AMg+RMuRvdx6VYg8c471gsUcpF2MkI52tcR8ApnCkMwrYNpkoG3mS19tx33C4DVtKaNhnaGzN2g03HKc2xtb0SOC6+jtBU0L9uJgDrEX23HI78iSoLWY+0MOdvnD9xyg8ASk1gzPmO49CA05EVBxPjN22YqY7Ibk6TeSeIbwA6d54W4gX5fPlBzjvWLvq5ZTm6R563OK+vks38OX3Xfku6HDZvKDnHegeDuIWKTB7Mnh7b7tq48VbdWj7yzXN+Qz7zlw6aAi+XvABJNgMyTuACz3T+OXucWU3IYMvKEcp3SAfNHx6kBoi+fKDnHesWdVzSnN0kh45ucfgvr5NP8Aw5fdcunDZw8HiF+k23rMsFwSitjLmSAWfckOA8x3OrPrDdakB\/3G+Dlw6WXyg5x3p5Qc471iAmccgSeq6+7Seq\/ucunDbQV+rEPlD2He9p4ZuCtGFcXSNkbFO8vY8hoc7NzSchnxbfnXDpo6IiArOP8ARnlqUvaOXFyx0t9Id2fYsz0JpT5PPHNwaeV0tOTvh4LcXtBBBFwciOcFYTifRxpaqSH0QbsPOx2be4ZHpBQG6xvDgCDcEXB6DuXS05pEU9PJMfRGXS45NHfZQWrXS3lqQRk3dCdg+zvYe7L7KgNa2meWylafN+ck6zkxvdc9rUBUGvfLJYZvkd3ucfzK23QujxTwMib6Iz6Sc3Hvus21X6K8rO6ocORDk3pe78hn2tWrIAsHxQ79cn+sd4reFgGK3frtR9Y5Aazq5P6hH1u8VZlV9Wx\/Z8fW77ytCApGtR1oIfrD9xyr+rh960ew9Tets2p4frT9xyrurB964ew\/8EBoGNdJGCke5ps59mN+1vPYLlZTQQGWVkTd73Bo7TvV61ry2hgbzyE9zSP6lWNXrA6vjvwDz2hpsgNU0VouOnjDI2gW3m2bjxJPOu6iIDOtaLrSw+w7xTVa68s\/sM+85cetd1pYfYd4pqnd87Uewz7zkBLay9KGOBsLTYyk7Xst395sqRhnRhq6hsVyG+c8jeGjfbpO5Suteb9ajbzR373H8lUqHSssBLopHRkixLTvG+y6DeqKhjhaGRMa1o4Af\/XXYWFfpdWfzUneE\/S6s\/mpO8LgN1VU1lG1F\/yM\/FVXAmIamaujjkne9pD7tJFjZhI+Ks+tA2of+Rn4oCiYSfetgH0x4FbPsDmCw\/Bj\/wBfp\/b\/AAK3JAdDTOjo5oXse0G7TY2zabZEHnBWGeWNrjI2y6F6BIvkq\/8AoVQ7vIDvd+aA7f8Ai30P+39l+rt\/II\/VRAdpUDWzojbhbUtHKiOy\/pY78j4lX9cFfSNmjfE8Xa9pae0IDFsAYgbS1N5DaN7SHdFhdp7xbtUNpTSD6mofIc3SvyHWbNHdYLpaVpHU88kL\/OjcWnptuPURY9qtOqvQ3yir8q4XZAA49LjfYHiexdBq2FNEClpY4vSttPPO92bvy7ApdEXAF57xgbV1QD\/Ed+a9CLBtZlA6HSEriDsy2ew8DkARfoIQGn6sz+zout33irUsKwrj+aii8iI2yMBJFyQRffmOCtuHdZb6mqigNO1okda4cTbInd2IDsa4jamg+t\/ocq1qpdev\/wCN\/wCCsWug2poPrv6HKr6o3Xr\/APjf+CAumtinJpY3j0JBfqc0t8dlUPBmkhBWxPcbNuWuPMHjZv8AFbPpbR7aiF8L\/NeLdXMewrBdOaKlpJTFK0gjzTbJ44OaeIQHoZFjWhdY1RAwRva2VrRYF1w4DhmN6lm61ncaYe8fyQH7rdd87B7DvFNULry1HsR+LlWMX4pNc5jjHsbAI33vc3Vj1NuvLU+xH4vQH5rhgIlgl4Frm9oII+BPco7VbUR\/K3Ryta7yjLN2gDm03sL8bX7lo2NNAfLaV0YsHt5UZPrDh1HcsEk8rBLYh0csbukOa4ID0f8A4dD\/AAY\/cb+Sf4dD\/Bj9xv5LJtH61qljQ2SKOQj0rlpPYMl2\/wDNyT+WZ75\/JAajFRRtN2xsaecNAPeAqrrWP7PP1kfiV0MI6wn1lUynMDWBwcdoOJtstJ3di7mts\/s4\/WR+KAznA7\/2hTe3\/S5b0vPuAnftKm+s\/pcvQSAIiIAiIgCIiAq+IMC0tZMZ5Q8PIAOy6wOzuJ6bZdgUnhzD8NFEYoQbFxcS43JJAG\/qAUqiAIiIAo\/TOhYKtnk54w8cOdp5wd4UgiAoztVlDfLyo+3\/AGXa0Tq7pKeZk8Zk24zdt3XF7Ebu1W9EBD4lw5DXMbHNtWY7aGybZ2I8Cujh7A9NRS+WhMm1slvKdcWKsyIAuppHRsVQzYmja9vM4buo7x2LtrAMQ4oq2VU7G1czWtkcABIbAA7kBps2rSiJuBI3oD8viuP\/ACxoueX3\/wCyyb9Lq3+cm\/8AIU\/S6t\/nJv8AyFAT2sPQMNFLFHCXHaaXO2jfjYKc1LfvKk\/Rj8XLPYoqmrfdrZp3nLa5Tz2uN7DrK2rV1hh1FATLbyspBeBnsgbm34oC2qJ03humq\/38TXEbnbnD7QUsiAos2quiPmmVv27+IXF\/lRR+vL3j8lf0QFSw\/gCno52zxvkLmhwAcRblAg+KmsQ6EjrITBLtbBIdyTY3buzUmiAqGidXdJTzMnjMm3Gbtu64vYjd2q3oiAIiIAiIgCIiAIiIAiIgCIiAIiIAiIgCrVT57usoiA40CIgLLDuHUFyIiAIiIAiIgCIiAIiIAiIgCIiA\/9k="
   }
]"
}

نتیجه درخواست


{
  "success": true,
  "result": true
}

متد uploadfile

با استفاده از این متد می توانید یک فایل را بدون ایجاد سند در پوشه storage آپلود نمایید. از خروجی این فیلد می توانید فیلد سفارشی آپلود فایل استفاده نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: multipart/form-data

آدرس درخواست

POST endpoint/extended/uploadfile
  • امکان آپلود فایل با انتخاب هدر multipart با سادگی وجود دارد.

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/uploadfile

نتیجه درخواست


{
  "success": true,
  "result": array_of_uploaded_files
}

متد uploadproductimages

با استفاده از این متد می توانید تصویر کالاها را در ویتایگر آپلود و بروزرسانی نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: multipart/form-data

آدرس درخواست

POST endpoint/extended/uploadproductimages

پارامترها

{
    "record": "String",
    "files": "JSON String"
}
  • امکان آپلود فایل با انتخاب هدر multipart با سادگی وجود دارد. در این صورت نیازی با پرکردن فیلد files در API نمی باشد. در غیر این صورت فیلد files باید به فرمت زیر مقدار دهی شود 
    [ 
{ 
    name: filename,
    content: base64_content
}
]

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/uploadproductimages

{
    "record": "14x1254",
    "files": "[ 
   { 
      "name":"vtiger.jpg",
      "content":"\/9j\/4AAQSkZJRgABAQAAAQABAAD\/2wCEAAkGBxMSERUSEhIVFRUVGBgYFRcWGBcaFxYZFRcYFxUYHRcYICggGRolGxcWITEiJSkrLi4wGB8zODMtNygtLisBCgoKDg0OGxAQGy0mICUtNy0wODAtLystLS0tLS0tLS41LSstMy0vNS0tLS0tLy0vMS0tLS0tLS0tKystLS8tLf\/AABEIAOEA4QMBIgACEQEDEQH\/xAAcAAEAAwADAQEAAAAAAAAAAAAABQYHAwQIAgH\/xABHEAABAwICBQcHCAgGAwAAAAABAAIDBBEGIQUHEjFBIlFhcYGRsRMyQlJykqEUI2JzgrLB0RYkJTNTVMLhFRdDY4Oik9Lw\/8QAGgEBAAMBAQEAAAAAAAAAAAAAAAMEBQECBv\/EAC4RAAICAQIEBAYCAwEAAAAAAAABAgMEESEFEjFBEyJxgTJRYZGhsdHwFSPxFP\/aAAwDAQACEQMRAD8A3FERAEREAREQBERAERdXSekI6eN0srtljd58ABxKHG9N2dl7gASSABmSdwVP01j+CK7YB5Z3ODZnvcexUfE2K5axxFyyEHkxg+dzF54no3D4qGYFVsyNNolKeU29IFlrMZVkpylEY5owB\/2Nz3WUedITuN3TzHrlk\/8AbJcNBRSTG0Ubnnjsi4HWdw7Sp+nwZWEXLGt6HPF+4Kq\/Fn01PC5pfNkTFWSjdPMOqWQeDlLUWJauPdMXjmkAcO\/J3xXM7BtW0X2GHoDxf4hRtXQyQ\/vY3M6XDk+8MlFLx4b7kiTj9C56Mxsx2U7Ng+s27m9o3hWqGVr2hzXBzTuINwe0LIWtUjojSMtM7aiN2nzoz5run6Lukdt1JTxDfSz7k0ZtdTUEXT0XpJlQzbYehwO9p4ghdxaiaa1RMnqERF06EREAREQBERAEREAREQBERAEREARdOu0rBDnLMxntOAUNJjugBt5cHqa4jvAXuNU5dE2eJWQj8TSLI5wAuTYDeTwWJ4zxM6tmIaT5BhIjHrc7z18OYK\/aX0\/SVlO+COtZEZBa7gb24ixI37lRdIYFqYm7cexOz1ojc+7v7lDfCcVo0yllTlNaQ3XfQgIwtEwtgTaAlqwQDmIgbdW2R4Dt5l8auMMX\/Wp2EWNomuFsxkXkHuHatHUNdK6yPWNRtzSOKnp2RtDGNa1oyDWgADsC5URWS8F8vYHAggEHeDmD2L6RAVHTeEW2MlKNk7zF6J9n1D0bupVhjd4IIINiDkQRvBHBaqqti7RIsalgzb+9A9Jo9Lrb4XWbm4anFzgt\/wBkUo6bogNG1joJBKy5G57R6bf\/AGG8d3FaJTTtkY17DdrgC0jiDmFnDApzD2l2wB0chOzfajs0m20eW3Lpz+0VV4dl6Pw5vbsdWxb0UP8ApJBzvHXG\/wDJdul0tBJkyVpPNex7itmNsJfC0\/c98yO6iIvZ0IiIAiIgCIiAIiIAiL5e4AEk2AzJ5gEBw6Qro4I3SyuDWN3k+HSVk+JdYc05LKe8Mfrf6jh0n0R0DvUbjnE7q2azSRBGSIx6x4vPSeHQq40LZxcOMVzTW\/6MnIy3J8sOn7Pp7y47TiSTvJNz3lArlh\/V3UTgPmcIGHcCLyEezkGjrPYrdT6tKNo5Rleecvt90BTTzaYPTXX0K8cK6zfTT1MgUlonS89O7ahlczo3tPW05FWh+GtGzPdFT1pjla4t2JRkS0kEDaDS7dvBKr+m8PVFIQJmZHzXtN2O6jYWPQbFeq8mm7yp+zK8qLavMvumaNhLHLKkiKcCOU7iPMk6r+a7o+Kt8sgaLuIAG8k2C89MUhW6TmnsJpXvAAABOWQ5txPSqtvD05axeiLtXEnGGk1qzVK\/HFHGSBIZCOEbdoe8bN+KiJdZDb8imeR9N7W\/dDlnYX2FJHAqXXcgnxK59NF\/fqaBHrHF+VSuA+jICe4tHipWix1SPycXxH\/cbl7zSWjtKyxpXIAuywKX02PMeJ3x66P2\/g3GnqGSN2mOa4Hi0gj4LkIvkVilDVyQu2onuYfonI9Y3FX3DuNGyERVADHnJrx5jzwB9V3wPwVC\/BnXvHdGjj8RrtfLLZ\/giJqXyMj4eDHWb7B5TO4ED7JXIwqaxHoaZ8wliaHBzQ1wLg0gtJsc94zO7PLcUpMKuteWax9WMCw+04Eu6wG9S+Qv4bbO6XIti6tttCGcV1pWg7xdWt2FYuEkoPPtA\/AghRWkcNzx8qMiZvN5sg\/pf\/17VG+F317rR+h1v5o6dBpyaAgA+UZxY852+i\/eD0G46t6umjNJR1DNuM34EHzmnmI4FZw59\/x4EHmI4FftDXvglEse\/c5vB7fVPTzHgrWJmzg+Szp+UeFLTp0NSRcFFVtljbIw3a4XH5da51uEwREQBERAEREAVJ1q6aMFKIWmz5yW9IY2xefi0faV2WM63KrarwzhHE0W6XFzie4t7lawq1O1a9tytlz5anp32KY1ajqywqNkVkzbk\/uWngPXtznh0dazfRdN5WaOP13tb3kX+C9GQQhjWsaLBoAHUBZX8+5xioLuUsKpSk5PsciIixjWPOuII9mrqGkbppe7bcR8LK5YA006d3yCp+die12zt5uaRnYHqv1WUPrKovJaQkNspA145sxsn4j4qH0FpA09RFN\/DeCelu5w69klQJuMtUYMZOq5+u\/oS2JNCuo6h0RN2nlRu9Zh3X+kNx7+K49EaKmqX7ELNo8Tua3pc7h49C17TOgqeuYwyXIHKY5hsbOHON4OS7ujNHR08YiiaGtHeTzk8T0rb\/yOla2834LH+NTsb18v5KnonV5E0A1Ehkd6reSwfie3uVjp8O0rMm08Y+zfxUoioTvsn1ZoV49cF5YojZtA0zxZ0EZHsj8FCaSwHA8Xhc6J3vM908OohW1EhdZDo2dnRXNaSijHtL6FmpXWlbkTyXtzY7t4HoPxXS2bixW01NO2RhY9oc1wsQdxCzDE+gTSSDZuYnnkE72n1CfA8Vq4uZ4nll1\/Zg53D\/CXPX0\/RNYLxIQRTTOuDlE877+oT4Hs5leliDj\/APf351qWD9LmppwXm8jOS\/pt5ru0fG6rZ2Oo\/wCyPTuXeGZbsXhz6rp6E6iIs41is4u0JttM8Q+caLvA\/wBRo3\/aHA9iozn33LXiFk+lqfyU8sY3NebdRzHisvPpW1i9yCxaMseANIWe+nJyI8ozsIEg7y09pV2WU4cn2KyB309k9Ika5ni4HsWrK1hzcqlr22PVT20CIitEoREQBERAFh2tFhGkpCeLYyOrYA8QVuKynXLo8iWCoAyc0xOPMWkvb3hz\/dV3Alpdp80VM2OtXoynYYkDauBx3CRvivQ68zRuIIIyIzHWNy9BYU0w2rpY5Qc7bLxzPbk4fj2qxxKD2l7EGBNbx9yXREWUaRRNbGhvK07ahou6E8r2Hb+42KyNhXpSWMOaWuALXAgg7iCLEFYRjHDjqGctsTE4kxO6PVJ9Yf3UVke5lZ9LT8Re5etWGJA+MUkjuWwfNE+kz1etvh1LQF5tglLSHNJBBBBG8EbiOlaxhHHrJWiKqcGSDIPOTH9J9U\/BchPsyXEyk1ySL0i\/Ab5hfqmNAIiIAunpbR7aiF0T9zhkeLT6Lh0gqBxDjGOIFkBbJJuvvYzrI849AUPhXE8vlwyolL2yZAu2RsvPm7gLA7u5Rf8AojGainuRSsg\/KypTRuY5zHizmEtcOlpsezJTuBdIeTq2tJ5MoLD1jNvgU1gU2xWFw\/1GNd2jkn4Bqr9NPsSMf6j2u91wJ+AX0211Pqj5pJ4+Tt2f4\/4bki\/Gm4X6vnj6oLK8Vyg1k1uDgO5oBWk6Vr2wRPlecmjvO4DrJsFj00xc5z3b3EuPWTdUc6XlUSC6XRHc0KL1UA\/3Yz7rw4\/ALYFl2BKQyVrXcIWueT0uBjaO3acfsrUV7w46V+4o6NhERWycIiIAiIgCh8WaFFZSvh9LzmHmc3Nv5dqmEXqMnFpo5KKktGeaJoXRvcx4LXNJDgd4I3qbwniSShl228pjspGXycOBHM4cD0kLQ9YGCflX6xTgCYDlN3CQDd1OHxWRyxOY4se0tc02IIsQepb1VsMiGj90Yllc6J\/pnoHQmIKeraHQyAni05PHW1Si82RSFpDmktI3EEg94UzT4trmCzaqX7RDvvgqnPhr18j+5ajxBJedfY3klQlf8jr2vpjIyQ77NILmkekDzjoWMVunKmYWlqJHjmLjb3Rku3gytENdA85Db2T1PBb3XIPYuPhzUG29zy+IxlJR5dns9T5xNheaifZ42oyeRIByTzA+q5RDHL0bUQNkaWPaHNcLFrgCCOoqhad1ZxuJfSv8mf4brlnYd47brFnV8hbhSi9a+hSNEYgqabKGZzW+qeUz3XXA7LKz02sepA5ccTjzjab+JVcr8J1kHnQOcB6TOUPhn8FHOie3zmPb7TSPEKFucSKNlkNt0XiXWLUEcmKJp5ztO+FwoTSOn6moylmcW+o3ks6iG+cPauoaJrnea1x6gT4KXoMPVUvmQP63DZH\/AGUcpWy23JlOU\/qdRrl93vkrponV7udUyfYjy73n8O9V7EeH5KN+d3RE8iTwDrbneKjljziuYkcJJatEnS6Uhq4m09aS17Moqjj0B5PZe+\/rUfpPB1U1p8m0TNIOy6MjO45iVChy7FJpCWL91K9nsuIHaBkVexeK20rle6IbKq7fiW\/z7m2RjIdQXV0lpOKnbtSvDRwHE9Q3lZTJiSrcLGpkt0bLT3tAPxUbJMXHacS48S4kk9pzKilmLsi48j5Im8T4hdVvGRbEw8hnOd227ptkOa551COeuMvV6wbhF202oqW2tnHGd9+DndXAdqrRhO6erIVzTexOYJ0Oaenu8Wkl5TucC3Jb2D4kqxIi1IxUVoi7GKitEERF09BERAEREAREQBQeIsKU1YLyss8bpGZPHbucOggqcReoylF6xZ5lFSWjRkmktWFQzOGRko4A8h34j4qGkwVXNNvk7j1EEeK3RFcjxC1ddGVJYNT+aMA0ph6pp2CSaIsaTYE239NtyjF6AxDoltVTvgdltDkn1XDNp7\/xWB1dK+KR0cg2XsJa4cxH4LRxMnxk9eqM3MxfBa06M3DBenBV0rHk\/ONAbKPpD0up2\/t6FPLBcL4gfRTCRvKacpGesPwI4LbdE6UiqYhLC4Oae8HiCOBWZl4zqlquj\/uhp4eSrYaP4l\/dTur5dGDvAPYvpFTLh8iMDcB3L6REAUfp2tihgfJMA5gGbSAdsnINsd5O5dqsqmRMMkjg1rRck7gsixfiY1klm3bCw8gHe4+uRw6BwVnGx3bL6dyrlZEaYfXsSA0ZQ1WdNP8AJ3n\/AEZvNB5mneOwuHMAuvPg2sbmI2vHAscDfvsVV9+Vr9G+54Cy2bBuiHU1K1shPlHct4vcNJ3NHULDruuZvDqa1zJ9SniT8dtNaad1\/BnDcMVhy+Tv7bD8VJ0OAqp5+cLIh0naPc38wtRRZ6xoIvLGj3ZX9A4Qp6Y7djJJ677G3stGTevf0qwIinSSWiJoxUVogiIunoIiIAiIgCIiAIiIAiIgCIiAKl4\/wh8qb5eEDyzRmP4jRw9ocO5XRFJXZKuXNE8WVxsjyyPNrmkEgggg2IO8EbwQu\/ofTE1K\/bheWniN7XdY4rWsWYKirLvbaOb1wMndDhx696yjTOH6mldaaIgcHjNjupw8DYrcpya746Pr8mYN2NZRLmX3RoGh9ZsTgG1MbozxezlM6yPOHZdWemxVRSC7aqLqc4NPuusVgwK\/VHPh9UnqtUSQ4lbFaSSZvc2JqNgu6qh7HtJ7hmVXtK6yKdlxAx0zuBI2Gd55R7B2rJgV+7S5Dh1ae7bE+J2teVJE1pzEM9W68r+SDyWDJg7OJ6SozaXNozRs1Q7ZgidIegZDrccgOsrTcK4DZARLUFskozDR5jD2+cekqa26qiOn4RBVRbkS1f3Z0dX+EiC2qqG24xMO8fTcOB5h2rQ0RYd1srZc0jfppjVHliERFEShERAEREAREQBERAEREAREQBERAEREAREQBfMjA4EOAIO8EXB7F9IgK3pHA1FMSTFsE8YyW\/AZKEl1XQHzZ5R0ENP4K\/op45NsekmQSxqpdYoz+PVbD6VRKeoMH4KXoMAUURBMZkI9dxI7tytKJLKul1kzkcWmO6ijjp4GsbssaGtHBoAHcFyIigLAREQBERAEREAREQBERAEREAREQBERAEREARFkGnKp4qZhtu893pHnQGvooDA7y6jYSSTd2834qfQBFUNY8hbFDskj5w7iR6B5lCYEmcasAucRsuyJJ4IDSkREAREQBERAEREAREQBERAEREAREQBERAfPlBzjvX6DfcssxpRGCqdYnYl5bczvJ5Y9657VN6t9KX8pA4\/TZfucPAoC8oiID8LgN5X4HjnCzTHulvKVPk2nkwjZy4uObj8GjsPOu9q50eXvdUOvZvIZe+bj5x7Bl9o8yAvpeOcd6xbED\/1qb6x3iuXE0Mxq59lkpG2bWa+3ZYKDe4gkG4PG+\/tuug17AMg+RMuRvdx6VYg8c471gsUcpF2MkI52tcR8ApnCkMwrYNpkoG3mS19tx33C4DVtKaNhnaGzN2g03HKc2xtb0SOC6+jtBU0L9uJgDrEX23HI78iSoLWY+0MOdvnD9xyg8ASk1gzPmO49CA05EVBxPjN22YqY7Ibk6TeSeIbwA6d54W4gX5fPlBzjvWLvq5ZTm6R563OK+vks38OX3Xfku6HDZvKDnHegeDuIWKTB7Mnh7b7tq48VbdWj7yzXN+Qz7zlw6aAi+XvABJNgMyTuACz3T+OXucWU3IYMvKEcp3SAfNHx6kBoi+fKDnHesWdVzSnN0kh45ucfgvr5NP8Aw5fdcunDZw8HiF+k23rMsFwSitjLmSAWfckOA8x3OrPrDdakB\/3G+Dlw6WXyg5x3p5Qc471iAmccgSeq6+7Seq\/ucunDbQV+rEPlD2He9p4ZuCtGFcXSNkbFO8vY8hoc7NzSchnxbfnXDpo6IiArOP8ARnlqUvaOXFyx0t9Id2fYsz0JpT5PPHNwaeV0tOTvh4LcXtBBBFwciOcFYTifRxpaqSH0QbsPOx2be4ZHpBQG6xvDgCDcEXB6DuXS05pEU9PJMfRGXS45NHfZQWrXS3lqQRk3dCdg+zvYe7L7KgNa2meWylafN+ck6zkxvdc9rUBUGvfLJYZvkd3ucfzK23QujxTwMib6Iz6Sc3Hvus21X6K8rO6ocORDk3pe78hn2tWrIAsHxQ79cn+sd4reFgGK3frtR9Y5Aazq5P6hH1u8VZlV9Wx\/Z8fW77ytCApGtR1oIfrD9xyr+rh960ew9Tets2p4frT9xyrurB964ew\/8EBoGNdJGCke5ps59mN+1vPYLlZTQQGWVkTd73Bo7TvV61ry2hgbzyE9zSP6lWNXrA6vjvwDz2hpsgNU0VouOnjDI2gW3m2bjxJPOu6iIDOtaLrSw+w7xTVa68s\/sM+85cetd1pYfYd4pqnd87Uewz7zkBLay9KGOBsLTYyk7Xst395sqRhnRhq6hsVyG+c8jeGjfbpO5Suteb9ajbzR373H8lUqHSssBLopHRkixLTvG+y6DeqKhjhaGRMa1o4Af\/XXYWFfpdWfzUneE\/S6s\/mpO8LgN1VU1lG1F\/yM\/FVXAmIamaujjkne9pD7tJFjZhI+Ks+tA2of+Rn4oCiYSfetgH0x4FbPsDmCw\/Bj\/wBfp\/b\/AAK3JAdDTOjo5oXse0G7TY2zabZEHnBWGeWNrjI2y6F6BIvkq\/8AoVQ7vIDvd+aA7f8Ai30P+39l+rt\/II\/VRAdpUDWzojbhbUtHKiOy\/pY78j4lX9cFfSNmjfE8Xa9pae0IDFsAYgbS1N5DaN7SHdFhdp7xbtUNpTSD6mofIc3SvyHWbNHdYLpaVpHU88kL\/OjcWnptuPURY9qtOqvQ3yir8q4XZAA49LjfYHiexdBq2FNEClpY4vSttPPO92bvy7ApdEXAF57xgbV1QD\/Ed+a9CLBtZlA6HSEriDsy2ew8DkARfoIQGn6sz+zout33irUsKwrj+aii8iI2yMBJFyQRffmOCtuHdZb6mqigNO1okda4cTbInd2IDsa4jamg+t\/ocq1qpdev\/wCN\/wCCsWug2poPrv6HKr6o3Xr\/APjf+CAumtinJpY3j0JBfqc0t8dlUPBmkhBWxPcbNuWuPMHjZv8AFbPpbR7aiF8L\/NeLdXMewrBdOaKlpJTFK0gjzTbJ44OaeIQHoZFjWhdY1RAwRva2VrRYF1w4DhmN6lm61ncaYe8fyQH7rdd87B7DvFNULry1HsR+LlWMX4pNc5jjHsbAI33vc3Vj1NuvLU+xH4vQH5rhgIlgl4Frm9oII+BPco7VbUR\/K3Ryta7yjLN2gDm03sL8bX7lo2NNAfLaV0YsHt5UZPrDh1HcsEk8rBLYh0csbukOa4ID0f8A4dD\/AAY\/cb+Sf4dD\/Bj9xv5LJtH61qljQ2SKOQj0rlpPYMl2\/wDNyT+WZ75\/JAajFRRtN2xsaecNAPeAqrrWP7PP1kfiV0MI6wn1lUynMDWBwcdoOJtstJ3di7mts\/s4\/WR+KAznA7\/2hTe3\/S5b0vPuAnftKm+s\/pcvQSAIiIAiIgCIiAq+IMC0tZMZ5Q8PIAOy6wOzuJ6bZdgUnhzD8NFEYoQbFxcS43JJAG\/qAUqiAIiIAo\/TOhYKtnk54w8cOdp5wd4UgiAoztVlDfLyo+3\/AGXa0Tq7pKeZk8Zk24zdt3XF7Ebu1W9EBD4lw5DXMbHNtWY7aGybZ2I8Cujh7A9NRS+WhMm1slvKdcWKsyIAuppHRsVQzYmja9vM4buo7x2LtrAMQ4oq2VU7G1czWtkcABIbAA7kBps2rSiJuBI3oD8viuP\/ACxoueX3\/wCyyb9Lq3+cm\/8AIU\/S6t\/nJv8AyFAT2sPQMNFLFHCXHaaXO2jfjYKc1LfvKk\/Rj8XLPYoqmrfdrZp3nLa5Tz2uN7DrK2rV1hh1FATLbyspBeBnsgbm34oC2qJ03humq\/38TXEbnbnD7QUsiAos2quiPmmVv27+IXF\/lRR+vL3j8lf0QFSw\/gCno52zxvkLmhwAcRblAg+KmsQ6EjrITBLtbBIdyTY3buzUmiAqGidXdJTzMnjMm3Gbtu64vYjd2q3oiAIiIAiIgCIiAIiIAiIgCIiAIiIAiIgCrVT57usoiA40CIgLLDuHUFyIiAIiIAiIgCIiAIiIAiIgCIiA\/9k="
   }
]"
}

نتیجه درخواست


{
  "success": true,
  "result": true
}

متد retrieve_image

با استفاده از این متد می توانید فایل های تصویر آپلود شده مرتبط با ماژول مخاطبین و محصولات را دریافت نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/retrieve_image?record=String

پارامترها

{
    "record": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/retrieve_image?record=14x2795

نتیجه درخواست


{
  "success": true,
  "result":  {
        image_name1: {
            id: id,
            orgname: original_name,
            path: path,
            name: file_name,
            content: base64_content
        },
        ...
    }
}

متد file_retrieve_by_id

با استفاده از این متد می توانید محتوای فایل یک سند را با استفاده از آی دی رکورد در ویتایگر به صورت base64 دریافت نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/file_retrieve_by_id?file_id=String

پارامترها

{
    "file_id": "String"
}

نکته: ماژول هایی نظیر مخاطبین و محصولات که امکان آپلود تصویر را در دارا می باشند در این متد پشتیبانی می شوند

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/file_retrieve_by_id?file_id=12x2735

نتیجه درخواست


{
  "success": true,
  "result": [ 
      { 
         fileid: integer,
         filename: string,
         filetype: string,
         filesize: integer,
         filecontents: base64_content
      },
      ...
   ]
}

متد file_retrieve_by_path

با استفاده از این متد میتوانید با دادن مسیر یک فایل بر روی ویتایگر از طریق مسیر محتوای فایل را به صورت base64 دریافت نمایید برای نمونه مقدار ورودی این متد از طریق مقدار فیلد سفارشی آپلود فایل قابل مقداردهی است

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/file_retrieve_by_path?file_path=String

پارامترها

{
    "file_path": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/file_retrieve_by_path?file_path=storage/2019/October/week5/2637_CRM.zip$$23848$$application/zip||storage/2019/October/week5/2638_55.zip$$250072$$application/zip

نتیجه درخواست


{
  "success": true,
  "result": [ 
      { 
         fileid: integer,
         filename: string,
         filetype: string,
         filesize: integer,
         filecontents: base64_content
      },
      ...
   ]
}

متد getpdf

با استفاده از این متد قادر خواهید بود در ماژول های مرتبط با انبار نظیر فاکتور، پیش فاکتور، سفارش خرید و سفارش فروش خروجی PDF اورجینال ویتایگر را به صورت محتوای base64 دریافت نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/getpdf?record=String&official=String

پارامترها

{
    "record": "String",
    "official": "String"
}

در صورتی که مقدار پارامتر official برابر 1 وارد شود و رکورد مرتبط با ماژول فاکتور باشد محتوای فایل دریافتی به فرمت فاکتور رسمی دارایی خواهد بود

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/getpdf?record=string&official=0

نتیجه درخواست


{
  "success": true,
  "result": {
        content: base64_content,
        size: file_size,
        module: module_name,
        id: record_id
    }
}

متد getpdfmaker

در صورتی که از ماژول PDF ساز ویتایگر استفاده می کنید به وسیله این متد قادر خواهید بود مقدار خروجی PDF ساز را بر روی وب سرویس دریافت نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/getpdfmaker?record=String&templateid=String&language=String

پارامترها

{
    "record": "String",
    "templateid": "String",
    "language": "String"
}

نکته:

  • record: با شماره رکوردی که می خواهید خروجی آن را دریافت نمایید جایگزین می شود
  • templateid: شماره قالب دلخواه در PDF ساز می باشد
  • language: زبان دلخواه برای خروجی PDF می باشد و به صورت اختیاری می باشد

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/getpdfmaker?record=111x2477&templateid=2&language=fa_ir

نتیجه درخواست


{
  "success": true,
  "result": [
        file_name,
        base64_contents
    ]
}

متد getportalinfo

با استفاده از این متد قادر خواهید بود اطلاعات مرتبط با پورتال مشترکین یک مخاطب را مشاهده نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/getportalinfo?record=String

پارامترها

{
    "record": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/getportalinfo?record=12x1900

نتیجه درخواست


{
  "success": true,
  "result": array_of_customer_portal_information
}

متد authenticateportaluser

با استفاده از این متد می توانید نام کاربری و گذرواژه پورتال مشترکین یک مخاطب را احراز هویت کنید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/authenticateportaluser

پارامترها

{
    "username": "String",
    "password": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/authenticateportaluser

{
    "username": "info@vtfarsi.ir",
    "password": "123456"
}

نتیجه درخواست


{
  "success": true,
  "result": boolean_value_of_success_login
}

متد forgotportalpassword

با استفاده از این متد گذرواژه و نام کاربری مخاطب جهت ورود به پورتال مجددا برای مخاطب ارسال می شود

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/forgotportalpassword

پارامترها

{
    "email": "String",
    "record": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/forgotportalpassword

{
    "email": "info@vtfarsi.ir",
    "record": "12x1900"
}

نتیجه درخواست


{
  "success": true,
  "result": Mail has been sent to your mail id with the customer portal login details
}

متد changeportalpassword

با استفاده از این متد قادر خواهید بود گذرواژه ورود به پورتال یک مخاطب را تغییر دهید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/changeportalpassword

پارامترها

{
    "record": "String",
    "newpassword": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/changeportalpassword

{
    "record": "12x1900",
    "newpassword": "123456"
}

نتیجه درخواست


{
  "success": true,
  "result": Password changed successfully
}

متد ping_online

با استفاده از این متد قادر خواهید بود آی دی مخاطب یا سرنخ مورد نظر خود را فراخوانی کنید و اطلاعات آخرین تاریخ و زمان و صفحه مورد بازدید را پروفایل هر رکورد ذخیره کنید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/ping_online?record=String&reffer=String

پارامترها

{
    "record": "String",
    "reffer": "String"
}

اطلاعات ذخیره شده در فیلد های “آخرین تاریخ آنلاین بودن”، “آخرین زمان آنلاین بودن” و “آخرین آدرس بازدید شده” قابل مشاهده است

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/ping_online?record=10x4679&reffer=visited_page_address_by_user

نتیجه درخواست

1x1 pixel png image

متد get_account_hierarchy

با استفاده از این متد قادر خواهید بود سلسله مراتب سازمانی یک سازمان را در ویتایگر به صورت سازمان های والد و فرزند مشاهده نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/get_account_hierarchy?id=String

پارامترها

{
    "id": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/get_account_hierarchy?id=11x2594

نتیجه درخواست


{
  "success": true,
  "result": [
        {
            id: target_record_id,
            name: record_label,
            label: Org | Parent Org
            level: depth
            current: boolean
        }
    ]
}

متد get_record_hierarchy

با استفاده از این متد قادر خواهید بود سلسله ارتباطات یک رکورد را در ویتایگر به صورت رکورد های والد و فرزند مشاهده نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/get_record_hierarchy?record=String

پارامترها

{
    "record": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/get_record_hierarchy?record=12x2933

نتیجه درخواست


{
  "success": true,
  "result": array_of_record_hierarchy
}

نکته برای مشاهده و استفاده از این متد ماژول مقصد باید با خودش فیلد مرتبط داشته باشد

متد retrieve_roles_hierarchy

با استفاده از این متد قادر خواهید بود سلسله چارت سازمانی و جایگاه کاربر وب سرویس در چارت را به صورت آرایه مشاهده نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/retrieve_roles_hierarchy

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/retrieve_roles_hierarchy

نتیجه درخواست


{
  "success": true,
  "result": array_of_organisation_chart_roles
}

متد lookup

با استفاده از این متد قادر خواهید بود برای یک ایمیل یا شماره تلفن در ماژول های مختلف جستجو کنید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/lookup?type=String&value=String&searchIn=String

پارامترها

{
    "type": "String",
    "value": "String",
    "searchIn": "String"
}

پارامتر type با دو مقدار phone و email قابل مقدار دهی می باشد

پارامتر value می تواند شامل ایمیل یا شمار تلفن باشد

پارامتر searchIn به صورت اختیاری می باشد و می تواند نام ماژول و فیلد هایی که می خواهید در آنها جستجو انجام شود را مشخص کند و در صورت خالی بودن در کل سیستم جستجو را انجام خواهد داد

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/lookup?type=phone&value=09138086200&searchIn={"Contacts":["mobile","phone"]}

نتیجه درخواست


{
  "success": true,
  "result": array_of_matching_records
}

متد lookupuserextension

از این متد می توانید جهت بررسی این که شماره مورد جستجو قبلا با چه شخصی صحبت کرده است یا به چه شخصی ارجاع شده است استفاده نمایید. از این قابلیت میتوانید در یکپارچه سازی با سیستم تلفنی ویپ استفاده نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/lookupuserextension?phone=String&searchby=String&fixnumber=String&citycode=String&countrycode=String

پارامترها

{
    "phone": "String",
    "searchby": "String",
    "fixnumber": "String",
    "citycode": "String",
    "countrycode": "String"
}

پارامتر phone برای جستجوی شماره تلفنی که می خواهید داخلی مرتبط با آن را بیابید استفاده می شود

پارامتر searchby و دو مقدار owner و lastcall را دریافت میکند. پارامتر owner برای جستجو شماره داخلی متصل به crm کاربری است که شماره تلفن مورد جستجو به آن ارجاع شده است و در حقیقت شماره داخلی کاربری که مالک رکورد است را باز می گرداند. پارامتر lastcall شماره داخلی کاربری که آخرین بار با شماره مورد جستجو تماس تلفنی داشته است را از طریق ماژول مرکز تماس ویپ خوانده و باز می گرداند.
این فیلد به صورت اختیاری بوده و در صورت خالی بودن مقدار owner به صورت پیش فرض انتخاب می شود

پارامتر fixnumber مقدار 0 یا 1 قبول می کند. از این پارامتر برای اصلاح شماره تلفن ها استفاده می شود و در صورتی که مقدار 1 بگیرد شماره تلفن های ورودی را براساس پارامتر citycode برای کد شهر و countrycode برای کد کشور اصلاح خواهد کرد. اهمیت این موضوع آنجا پررنگ می شود که وقتی در آدرس را در مرکز تلفن استریسک تنظیم می کنید و شخصی تماس میگیرید اگر شماره او به صورت 09138086200 و یا 91007879 ثبت شده باشد بسته به مرکز مخابراتی ممکن است به پیش شماره های +98، 98، بدون صفر یا با کدشهر مثلا +983191007879 یا 9138086200 در استریسک وارد شود و عملا جستجوی این شماره در سیستم اطلاعاتی را بازنخواهد گرداند. این متد شماره را به فرمت صحیح در ویتایگر اصلاح خواهد کرد

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/lookupuserextension?phone=+983191007879&searchby=lastcall&fixnumber=1&citycode=21&countrycode=98

نتیجه درخواست


{
  "success": true,
  "result": finded_extension
}

نکته: این متد تنها در فیلدهای شماره تلفن ماژول سرنخ، مخاطب و سازمان ها به جستجو می پردازد

در صورت پیدا نشدن داخلی پارامتر success در خروجی به صورت false خواهد بود

متد getuserextensionbyfield

این متد به شما امکان می دهد مقدار فیلد پیش فرض یا فیلد سفارشی که قبلا در ماژول مرکز تلفن ویپ وجود دارد را براساس شماره تماس مشتری که قبلا تماس گرفته است جستجو و مشاهده نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/getuserextensionbyfield?phone=String&field=String&fixnumber=String&citycode=String&countrycode=String

پارامترها

{
    "phone": "String",
    "field": "String",
    "fixnumber": "String",
    "citycode": "String",
    "countrycode": "String"
}

پارامتر phone برای جستجوی شماره تلفنی که می خواهید مقدار فیلد موردجستجو در آن را بیابید استفاده می شود

پارامتر field برای مشخص کردن نام فیلدی که می خواهید محتوای آن را در صورت یافتن بازگردانید استفاده می شود

پارامتر fixnumber مقدار 0 یا 1 قبول می کند. از این پارامتر برای اصلاح شماره تلفن ها استفاده می شود و در صورتی که مقدار 1 بگیرد شماره تلفن های ورودی را براساس پارامتر citycode برای کد شهر و countrycode برای کد کشور اصلاح خواهد کرد. اهمیت این موضوع آنجا پررنگ می شود که وقتی در آدرس را در مرکز تلفن استریسک تنظیم می کنید و شخصی تماس میگیرید اگر شماره او به صورت 09138086200 و یا 91007879 ثبت شده باشد بسته به مرکز مخابراتی ممکن است به پیش شماره های +98، 98، بدون صفر یا با کدشهر مثلا +983191007879 یا 9138086200 در استریسک وارد شود و عملا جستجوی این شماره در سیستم اطلاعاتی را بازنخواهد گرداند. این متد شماره را به فرمت صحیح در ویتایگر اصلاح خواهد کرد

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/getuserextensionbyfield?phone=+983191007879&field=cf_2800&fixnumber=1&citycode=31&countrycode=98

نتیجه درخواست


{
  "success": true,
  "result": finded_extension
}

نکته: این متد فقط در صورتی که مرکز تلفن ویپ راه اندازی شده باشد و اطلاعاتی در آن ثبت شده باشد قابل استفاده است. از این متد می توانید در سفارشی سازی مرکز تلفن استریسک خود استفاده نمایید

متد vtsearch

این متد براساس سرچ سریع پیشفرض در ویتایگر دنبال رکوردهای دارای مطابقت با کلمه کلیدی می گردد، این جستجو محدود به فیلدهای خاصی نظیر شماره تلفن، نام و ایمیل و .. می باشد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/vtsearch?keyword=String

پارامترها

{
    "keyword": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/vtsearch?keyword=پارس ویتایگر

نتیجه درخواست


{
  "success": true,
  "result": array_of_matching_records
}

متد search

این متد براساس سرچ پیشفرض در ویتایگر دنبال رکوردهای دارای مطابقت با کلمه کلیدی می گردد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/search?keyword=String

پارامترها

{
    "keyword": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/search?keyword=پارس ویتایگر

نتیجه درخواست


{
  "success": true,
  "result": array_of_matching_records
}

متد globalsearch

این متد با استفاده از ماژول جستجوی عمومی و تنظیمات آن دنبال رکوردهای دارای مطابقت با کلمه کلیدی می گردد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/globalsearch?keyword=String

پارامترها

{
    "keyword": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/globalsearch?keyword=پارس ویتایگر

نتیجه درخواست


{
  "success": true,
  "result": array_of_matching_records
}

متد transformlead

این متد سرنخ فروش را به مخاطب، سازمان و فرصت فروش تبدیل می کند

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/transformlead

پارامترها

{
    "element": "JSON String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/transformlead

{
    "element": "{
    "leadId": "10x2728",
    "entities":{
        "Contacts": {"create": "true", "name": "Contacts","lastname":"\u0645\u062d\u0645\u062f \u0631\u0636\u0627 \u0628\u0631\u0627\u062a\u06cc"},
        "Accounts": {"create": "true", "name": "Accounts"},
        "Potentials": {"create": "true", "name": "Potentials","closingdate":"2020-12-01","sales_stage":"Qualification"}
    }
 }"
}

نتیجه درخواست


{
  "success": true,
  "result": {
        "Accounts": account_id,
        "Contacts": contact_id,
        "Potentials": potential_id
    }
}

متد transformpotential

این متد فرصت فروش را به پروژه تبدیل می کند

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/transformpotential

پارامترها

{
    "element": "JSON String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/transformpotential

{
    "element": "{ 
   "assignedTo":"19x1",
   "potentialId":"13x2763",
   "entities":{ 
      "Project":{ 
         "create":true,
         "name":"Project",
         "source":"CRM",
         "projectname":"sdasd"
      }
   }
 }"
}

نتیجه درخواست


{
  "success": true,
  "result": project_id
}

متد convertlead

این متد سرنخ فروش را به مخاطب، سازمان و فرصت فروش تبدیل می کند

⚠️ نوع متد وب سرویس: پیشفرض ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/default/convertlead

پارامترها

{
    "element": "JSON String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/default/convertlead

{
    "element": "{
    "leadId": "10x2728",
    "entities":{
        "Contacts": {"create": "true", "name": "Contacts","lastname":"\u0645\u062d\u0645\u062f \u0631\u0636\u0627 \u0628\u0631\u0627\u062a\u06cc"},
        "Accounts": {"create": "true", "name": "Accounts"},
        "Potentials": {"create": "true", "name": "Potentials","closingdate":"2020-12-01","sales_stage":"Qualification"}
    }
 }"
}

نتیجه درخواست


{
  "success": true,
  "result": {
        "Accounts": account_id,
        "Contacts": contact_id,
        "Potentials": potential_id
    }
}

متد showcitynamefield

با استفاده از این متد قادر خواهید بود مقدار فیلد سفارشی شهرهای ایران را به مقدار قابل نمایش تغییر دهید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/showcitynamefield?value=String&language=String

پارامترها

{
    "value": "String",
    "language": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/showcitynamefield?value=1438&language=fa_ir

نتیجه درخواست


{
  "success": true,
  "result": city_name
}

متد showdatetimefield

با استفاده از این متد می توانید فرمت خروجی فیلد تاریخ و زمان را به فرمت پیشفرض کاربر در ویتایگر نبدیل نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/showdatetimefield?value=String

پارامترها

{
    "value": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/showdatetimefield?value=2018-08-23 16:02:14

نتیجه درخواست


{
  "success": true,
  "result": datetime_value
}

متد showjalalidateformat

با استفاده از این فیلد می توانید فرمت خروجی تاریخ شمسی را براساس تاریخ میلادی ورودی تعیین کنید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/showjalalidateformat?value=String&format=String

پارامترها

{
    "value": "String",
    "format": "String"
}

مقدار پارامتر format از مقدار فرمت تابع date در php استفاده می کند

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/showjalalidateformat?value=1986-06-27&format=Y/m/d

نتیجه درخواست


{
  "success": true,
  "result": jalali_date_time
}

متد shownumbertopersian

با استفاده از این متد در صورتی که در مقدار ورودی عدد استفاده شده باشد اعداد را با کاراکترهای فارسی جایگزین می کند

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/shownumbertopersian?value=String

پارامترها

{
    "value": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/shownumbertopersian?value=1399

نتیجه درخواست


{
  "success": true,
  "result": farsi_numbers
}

متد showuserfullnamebyid

در این متد مقدار فیلد سفارشی لیست کاربران به نام و نام خانوادگی کاربران جهت نمایش تبدیل خواهد شد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/showuserfullnamebyid?value=String

پارامترها

{
    "value": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/showuserfullnamebyid?value=1,5

نتیجه درخواست


{
  "success": true,
  "result": show_user's_full_names
}

متد encryptpassword

ابن متد مقدار فیلد سفارشی پسورد را جهت استفاده در متدهای دیگر نظیر بروزرسانی یا ایجاد رمزگذاری می کند

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/encryptpassword?value=String

پارامترها

{
    "value": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/encryptpassword?value=123456

نتیجه درخواست


{
  "success": true,
  "result": encrypted_value
}

متد decryptpassword

با استفاده از این متد مقدار فیلد سفارشی پسورد که توسط متدهای دیگر واکشی شده است قابل دیکد و نمایش به مقدار واقعی خواهد بود

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/decryptpassword?value=String

پارامترها

{
    "value": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/decryptpassword?value=2UDNzITM

نتیجه درخواست


{
  "success": true,
  "result": decrypted_value
}

متد getgridfieldvalues

با استفاده از این متد مقدار فیلد سفارشی گرید که توسط متدهای دیگر واکشی شده است به صورت آرایه چند بعدی بازگردانده خواهد شد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/getgridfieldvalues?value=String

پارامترها

{
    "value": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/getgridfieldvalues?value=[{"تست":"ردیف 1 ستون 1","تست2":"ردیف 2 ستون 2"},{"تست":"ردیف 2 ستون 1","تست2":"ردیف 1 ستون 2"}]_

نتیجه درخواست


{
  "success": true,
  "result": array_of_gridfield_value
}

متد converttogridfield

این متد با ورودی یک آرایه چند بعدی از مقادیر دلخواه که به صورت رشته json ارسال گرده اید مقدار فیلد سفارشی گرید را جهت ثبت در سی آر ام بازمی گرداند

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/converttogridfield?value=JSON+String

پارامترها

{
    "value": "JSON String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/converttogridfield?value=json_string_of_multidimensional_array_values

نتیجه درخواست


{
  "success": true,
  "result": converted_value
}

متد getrepeaterfieldvalues

با استفاده از این متد مقدار فیلد سفارشی تکرار شونده که توسط متدهای دیگر واکشی شده است به صورت آرایه بازگردانده خواهد شدد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/getrepeaterfieldvalues?value=String

پارامترها

{
    "value": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/getrepeaterfieldvalues?value=[{"repeater":"09138086200"},{"repeater":"03191007879"}]_

نتیجه درخواست


{
  "success": true,
  "result": array_of_repeaterfield_value
}

متد converttorepeaterfield

این متد با ورودی یک آرایه تک بعدی از مقادیر دلخواه که به صورت رشته json ارسال گرده اید مقدار فیلد سفارشی تکرارشونده را جهت ثبت در سی آر ام بازمی گرداند

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/converttorepeaterfield?value=JSON+String

پارامترها

{
    "value": "JSON String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/converttorepeaterfield?value=json_string_of_array_values

نتیجه درخواست


{
  "success": true,
  "result": converted_value
}

متد getactiveworkflows

این متد لیست گردش کارهای فعال سیستم را همراه خلاصه ای از مشخصات و آی دی آنها نمایش میدهد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/getactiveworkflows

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/getactiveworkflows

نتیجه درخواست


{
  "success": true,
  "result": array_of_active_workflows
}

متد runworkflow

این متد امکان اجرای گردش کار دلخواه برای یک رکورد هدف در سی آر ام را فراهم میکند

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/runworkflow

پارامترها

{
    "workflowid": "String",
    "record": "String"
}

پارامتر record اطلاعات رکورد هدف و workflowid آی دی گردش کار انتخابی می باشد

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/runworkflow

{
    "workflowid": "42",
    "record": "11x2731"
}

نتیجه درخواست


{
  "success": true,
  "result": Run successfully!
}

متد sendemail

این متد امکان ارسال ایمیل از طریق ویتایگر توسط وب سرویس را فراهم می کند.

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/sendemail

پارامترها

{
    "subject": "String",
    "message": "String",
    "emails": "String"
}

پارامتر emails را می توانید برای چند ایمیل که با کاما از یکدیگر جدا شده اند مقدار دهی نمایید

        پارامتر subject و message به ترتیب با موضوع و محتوای ایمیل مقدار دهی می شوند

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/sendemail

{
    "subject": "Your Email Subject",
    "message": "Your Email Body",
    "emails": "info@vtfarsi.ir"
}

نتیجه درخواست


{
  "success": true,
  "result": true
}

متد sendsms

این متد امکان ارسال پیامک از طریق ویتایگر را فراهم می کند

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/sendsms

پارامترها

{
    "message": "String",
    "to": "String",
    "records": "String"
}

پارامتر records اختیاری می باشد و می توانید آن را برای چند شماره رکورد که با کاما از یکدیگر جدا شده اند مقدار دهی نمایید تا پیامک ارسالی با رکورهای انتخابی مرتبط گردد

        پارامتر message با محتوای پیامک مقدار دهی می شود و  از to می توانید برای یک یا چند شماره موبایل که با کاما از هم جداشده اند استفاده نمایید

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/sendsms

{
    "message": "\u0627\u06cc\u0646 \u06cc\u06a9 \u062a\u0633\u062a \u0627\u0633\u062a",
    "to": "09138086200,09388019100",
    "records": "12x2734"
}

نتیجه درخواست


{
  "success": true,
  "result": true
}

متد sendtelegram

از این متد می توانید جهت ارسال پیام روی تلگرام به شخص یا گروه های تلگرامی استفاده نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/sendtelegram

پارامترها

{
    "token": "String",
    "message": "String"
}

برای ارسال پیام باید مقدار token را با api توکن دریافتی از ربات @ParsPusher_bot مقدار دهی نمایید. همچنین پارامتر message جهت محتوای پیام مقداردهی می گردد

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/sendtelegram

{
    "token": "42a8f9e3338cc070e10185a1d283ff754201",
    "message": "Telegram Test Message"
}

نتیجه درخواست


{
  "success": true,
  "result": response_of_telegram_servers
}

متد servertime

از این متد میتوانید جهت دریافت تاریخ و زمان دقیق سرور ویتایگر استفاده کنید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/servertime

این مورد در مواردی مثل اتصال به سیستم های دیگر نظیر ویپ، حسابداری و .. اهمیت خواهد شد

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/servertime

نتیجه درخواست


{
  "success": true,
  "result": server_date_time
}

متد get_server_information

این متد مواردی نظیر حجم آپلود فایل بر روی سرور،تایم زون و نسخه ویتایگر را در اختیار کاربر قرار میدهد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/get_server_information

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/get_server_information

نتیجه درخواست


{
  "success": true,
  "result": server_array_of_server_config
}

متد retrieve_languages_list

این متد لیست بسته های زبان موجود و نصبی بر روی ویتایگر را بازمیگرداند

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/retrieve_languages_list

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/retrieve_languages_list

نتیجه درخواست


{
  "success": true,
  "result": array_of_active_languages
}

متد gettranslatedstring

این متد امکان دریافت ترجمه یک متغیر یا رشته از ویتایگر را فراهم می کند.

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/gettranslatedstring?key=String&module=String&language=String&type=String

پارامترها

{
    "key": "String",
    "module": "String",
    "language": "String",
    "type": "String"
}

پارامتر key با محتوای مورد نیاز برای ترجمه مقدار دهی میشود

پارامتر module با نام ماژولی که می خواهید ترجمه را از آن فراخوانی کنید مقدار دهی می شود در صورتی که این فیلد خالی گذاشته شود بسته زبان عمومی ویتایگر مورد استفاده قرار می گیرد

پارامتر language با نام بسته زبان دلخواهی که میخواهید ترجمه آن را دریافت نمایید مقداردهی میشود. در صورتی که این فیلد خالی گذاشته شود زبان فعلی انتخابی کاربر وب سرویس مورد استفاده قرار میگیرد

پارامتر type با دو مقدار lang و jslang قابل مقدار دهی است. در صورتی که مقدار دهی نشود به صورت پیش فرض lang مورد استفاده قرار خواهد گرفت. lang از متغیر زبان ویتایگر و jslang از متغیرهای زبان برای جاوااسکریپت ویتایگر استفاده میکند.

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/gettranslatedstring?key=Contacted&module=Leads&language=fa_ir&type=lang

نتیجه درخواست


{
  "success": true,
  "result": translated_value
}

متد add_documents_to_module

این متد مدیر سیستم را قادر می سازد ماژول اسناد را در ویتایگر به ماژول هایی که اسناد ندارند مثل تامین کنندگان مرتبط سازد.

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/add_documents_to_module

پارامترها

{
    "elementType": "String"
}

پارامتر elementType با نام ماژول هدف مقدار دهی میگردد

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/add_documents_to_module

{
    "elementType": "Vendors"
}

نتیجه درخواست


{
  "success": true,
  "result": true
}

نکته: ارتباط ایجاد شده از نوع get_attachments خواهد بود

متد add_field_to_users

همانطور که میدانید یا ممکن است با آن برخورد کرده باشید امکان اضافه کردن فیلد در ماژول کاربران از طریق برنامه وجود ندارد. این متد به شما اجازه میدهد تا فیلد های دلخواه خود را در ماژول کاربران اضافه نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/add_field_to_users

پارامترها

{
    "params": "JSON String"
}

نکته: پیش از هر کاری از بانک اطلاعاتی سیستم خود پشتیبان تهیه نمایید

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/add_field_to_users

{
    "params": "{ 
   "name":"new_field",
   "label":"\u0641\u06cc\u0644\u062f \u062c\u062f\u06cc\u062f \u062f\u0631 \u0645\u0627\u0698\u0648\u0644 \u06a9\u0627\u0631\u0628\u0631\u0627\u0646",
   "uitype":"1",
   "mandatory":"N",
   "block":"LBL_USER_ADV_OPTIONS"
 }"
}

نتیجه درخواست


{
  "success": true,
  "result": true
}

متد add_modcomment

این متد مدیر سیستم را قادر می سازد ماژول اسناد را در ویتایگر به ماژول هایی که اسناد ندارند مثل تامین کنندگان مرتبط سازد.

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/add_modcomment

پارامترها

{
    "elementType": "String"
}

پارامتر elementType با نام ماژول هدف مقدار دهی میگردد

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/add_modcomment

{
    "elementType": "Vendors"
}

نتیجه درخواست


{
  "success": true,
  "result": true
}

نکته: ارتباط ایجاد شده از نوع get_comments خواهد بود

متد change_identifier

با استفاده از این متد مدیر سیستم قادر خواهد بود شناسه ماژول (لیبل) را در ویتایگر بدون نیاز به کدنویسی تغییر دهد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/change_identifier

پارامترها

{
    "elementType": "String",
    "targetField": "String",
    "fixOlds": "Boolean"
}

در پارامتر elementType نام ماژولی که می خواهید لیبل آن را عوض کنید مقداردهی میشود

در پارامتر targetField نام فیلدی که میخواهید به عنوان لیبل جدید به سیستم معرفی کنید مقدار دهی می شود

در پارامتر fixOlds که به صورت 0 یا 1 مقدار دهی میشود می توانید پس از تغییر لیبل برای رکوردهای جدید کلیه رکوردهای قبلی را نیز با لیبل جدید بروزرسانی نمایید.

نکته: اگر لازم دارید که شناسه را به حالت اولیه برگردانید حتما پیش از انجام از بانک اطلاعاتی خود بک آپ تهیه نمایید

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/change_identifier

{
    "elementType": "Vendors",
    "targetField": "vendorname",
    "fixOlds": "1"
}

نتیجه درخواست


{
  "success": true,
  "result": true
}

برای اطلاعات بیشتر اینجا را کلیک کنید

متد dialer

در صورتی که ماژول مرکز تلفن ویپ شما به درستی کانفیگ شده باشد و قابلیت click to dial در ویتایگر شما کار می کند می توانید از این متد جهت برقراری تماس با مشتری استفاده نمایید. این متد با گرفتن 2 پارامتر ext برای شماره داخلی و number برای شماره تلفن هدف قابلیت کلیک تو دیال را در اختیار شما قرار می دهد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/dialer

پارامترها

{
    "ext": "String",
    "number": "Boolean"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/dialer

{
    "ext": "111",
    "number": "03191007879"
}

نتیجه درخواست


{
  "success": true,
  "result": boolean_value_of_operation
}

پاسخ وب سرویس در صورت انجام تنظیمات صحیح به صورت مقدار true یا false خواهد بود

متد cid_lookup_source

در صورتی که بخواهید در نرم افزارهای دیگر از قابلیت دفترچه تلفن ریموت استفاده کنید میتوانید از این متد استفاده نمایید
برای مثال در الستیکس یا freepbx می توانید از این متد در تعریف CID Lookup Source در استریسک استفاده نمایید

این قابلیت به شما امکان میدهد بدون ورود به سی آر ام یا نصب کانکتور ویپ در زمان تماس مشتری اسم مشتری را بر روی سافت فون یا آی پی فون مشاهده کنید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/cid_lookup_source?phone=String&format=Boolean&fix=Boolean&cyc=String&coc=String&finglish=String

پارامترها

{
    "phone": "String",
    "format": "Boolean",
    "fix": "Boolean",
    "cyc": "String",
    "coc": "String",
    "finglish": "String"
}

پارامتر phone با مقدار شماره ای که در سیستم دنبال آن می گردید مقداردهی می شود

پارامتر format امکان خروجی وب سرویس را به صورت نام مشتری یا نام و تلفن فراهم می آورد و مقدار ورودی 0 یا 1 می گیرد. مقدار 0 برای نام مشتری به تنهایی و 1 برای نام و تلفن استفاده می شود

پارامتر fix به صورت boolean می باشد و مقدار 0 یا 1 قبول می کند. از این پارامتر برای اصلاح شماره تلفن ها استفاده می شود و در صورتی که مقدار 1 بگیرد شماره تلفن های ورودی را براساس پارامتر cyc برای کد شهر و coc برای کد کشور اصلاح خواهد کرد.
اهمیت این موضوع آنجا پررنگ می شود که وقتی در آدرس را در مرکز تلفن استریسک تنظیم می کنید و شخصی تماس میگیرید اگر شماره او به صورت 09138086200 و یا 91007879 ثبت شده باشد بسته به مرکز مخابراتی ممکن است به پیش شماره های +98، 98، بدون صفر یا با کدشهر مثلا +983191007879 یا 9138086200 در استریسک وارد شود و عملا جستجوی این شماره در سیستم اطلاعاتی را بازنخواهد گرداند. این متد شماره را به فرمت صحیح در ویتایگر اصلاح خواهد کرد

پارامتر finglish برای تبدیل اسامی فارسی به فینگلیش استفاده میشود. اهمیت این مورد زمانی که از آی پی فون هایی که زبان فارسی یا یونیکد را پشتیبانی نمی کنند استفاده میکنید نمایان میشود که امکان نمایش نام فارسی را برروی تلفن ندارند. این پارامتر نام مثلا “محمد رضا تقی پور” را به “Mohammad Reza Taghi Pour” تبدیل خواهد کرد.
این پارامتر 6 ورودی می گیرد.

مقدار 0 برای غیرفعال بودن

مقدار 1 برای استفاده از دیکشنری اسامی فارسی که در مسیر modules/ParsVT/resources/finglish/words.json ذخیره شده است و امکان افزودن اسامی بیشتر را دارد

مقدار 2 برای استفاده از مترجم گوگل در برگردان کردن فارسی به فینگلیسی

مقدار 3 برای استفاده از متد تبدیل کاراکترهای فارسی به انگلیسی با ضریب خطای متوسط

مقدار 4 برای استفاده از متد دیکشنری و تبدیل کاراکتر فارسی به انگلیسی

مقدار 5 برای استفاده از همه متدها استفاده می شود

نکته: استفاده از مترجم گوگل ممکن است در صورت کندی سرعت اینترنت باعث ایجاد اختلال در عملکرد سیستم گردد

برای استفاده از این متد در استریسک باید از پارامترهای زیر به صورت نمونه استفاده نمایید. برای مشاهده راهنمای تنظیمات در freepbx اینجا را کلیک کنید.

Description: any string
Type: http (http/https)
Caching: no
Host: Your-CRM-URL
Port: 80(80/443)
.
User: api_username
Passord: api_accesskey
Path: /modules/ParsVT/ws/API/V2/vtiger/Extended/cid_lookup_source
Query: phone=[NUMBER]&format=1&fix=1&cyc=21&coc=98&finglish=5

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/cid_lookup_source?phone=03191007879&format=1&fix=1&cyc=31&coc=98&finglish=5

نتیجه درخواست

number_or_name_of_caller

پاسخ وب سرویس در صورت انجام تنظیمات صحیح به صورت رشته متنی خواهد بود

متد ocr

این متد به شما اجازی میدهد تصویری که با base64 کد شده است را جهت خواندن محتوای آن نظیر شماره تلفن و .. بررسی نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/ocr

پارامترها

{
    "base64_image": "JSON String"
}

خروجی وب سرویس به صورت آرایه ای از اطلاعات یافت شده خواهد بود

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/ocr

{
    "base64_image": "base64_file_contents"
}

نتیجه درخواست


{
  "success": true,
  "result": array_of_finded_values
}

این متد از زبان فارسی پشتیبانی نمی کند

متد pocr

این متد به شما اجازی میدهد تصویری که با base64 کد شده است را جهت خواندن محتوای آن نظیر شماره تلفن و .. بررسی نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/pocr

پارامترها

{
    "base64_image": "JSON String"
}

خروجی وب سرویس به صورت آرایه ای از اطلاعات یافت شده خواهد بود

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/pocr

{
    "base64_image": "base64_file_contents"
}

نتیجه درخواست


{
  "success": true,
  "result": array_of_finded_values
}

نکته: این متد از زبان فارسی پشتیبانی می کند و فایل ارسالی باید به فرمت jpg باشد

این متد با وب سرویس ocr.space کار میکند. می توانید از طریق ویرایش تنظیمات وب سرویس کلید api شخصی خود را به صورت رایگان دریافت و استفاده نمایید تا محدودیتی در استفاده پیش نیاید

متد changepwd

این متد برای تغییر رمز ورود به سیستم کاربران سی آر ام استفاده می شود

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/changepwd

پارامترها

{
    "oldpassword": "String",
    "newpassword": "String",
    "record": "String"
}

پارامتر oldpassword ، newpassword و record به ترتیب برای پسورد جدید، پسورد قدیمی و شماره رکورد کاربری که می خواهید پسورد آن را عوض کنید استفاده می شود

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/changepwd

{
    "oldpassword": "123456789",
    "newpassword": "987654321",
    "record": "19x5"
}

نتیجه درخواست


{
  "success": true,
  "result": Changed password successfully
}

پارامتر record در صورتی که مدیر سیستم بخواهد گدرواژه شخص دیگری را تغییر دهد استفاده می شود و در صورت خالی بودن گذرواژه کاربر فعلی وب سرویس تغییر خواهد کرد

متد authenticate

از این متد میتوانید در احراز هویت نام کاربری و گذرواژه کاربران سی آر ام استفاده نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/authenticate

پارامترها

{
    "username": "String",
    "password": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/authenticate

{
    "username": "johndue",
    "password": "demo"
}

نتیجه درخواست


{
  "success": true,
  "result": array_of_authenticated_user_info
}

خروجی در صورت ورود صحیح اطلاعات پروفایل کاربر خواهد بود

متد newticketofmine

این متد لیست تیکت های جدید برای کاربر فعلی وب سرویس را نمایش می دهد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/newticketofmine

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/newticketofmine

نتیجه درخواست


{
  "success": true,
  "result": array_of_matching_records
}

از این متد میتوانید در طراحی اپلیکیشن های موبایل استفاده کنید.

متد pendingticketsofmine

این متد لیست تیکت های بسته نشده کاربر وب سرویس را نمایش میدهد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/pendingticketsofmine

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/pendingticketsofmine

نتیجه درخواست


{
  "success": true,
  "result": array_of_matching_records
}

از این متد میتوانید در طراحی اپلیکیشن های موبایل استفاده کنید.

متد potentialsduein5days

این متد لیست فرصت های فروشی که طی 5 روز دیگر “تاریخ مورد انتظار بسته شدن” آنها سررسید میشود را نمایش میدهد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/potentialsduein5days

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/potentialsduein5days

نتیجه درخواست


{
  "success": true,
  "result": array_of_matching_records
}

از این متد میتوانید در طراحی اپلیکیشن های موبایل استفاده کنید.

متد projectofmine

این متد لیست پروژه های کاربر وب سرویس را نمایش می دهد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/projectofmine

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/projectofmine

نتیجه درخواست


{
  "success": true,
  "result": array_of_matching_records
}

از این متد میتوانید در طراحی اپلیکیشن های موبایل استفاده کنید.

متد projecttasksofmine

این متد لیست وظایف پروژه کاربر وب سرویس را نمایش میدهد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/projecttasksofmine

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/projecttasksofmine

نتیجه درخواست


{
  "success": true,
  "result": array_of_matching_records
}

از این متد میتوانید در طراحی اپلیکیشن های موبایل استفاده کنید.

متد eventsofminetoday

این متد لیست رویدادهای امروز کاربر وب سرویس را نمایش میدهد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/eventsofminetoday

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/eventsofminetoday

نتیجه درخواست


{
  "success": true,
  "result": array_of_matching_records
}

از این متد میتوانید در طراحی اپلیکیشن های موبایل استفاده کنید.

متد idleticketsofmine

این متد لیست تیکت هایی که بیش از یک روز است در سیستم ثبت شده اند و کاربر وب سرویس به آنها پاسخ نداده است را نمایش میدهد.

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/idleticketsofmine

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/idleticketsofmine

نتیجه درخواست


{
  "success": true,
  "result": array_of_matching_records
}

از این متد میتوانید در طراحی اپلیکیشن های موبایل استفاده کنید.

متد todayevents

این متد به شما اجازه میدهد لیست رویدادهای امروز و آینده شامل امروز را مشاهده کنید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/todayevents?mode=Boolean

پارامترها

{
    "mode": "Boolean"
}

در صورتی که مقدار mode 0 وارد شود رویدادهای امروز و در صورتی که 1 وارد کنید رویدادهای آینده را مشاهده خواهید کرد

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/todayevents?mode=1

نتیجه درخواست


{
  "success": true,
  "result": array_of_matching_records
}

از این متد میتوانید در طراحی اپلیکیشن های موبایل استفاده کنید.

متد todaytasks

این متد به شما اجازه میدهد لیست وظایف امروز و آینده شامل امروز را مشاهده کنید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/todaytasks?mode=Boolean

پارامترها

{
    "mode": "Boolean"
}

در صورتی که مقدار mode 0 وارد شود وظایف امروز و در صورتی که 1 وارد کنید وظایف آینده را مشاهده خواهید کرد

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/todaytasks?mode=0

نتیجه درخواست


{
  "success": true,
  "result": array_of_matching_records
}

از این متد میتوانید در طراحی اپلیکیشن های موبایل استفاده کنید.

متد recentnotifications

در صورتی که ماژول اطلاعیه فعال باشد این متد کلیه اطلاعیه های مرتبط با کاربر که تایید و مشاهده نشده است را نمایش خواهد داد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/recentnotifications

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/recentnotifications

نتیجه درخواست


{
  "success": true,
  "result": array_of_matching_records
}

از این متد میتوانید در طراحی اپلیکیشن های موبایل استفاده کنید.

متد getalldashboards

این متد مقدار 3 تابع todayevents، todaytasks و recentnotifications را در قالب یک خروجی نمایش میدهد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/getalldashboards

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/getalldashboards

نتیجه درخواست


{
  "success": true,
  "result": array_of_matching_records
}

از این متد میتوانید در طراحی اپلیکیشن های موبایل استفاده کنید.

متد getwidgetdata

این متد برای دریافت اطلاعات ویجت های داشبورد و ساخت داشبورد در خارج از نرم افزار اطلاعات لازم را در اختیار شما می گذارد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/getwidgetdata?widget=String

پارامترها

{
    "widget": "String"
}

پارامتر widget می تواند با مقادیر زیر مقداردهی شود

GroupedBySalesStage برای نمایش فرصت های فروش بر اساس مرحله

GroupedBySalesPerson برای نمایش فرصت های فروش بر اساس ارجاع به

LeadsByStatus برای نمایش سرنخ ها بر اساس وضعیت

LeadsBySource برای نمایش سرنخ ها براساس منبع

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/getwidgetdata?widget=GroupedBySalesStage

نتیجه درخواست


{
  "success": true,
  "result": array_of_matching_records
}

از این متد میتوانید در طراحی اپلیکیشن های موبایل استفاده کنید.

متد getcalendarinfo

این متد برای نمایش نمایه تقویم و لیست رویدادهای روزانه به تفکیک تاریخ کاربرد دارد

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/getcalendarinfo?date=String&day=Boolean

پارامترها

{
    "date": "String",
    "day": "Boolean"
}

پارامتر date تاریخ شروع نمایه براساس تاریخ میلادی و پارامتر day تعداد روزهای درخواستی حداکثر تا 31 روز را مشخص می کند

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/getcalendarinfo?date=2020-06-27&day=1

نتیجه درخواست


{
  "success": true,
  "result": array_of_matching_records
}

از این متد میتوانید در طراحی اپلیکیشن های موبایل استفاده کنید.

متد tags_add

با استفاده از این متد می تواند برای رکورد های مورد نظر خط تگ اضافه نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/tags_add

پارامترها

{
    "id": "String",
    "tags": "JSON String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/tags_add

{
    "id": "12x2768",
    "tags": "[ 
   "Tag 1",
   "\u062a\u06af 2"
]"
}

نتیجه درخواست


{
  "success": true,
  "result": {
        message: "tags added"
    }
}

متد tags_retrieve

با استفاده از این متد قادر خواهید بود تگ های افزوده شده برای یک رکورد را مشاهده نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: GET

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

GET endpoint/extended/tags_retrieve?id=String

پارامترها

{
    "id": "String"
}

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/tags_retrieve?id=12x2768

نتیجه درخواست


{
  "success": true,
  "result": {
        tags: tag_name_array
    }
}

متد tag_delete

با استفاده از این متد میتوانید تگ یا تگ های افزوده شده بر روی یک رکورد را حذف نمایید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/tag_delete

پارامترها

{
    "id": "String",
    "tags": "JSON String",
    "delete_all": "String"
}

پارامتر delete_all همه تگ های رکورد را حذف خواهد کرد

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/tag_delete

{
    "id": "12x2768",
    "tags": "[ 
   "Tag1"
]"
}

نتیجه درخواست


{
  "success": true,
  "result": {
        message: "tags deleted"
    }
}

متد followrecord

با استفاده از این متد میتوانید در ویتایگر 7.1.0 به بالا یک رکورد را دنبال/عدم دنبال کنید

⚠️ نوع متد وب سرویس: سفارشی پارس ویتایگر

📌 متد ارسال درخواست: POST

💡 سرآیند: application/x-www-form-urlencoded

آدرس درخواست

POST endpoint/extended/followrecord

پارامترها

{
    "record": "String",
    "type": "Boolean"
}

مقدار type در صورت 1 بودن رکورد هدف را برای کاربر وب سرویس دنبال میکند و در صورت 0 بودن آن را دنبال نمی کند

مثال

http://Your-CRM-URL/modules/ParsVT/ws/API/V2/vtiger/extended/followrecord

{
    "id": "12x2768",
    "type": "0"
}

نتیجه درخواست


{
  "success": true,
  "result": boolean_value
}

منابع

ماژول ها

لیست ماژول های ویتایگر که توسط این وب سرویس پشتیبانی می شوند. همچنین، شما می توانید با استفاده از متد “listtypes” به لیست ماژول های استاندارد و سفارشی دسترسی داشته باشید.

Module Name Module Label Module WS ID Is Entity
Campaigns کمپین های تبلیغاتی 1 1
Vendors تامین کنندگان 2 1
Faq سوالات متداول 3 1
Quotes پیش فاکتورها 4 1
PurchaseOrder سفارشات خرید 5 1
SalesOrder سفارش های فروش 6 1
Invoice فاکتورها 7 1
PriceBooks دفترچه های قیمت 8 1
Calendar تقویم 9 1
Leads سرنخ های فروش 10 1
Accounts سازمان ها 11 1
Contacts مخاطبین 12 1
Potentials فرصت های فروش 13 1
Products محصولات 14 1
Documents اسناد 15 1
Emails ایمیل ها 16 1
HelpDesk تیکت ها 17 1
Events رویدادها 18 1
Users کاربران 19 1
ServiceContracts قراردادهای خدمات 24 1
Services سرویس ها 25 1
PBXManager مراکز تلفن ویپ 26 1
ModComments یادداشت ها 27 1
SMSNotifier سامانه ارسال پیام کوتاه 28 1
Assets پرونده کالاها 29 1
ProjectMilestone فاز پروژه 30 1
ProjectTask وظیفه پروژه 31 1
Project پروژه ها 32 1
Parsindicator دفتر اندیکاتور 36 1
Requirements نیازمندی های مشتری 41 1
ReceivedSMS پیامک های دریافتی 47 1
ModuleLinkCreator ماژول ساز سفارشی ویتایگر 48 1
Ideas ایده ها 50 1
BugTracking گزارش باگ 52 1
PWDManager گذرواژه ها 53 1
OfficeMinutes صورتجلسات اداری 54 1
Jobs فرصت های شغلی 56 1
WishList ویش لیست 59 1
VideoMarketing ویدیو مارکتینگ 60 1
SocialMarketing بازاریابی شبکه های اجتماعی 61 1
ContentMarketing بازاریابی محتوا 62 1
MarketingDocuments اسناد دیجیتال مارکتینگ 63 1
Backlinks بک لینک ها 64 1
SEOArticles لیست محتوا 65 1
ExtendedModules ماژول های توسعه یافته 66 1
VtigerVendors ارائه دهندگان خدمات ویتایگر 67 1
Competitors رقبا 69 1
Customizations سفارشی سازی ها 70 1
Partnership نمایندگی فروش 71 1
Notifications اطلاعیه ها 72 1
Educationalfiles فایل های آموزشی 73 1
ordersdetail جزئیات سفارش 75 1
alertbyuser اطلاع رسانی کاربران 78 1
Translations ترجمه ها 84 1
Cashflow4You گردش مالی 85 1
KanbanView نمایه کانبان 86 1
Groups گروه ها 20 0
Currency واحد پول 21 0
DocumentFolders DocumentFolders 22 0
CompanyDetails CompanyDetails 23 0
LineItem LineItem 33 0
Tax مالیات 34 0
ProductTaxes ProductTaxes 35 0

محدودیت ها

  • متد Sync روی ماژول کاربران و ماژول هایی که Entity نیستند نظیر واحد پولی، گروه ها و … عمل نمی کند
  • متد Query روی ماژول هایی که Entity نیستند قابل استفاده نمی باشد
  • فیلد های سفارشی نظیر کدملی، کد پستی و … در وب سرویس اعتبار سنجی نمی شوند
  • متدهایی که در بخش مدیریت سیستم استفاده می شوند نظیر اجرای گردش کار و … نیاز به احراز هویت با کاربری با دسترسی مدیر دارند