به بخش توسعه‌دهندگان نوین هاب خوش آمدید
این مستندات جهت آسانی استفاده شما از قابلیت‌ها و امکانات نوین هاب و همچنین توسعه و کامل کردن محصولات خود با استفاده از بسترهای ایجاد شده توسط نوین هاب، جمع آوری شده‌اند.
در صورت بروز هر گونه سوال با تیم فنی نوین هاب در بخش تیکت‌های پشتیبانی تماس بگیرید تا همکاران فنی در سریع‌ترین زمان به سئوالات شما پاسخ دهند.
برای اطلاع از آخرین تغییرات وب‌سرویس نوین‌هاب، کانال تلگرام توسعه دهنگان نوین‌هاب به آدرس https://t.me/novinhubdevelopers را دنبال کنید.
تغییرات جدید
در بروزرسانی جدید نوین‌هاب سعی کرده ایم تغییرات جدید پنل کاربری را در وب سرویس اضافه کنیم.
اضافه شدن شرط فالو و لایک پیام‌ها در دایرکت هوشمند
در بروزرسانی جدید مستندات قابلیت شرط فالو و لایک پیام های دایرکت اضافه شده اند.اضافه شدن دایرکت هوشمند
در بروزرسانی جدید مستندات مدیریت پیام های آماده،منو ها،سوالات متداول،محصولات و خدمات،پاسخ خودکار و فرم‌ساز به وب سرویس اضافه شده اند.تصویر کاور ویدیوی آپارات
می‌توانید برای ویدیوهای آپارات به صورت دستی کاور آپلود کنید.انتشار استوری اینستاگرام
می‌توانید استوری اینستاگرام را از طریق وب‌سرویس نوین‌هاب منتشر و زمانبندی کنید.اضافه کردن کاور ویدیو های ریلز اینستاگرام
می‌توانید تصویر کاور را جداگانه آپلود کرده و شناسه تصویر آپلود شده را در قسمت انتشار محتوا استفاده کنید.انتشار آلبوم در لینکدین و پینترست
از طریق وب‌سرویس نوین‌هاب در لینکدین و پینترست هم آلبوم(گالری) منتشر کنید.تگ کردن افراد در پست های تصویر اینستاگرام
می‌توانید حداکثر تا ۳۰ نفر را بر روی تصاویر اینستاگرام تگ کنید.تگ کردن در ویدیو ریلز اینستاگرام
می‌توانید بر روی ویدیوهای ریلز اینستاگرام تگ اضافه کنید.انتشار ویدیو در پینترست
از طریق وب‌سرویس نوین‌هاب در پینترست هم ویدیو منتشر کنید.تغییر نام صدای ریلز اینستاگرام
عنوان صدای ویدیوی ریلز اینستاگرام را در زمان انتشار تغییر دهید.کامنت اول پست‌های اینستاگرام
در زمان ثبت پست اینستاگرام کامنت اول پست را تعریف و منتشر کنید.شروع به کار
لطفا پیش از شروع به کار این موارد را در نظر داشته باشید:
- وب سرویس نوین هاب به صورت
RESTنوشته شده است. - ورودی پارامترها به دو شکل Multipart form و Json می‌باشد.
- برای دریافت
Tokenبه بخش احراز هویت توکن مراجعه کنید. - در صورت نیاز به
OAuth2حتما در این صفحه فرم را کامل کنید تا با شما تماس بگیریم و هماهنگی‌های لازم را انجام دهیم. - در صورت بروز هر گونه سوال با تیم فنی نوین هاب در بخش تیکت‌های پشتیبانی تماس بگیرید تا همکاران فنی در سریع‌ترین زمان به سئوالات شما پاسخ دهند.
تمام وب سرویس های نوین هاب نیازمند بخش احراز هویت می باشد. لطفا قبل از استفاده ابتدا مراحل احراز هویت را انجام دهید.
مشخصات API
در هنگام استفاده از API نوین هاب باید نسخه مورد نظر خود را در لینک درخواست مشخص کنید. نسخه با پسوند v و
شماره آن در لینک ارسال می شود.
برای مثال در صورتی که قصد استفاده از نسخه 2 را دارید، مقدار v2 در لینک درخواست ارسال می شود.
لینک api بر اساس روش های احراز هویت به شرح زیر است
tokenدر صورت استفاده از توکن لینک درخواست به صورتhttps://api.novinhub.com/token/v{version}می باشد.در حال حاضر آخرین نسخهv2و لینک آن به صورتhttps://api.novinhub.com/token/v2می باشد.OAuthدر صورت استفاده از OAuth لینک درخواست به صورتhttps://api.novinhub.com/v{version}می باشد.در حال حاضر آخرین نسخهv2و لینک آن به صورتhttps://api.novinhub.com/v2می باشد.
Field expansion
برای راحتی و ادغام چند درخواست می‌توانید از قابلیت Field expansion استفاده کنید.
مقدار این فیل باید با نام with در درخواست ارسال شود. شما می‌توانید در درخواست چند فیلد را وارد نمایید.
این مقادیر باید با , از همدیگر جدا شود.
همچنین شما می‌توانید این مقدار را به صورت تو در تو استفاده کنید که در این صورت باید به فرمت
parent(child,...) ارسال شود.
برای مثال در قسمت Comment شما می توانید فیلد‌های عنوان شده در صفحه را استفاده نمایید.
در این مثال نمونه مقدار with به صورت with=account,socialUser,accountPost می باشد.
شما همچنین در در مثال بالا می‌توانید مقدار meta که یک Field expansion در بخش Account
می‌باشد را به صورت
with=account(meta),socialUser,accountPost ارسال کنید.
آپلود فایل
آپلود در وب سرویس‌هایی که نیازمند آپلود فایل می‌باشد باید به صورت multipart/form-data ارسال شود.
صفحه بندی
در صورتی که در یک وب سرویس خروجی تعداد زیادی باشد خروجی به صورت صفحه بندی ارسال میشود.
این خروجی به صورت شی Paginate می‌باشد که شامل 2 فیلد data حاوی
اطلاعات درخواستی و paging با مشصخات زیر می‌باشد.
totalتعداد کل آیتم‌هاpageشماره صفحه کنونیtotalPageتعداد کل صفحاتnextآدرس صفحه بعدیprevآدرس صفحه قبلی
شما می‌توانید شماره صفحه دلخواه خود را در درخواست مدنظر با ورودی page ارسال کنید. یا با کمک فیلد‌های
prev و next لینک صفحات بعدی و قبلی را محسابه کنید.
صفحه بندی با اشاره
در صورتی که در یک وب سرویس خروجی تعداد زیادی باشد خروجی به صورت صفحه بندی با اشاره ارسال میشود.
تفاوت اصلی این صفحه بندی عدم وجود شماره صفحه است. در این صفحه بندی بسته به نوع وب سرویس در درخواست مشخص میشود که داده‌ها از قبل و یا بعد چه داده‌ای ارسال شود.
این خروجی به صورت شی CursorPagination می‌باشد که شامل 2 فیلد
data حاوی
اطلاعات درخواستی و paging با مشصخات زیر می‌باشد.
totalتعداد کل آیتم‌هاafterآدرس صفحه بعدیbeforeآدرس صفحه قبلی
شما می‌توانید شماره صفحه دلخواه خود را در درخواست مدنظر با ورودی after و یا before ارسال
کنید. یا با کمک فیلد‌های
after و before لینک صفحات بعدی و قبلی را محاسبه کنید.
دقت کنید در درخواست‌هایی که شامل before می‌باشد ممکن است داده ها از تعداد مجاز بیشتر باشد.
داده‌ها از ابتدا ارسال میشود و مابقی داده ها به کمک فیلد after فابل دریافت هست. در این حالت هردو فیلد
after و before ارسال میشود.
خطاها
وب سرویس نوین هاب در درخواست‌های مختلف خطا به صورت آرایه با اندیس
error
ارسال میشود که فرمت آن به صورت
ErrorResponse می باشد.
trace_id را به همراه مشکل مورد نظر به پشتیبانی فنی نوین هاب ارسال نمایید.
همچنین در صورت بروز خطا مقدار http status به صورت جدول زیر ارسال میشود.
| شماره خطا | نوع | توضیحات |
|---|---|---|
| 400 | ValidationException | خطا در اعتبار سنجی درخواست |
| 401 | HttpException | access_token ارسالی منقضی شده است. |
| 403 | HttpException | عدم دسترسی به صفحه مورد نظر |
| 404 | HttpException | صفحه مورد نظر یافت نشد. |
| 429 | HttpException | محدودیت استفاده از api برای این دستگاه به پایان رسیده است. |
| 500 | HttpException | خطای داخلی سرور. |
احراز هویت
احراز هویت در نوین هاب به دو صورت توکن و OAuth2 است.
در حالت توکن به سادگی با مراجعه به پنل کاربری می‌توانید توکن خود را دریافت کنید.
در حالت OAuth2 لازم است که درخواست ارسال کنید و بعد از هماهنگی لازم آن را دریافت کنید.
برای دریافت OAuth2 لطفا این فرم را کامل کنید.
توکن
در صورتی که نیاز به احراز هویت از طریق توکن هستید در درخواست ها باید مقدار توکن را در Header به صورت
Bearer
ارسال کنید.
اگر شما یک اپلیکیشن و یا وب‌سایت شخصی دارید و قصد استفاده از سرویس‌های نوین هاب را برای خود دارید برای دریافت توکن، لطفا اینجا کلیک نمایید.
لینک درخواست ها با کمک توکن به صورت
https://api.novinhub.com/token/v2/account می باشد.
برای مثال برای دریافت اکانت ها لینک درخواستی به شکل زیر می‌باشد:
https://api.novinhub.com/token/v2/account
Header
| نام | نوع | توضیحات |
|---|---|---|
| Authorization | string | Bearer {token} |
OAuth
پروسه احراز هویت بر مبنای oAuth2 می باشد که برای استفاده از سرویس نوین هاب نیاز به
client_id و client_secret می باشید.
تعاریف زیر می تواند به درک بهتر مفاهیم به شما کمک کند.
- کاربر : شخصی که در سایت نوین هاب اکانت دارد.
- سرویس : وب سایت یا اپلیکیشینی که قصد استفاده از api نوین هاب را دارد.
- Client id : شناسه سرویس استفاده کننده هست که در هنگام ایجاد سرویس در نوین هاب ساخته میشود.
- Client secret : یک کلید محرمانه می باشد کمه در هنگام ایجاد سرویس در نوین هاب ساخته میشود.
- Access token : توکن دریافتی از انجام عملیات احراز هویت و تایید کاربر. در حال حاضر عمر این توکن یک ماه می باشد.
- Scope : دسترسی مورد نیاز سرویس در اکانت کاربر که با کاراکتر فاصله جدا می شود.
- Refresh token : توکن برای دریافت Access token جدید. در حال حاضر عمر این توکن 1 سال می باشد.
- Redirect uri : لینک بازگشت به سرویس مبدا (لینک می توانید به صورت url باشد یا به صورت deep link ارسال شود)
- Authorization code : کد دریافتی در هنگام بازگشت از لینک برای دریافت Access token
تمام درخواست ها باید به مسیر https:/api.novinhub.com/web/ ارسال شود. برای مثال برای ایجاد توکن کاربر را
به مسیر https:/api.novinhub.com/web/oauth/authorize هدایت کنید.
ارسال کاربر به نوین هاب
برای دریافت توکن جدید کاربر را به مسیر زیر هدایت کنید
آدرس وب سرویس
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
| client_id | اجباری | Client id |
| response_type | اجباری | مقادیر: code: در صورتی که client_secret دارید. token: در صورتی که سرویس شما در سمت کاربر پیاده شده است و امکان ذخیره سازی client_secret نیست. برای مثال سایت شما بر پایه javascript تحت مرورگر می باشد. دقت کنید در این روش refresh_token در خروجی ارسال نمی شود. |
| scope | اجباری | Scope |
| state | اجباری | توکن csrf که توسط سرویس ایجاد می شود. |
| redirect_uri | اختیاری | لینک بازگشت، در صورت وارد نشدن مقدار پیشفرض قرار میگیرد.لینک باید شامل مقدار پیشفرض باشد. |
بعد از انجام احراز هویت و تایید دسترسی ها توسط کاربر کاربر به لینک redirect_url ارسال شده ارسال می گردد. و مقادیر زیر به صورت get ارسال میگردند.
در صورتی که مقدار response_type برابر با code باشد.
| نام | نوع | توضیحات |
|---|---|---|
| code | اختیاری | مقدار authorization_code که در درخواست بعدی استفاده می شود. عمر این کد 30 ثانیه می باشد. |
| state | اختیاری | توکن csrf ارسالی از سرویس |
در صورتی که مقدار response_type برابر با token باشد.
| نام | نوع | توضیحات |
|---|---|---|
| state | اختیاری | توکن csrf ارسالی از سرویس |
| access_token | اختیاری | توکن اتصال به وب سرویس |
| expires_in | اختیاری | اعتبار توکن به ثانیه |
| token_type | اختیاری | مقدار ثابت: access_token |
| scope | اختیاری | لیست دسترسی ها |
دریافت Access token
در صورتی که مقدار response_type در هنگام هدایت کاربر به نوین هاب را code قرار دهید نیاز دارید تا کد دریافتی در لینک بازگشت را به مسیر زیر برای دریافت access_token ارسال کنید.
آدرس وب سرویس
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
| client_id | اجباری | Client id |
| client_secret | اجباری | Client secret |
| grant_type | اجباری | مقدار ثابت: authorization_code |
| code | اجباری | کد دریافتی در لینک بازگشت |
| redirect_uri | اجباری | لینک بازگشت، در صورت وارد نشدن در درخواست اولیه مقدار پیشفرض باید ارسال شود. |
خروجی درخواست:
| نام | نوع | توضیحات |
|---|---|---|
| access_token | - | Client id |
| expires_in | - | Client secret |
| token_type | - | مقدار ثابت: authorization_code |
| scope | - | کد دریافتی در لینک بازگشت |
| refresh_token | - | لینک بازگشت، در صورت وارد نشدن در درخواست اولیه مقدار پیشفرض باید ارسال شود. |
| refresh_token_expires | - | لینک بازگشت، در صورت وارد نشدن در درخواست اولیه مقدار پیشفرض باید ارسال شود. |
دریافت توکن جدید با کمک Refresh token
در صورتی که access token منقضی شده باشد یا نیاز به توکن جدید دارید با ارسال ورودی ها به لینک زیر توکن جدید دریافت کنید.
آدرس وب سرویس
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
| client_id | اجباری | Client id |
| client_secret | اجباری | Client secret |
| grant_type | اجباری | مقدار ثابت: refresh_token |
| refresh_token | اجباری | مقدار Refresh token |
خروجی درخواست:
| نام | نوع | توضیحات |
|---|---|---|
| access_token | - | توکن اتصال به وب سرویس |
| expires_in | - | اعتبار توکن به ثانیه |
| token_type | - | مقدار ثابت: access_token |
| scope | - | لیست دسترسی ها |
درخواست جدید با کمک توکن دریافتی
بعد از دریافت access token می توانید از وب سرویس نوین هاب که مستندات آن در لینک https://novinhub.com/developers می باشد استفاده کنید. در درخواست های ارسالی مقدار توکن را با نام access_token در لینک درخواست به صورت query params ارسال کنید.
لینک وب سرویس :
برای مثال
https://api.novinhub.com/v2/account?access_token={token}
لیست scope های موجود :
- basic
- mobile
- offline_access
- implicit_approve
- account
- post
- publish
- insights
- comment
- inbox
پروسه احراز هویت بر مبنای oAuth2 می باشد که برای استفاده از سرویس نوین هاب نیاز به
client_id و client_secret می باشید.
تعاریف زیر می تواند به درک بهتر مفاهیم به شما کمک کند.
- کاربر : شخصی که در سایت نوین هاب اکانت دارد.
- سرویس : وب سایت یا اپلیکیشینی که قصد استفاده از api نوین هاب را دارد.
- Client id : شناسه سرویس استفاده کننده هست که در هنگام ایجاد سرویس در نوین هاب ساخته میشود.
- Client secret : یک کلید محرمانه می باشد کمه در هنگام ایجاد سرویس در نوین هاب ساخته میشود.
- Access token : توکن دریافتی از انجام عملیات احراز هویت و تایید کاربر. در حال حاضر عمر این توکن یک ماه می باشد.
- Scope : دسترسی مورد نیاز سرویس در اکانت کاربر که با کاراکتر فاصله جدا می شود.
- Refresh token : توکن برای دریافت Access token جدید. در حال حاضر عمر این توکن 1 سال می باشد.
- Redirect uri : لینک بازگشت به سرویس مبدا (لینک می توانید به صورت url باشد یا به صورت deep link ارسال شود)
- Authorization code : کد دریافتی در هنگام بازگشت از لینک برای دریافت Access token
تمام درخواست ها باید به مسیر https:/api.novinhub.com/web/ ارسال شود. برای مثال برای ایجاد توکن کاربر را
به مسیر https:/api.novinhub.com/web/oauth/authorize هدایت کنید.
ارسال کاربر به نوین هاب
برای دریافت توکن جدید کاربر را به مسیر زیر هدایت کنید
آدرس وب سرویس
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
| client_id | اجباری | Client id |
| response_type | اجباری | مقادیر: code: در صورتی که client_secret دارید. token: در صورتی که سرویس شما در سمت کاربر پیاده شده است و امکان ذخیره سازی client_secret نیست. برای مثال سایت شما بر پایه javascript تحت مرورگر می باشد. دقت کنید در این روش refresh_token در خروجی ارسال نمی شود. |
| scope | اجباری | Scope |
| state | اجباری | توکن csrf که توسط سرویس ایجاد می شود. |
| redirect_uri | اختیاری | لینک بازگشت، در صورت وارد نشدن مقدار پیشفرض قرار میگیرد.لینک باید شامل مقدار پیشفرض باشد. |
بعد از انجام احراز هویت و تایید دسترسی ها توسط کاربر کاربر به لینک redirect_url ارسال شده ارسال می گردد. و مقادیر زیر به صورت get ارسال میگردند.
در صورتی که مقدار response_type برابر با code باشد.
| نام | نوع | توضیحات |
|---|---|---|
| code | اختیاری | مقدار authorization_code که در درخواست بعدی استفاده می شود. عمر این کد 30 ثانیه می باشد. |
| state | اختیاری | توکن csrf ارسالی از سرویس |
در صورتی که مقدار response_type برابر با token باشد.
| نام | نوع | توضیحات |
|---|---|---|
| state | اختیاری | توکن csrf ارسالی از سرویس |
| access_token | اختیاری | توکن اتصال به وب سرویس |
| expires_in | اختیاری | اعتبار توکن به ثانیه |
| token_type | اختیاری | مقدار ثابت: access_token |
| scope | اختیاری | لیست دسترسی ها |
دریافت Access token
در صورتی که مقدار response_type در هنگام هدایت کاربر به نوین هاب را code قرار دهید نیاز دارید تا کد دریافتی در لینک بازگشت را به مسیر زیر برای دریافت access_token ارسال کنید.
آدرس وب سرویس
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
| client_id | اجباری | Client id |
| client_secret | اجباری | Client secret |
| grant_type | اجباری | مقدار ثابت: authorization_code |
| code | اجباری | کد دریافتی در لینک بازگشت |
| redirect_uri | اجباری | لینک بازگشت، در صورت وارد نشدن در درخواست اولیه مقدار پیشفرض باید ارسال شود. |
خروجی درخواست:
| نام | نوع | توضیحات |
|---|---|---|
| access_token | - | Client id |
| expires_in | - | Client secret |
| token_type | - | مقدار ثابت: authorization_code |
| scope | - | کد دریافتی در لینک بازگشت |
| refresh_token | - | لینک بازگشت، در صورت وارد نشدن در درخواست اولیه مقدار پیشفرض باید ارسال شود. |
| refresh_token_expires | - | لینک بازگشت، در صورت وارد نشدن در درخواست اولیه مقدار پیشفرض باید ارسال شود. |
دریافت توکن جدید با کمک Refresh token
در صورتی که access token منقضی شده باشد یا نیاز به توکن جدید دارید با ارسال ورودی ها به لینک زیر توکن جدید دریافت کنید.
آدرس وب سرویس
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
| client_id | اجباری | Client id |
| client_secret | اجباری | Client secret |
| grant_type | اجباری | مقدار ثابت: refresh_token |
| refresh_token | اجباری | مقدار Refresh token |
خروجی درخواست:
| نام | نوع | توضیحات |
|---|---|---|
| access_token | - | توکن اتصال به وب سرویس |
| expires_in | - | اعتبار توکن به ثانیه |
| token_type | - | مقدار ثابت: access_token |
| scope | - | لیست دسترسی ها |
درخواست جدید با کمک توکن دریافتی
بعد از دریافت access token می توانید از وب سرویس نوین هاب که مستندات آن در لینک https://novinhub.com/developers می باشد استفاده کنید. در درخواست های ارسالی مقدار توکن را با نام access_token در لینک درخواست به صورت query params ارسال کنید.
لینک وب سرویس :
برای مثال
https://api.novinhub.com/v2/account?access_token={token}
درخواست OAuth
در نوین هاب دو نوع توکن در API قرار داده شده است که توکن کاربر همواره در بخش تنظیمات پروفایل در دسترس شما قرار دارد.
برای توکن OAuth نیاز به هماهنگی با شما داریم و به همین منظور لطفا فرم زیر را برای ما کامل کنید تا در سریع‌ترین زمان با شما تماس بگیریم.
webhook
وب هوک یکی از روش‌هایی است که به وسیله آن، وب‌اپلیکیشن‌ها می‌توانند با هم در ارتباط باشند. با استفاده از وب هوک می‌توان از APIهای شخص ثالث در پروژه توسعه اپلیکیشن استفاده کرد. وب هوک این امکان را فراهم می‌کند که هر گاه یک رویداد (Event) اتفاق افتاد، داده‌های آنی (Real-Time) از یک اپلیکیشن به اپلیکیشن دیگر ارسال شوند.
در صورتی که نیاز به دریافت event در هنگام تغییرات در نوین هاب را دارید می توانید از webhook استفاده کنید.
داده های ارسالی با فرمت json به لینک webhook_url که هنگام ثبت client_id، ثبت شده است، ارسال می گردد.
دریافت تغییرات
برای دریافت تغییرات از طریق وب هوک حتما باید Refresh token معتبر به همراه دسترسی offline_access وجود داشته باشد.
ساختار مقدار ارسالی به شکل زیر می باشد:
{
‘type’ => ‘نوع تغییر رخ داده’,
‘user_id’ => ‘شناسه کاربر’,
‘payload’ => ‘محتوی تغییر’
}
- نوع message_created هنگامی رخ می دهد که پیغام جدید (دایرکت) در اکانت کاربر ثبت شود.
- نوع comment_created هنگامی رخ می دهد که کامنت جدید در اکانت کاربر ثبت شود
مقدار payload:
https://novinhub.com/developers#reference-Message
https://novinhub.com/developers#reference-Comment
اکانت‌ها
با کمک این سرویس می‌توانید اکانت‌های شبکه‌های اجتماعی مختلف را مدیریت نمایید.
لیست اکانت‌ها
با کمک این سرویس می‌توانید لیست تمام اکانت‌های کاربر مورد نظر را دریافت کنید.
آدرس وب سرویس
پارامتر ها
بدون ورودی
خروجی
آرایه از Account در خروجی ارسال میشود.
همچنین شما می‌توانید به کمک Field expansion با ارسال پارامتر with با
مقدار meta بر اساس شبکه‌های اجتماعی مقادیر زیر را دریافت کنید.
تلگرام
| نام | نوع | توضیحات |
|---|---|---|
| botusername | string | نام کاربری ربات سفارشی |
| botapikey | string | کلید api ربات اختصاصی |
ایجاد اکانت
با کمک این سرویس می‌توانید اکانت جدید اضافه کنید.
آدرس وب سرویس
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
| type | String | نوع شبکه اجتماعی اکانت |
| redirect | String | لینک بازگشت در صورتی که کاربر به شبکه اجتماعی هدایت شود |
همچنین برای شبکه‌های اجتماعی در لیست زیر ورودی‌های جداگانه نیاز است که در هر بخش ذکر شده است.
پارامترهای Aparat
| نام | نوع | توضیحات |
|---|---|---|
| username | string | نام کاربری شبکه |
| password | string | کلمه عبور شبکه |
پارامترهای Bale
| نام | نوع | توضیحات |
|---|---|---|
| username | string | نام کانال شبکه |
| botusername | string | (اختیاری) نام کاربری ربات سفارشی |
| botapikey | string | (اختیاری) کلید api ربات سفارشی |
پارامترهای Eitaa
| نام | نوع | توضیحات |
|---|---|---|
| username | string | نام کانال شبکه |
| token | string | توکن کانال شبکه |
پارامترهای Gap
| نام | نوع | توضیحات |
|---|---|---|
| username | string | نام کانال شبکه |
| botusername | string | (اختیاری) نام کاربری ربات سفارشی |
| botapikey | string | (اختیاری) کلید api ربات سفارشی |
پارامترهای Soroush
| نام | نوع | توضیحات |
|---|---|---|
| username | string | نام کانال شبکه |
| botapikey | string | (اختیاری) کلید api ربات سفارشی |
پارامترهای Telegram
| نام | نوع | توضیحات |
|---|---|---|
| username | string | نام کانال شبکه |
| botusername | string | (اختیاری) نام کاربری ربات سفارشی |
| botapikey | string | (اختیاری) کلید api ربات سفارشی |
خروجی
شی Account ایجاد شده در خروجی ارسال میشود
و یا در صورتی که نیاز باشد کاربر به شبکه اجتماعی برای گرفتن دسترسی هدایت شود شی RedirectResponse در خروجی ارسال میشود.
مشخصات اکانت
با کمک این سرویس می‌توانید مشخصات اکانت با شناسه accountId را دریافت کنید.
آدرس وب سرویس
:accountIdپارامترها
بدون ورودی
خروجی
شی Account در خروجی ارسال میشود.
ویرایش اکانت
با کمک این سرویس می‌توانید اکانت با شناسه accountId را ویرایش کنید.
آدرس وب سرویس
:accountIdپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| type | String | نوع شبکه اجتماعی اکانت |
| redirect | String | لینک بازگشت در صورتی که کاربر به شبکه اجتماعی هدایت شود |
همچنین برای شبکه‌های اجتماعی در این لیست ورودی‌های جداگانه نیاز است که در هر بخش ذکر شده است.
خروجی
شی Account ایجاد شده در خروجی ارسال میشود
و یا در صورتی که نیاز باشد کاربر به شبکه اجتماعی برای گرفتن دسترسی هدایت شود شی RedirectResponse در خروجی ارسال میشود.
حذف اکانت
با کمک این سرویس می‌توانید اکانت با شناسه accountId را حذف کنید.
آدرس وب سرویس
:accountIdپارامتر ها
بدون ورودی
خروجی
شی BooleanResponse در خروجی ارسال میشود.
گروه اکانت‌ها
با کمک این سرویس می‌توانید اکانت‌های شبکه‌های اجتماعی خود را گروه بندی کنید و آنها را در گروه‌های مختلفی قرار دهید. این گروه بندی برای انتخاب سریعتر در زمان انتشار محتوا کاربرد دارد.
لیست گروه اکانت‌ها
با کمک این سرویس می‌توانید لیست تمام گروه‌های اکانت کاربر مورد نظر را دریافت کنید.
آدرس وب سرویس
پارامتر ها
بدون ورودی
خروجی
آرایه از AccountGroup در خروجی ارسال میشود.
ایجاد گروه اکانت
با کمک این سرویس می‌توانید گروه اکانت جدید اضافه کنید.
آدرس وب سرویس
پارامتر ها
| نام | نوع | توضیحات |
|---|---|---|
| name | String | عنوان گروه |
| account_ids | Integer[] | شناسه اکانت‌ها |
خروجی
شی AccountGroup ایجاد شده در خروجی ارسال می شود.
مشخصات گروه اکانت
با کمک این سرویس می‌توانید مشصخات گروه اکانت با شناسه accountGroupId را دریافت کنید.
آدرس وب سرویس
:accountGroupIdپارامتر ها
بدون ورودی
خروجی
شی AccountGroup در خروجی ارسال میشود.
ویرایش گروه اکانت
با کمک این سرویس می‌توانید گروه اکانت با شناسه accountGroupId را ویرایش نمایید.
آدرس وب سرویس
:accountGroupIdپارامتر ها
| نام | نوع | توضیحات |
|---|---|---|
| name | String | عنوان گروه |
| account_ids | Integer[] | شناسه اکانت‌ها |
خروجی
شی AccountGroup ویرایش شده در خروجی ارسال میشود.
حذف گروه اکانت
با کمک این سرویس می‌توانید گروه اکانت با شناسه accountGroupId را حذف کنید.
آدرس وب سرویس
:accountGroupIdپارامتر ها
بدون ورودی
خروجی
شی BooleanResponse در خروجی ارسال میشود.
کپشن‌ها
با کمک این سرویس می‌توانید کپشن‌های آماده برای اکانت درج کنید و در هنگام ارسال پست از آنها استفاده نمایید.
لیست کپشن‌ها
با کمک این سرویس می‌توانید لیست تمام کپشن های کاربر مورد نظر را دریافت کنید.
آدرس وب سرویس
پارامترها
بدون ورودی
خروجی
آرایه از Caption در خروجی ارسال میشود.
ایجاد کپشن
با کمک این سرویس می‌توانید کپشن جدید اضافه کنید.
آدرس وب سرویس
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
| title | String | عنوان کپشن |
| caption | String | متن کپشن |
خروجی
شی Caption ایجاد شده در خروجی ارسال میشود.
مشخصات کپشن
با کمک این سرویس می‌توانید مشصخات کپشن با شناسه captionId را دریافت کنید.
آدرس وب سرویس
:captionIdپارامترها
بدون ورودی
خروجی
شی Caption در خروجی ارسال میشود.
ویرایش کپشن
با کمک این سرویس می‌توانید کپشن با شناسه captionId را ویرایش نمایید.
آدرس وب سرویس
:captionIdپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| title | String | عنوان کپشن |
| caption | String | متن کپشن |
خروجی
شی Caption ویرایش شده در خروجی ارسال میشود.
حذف کپشن
با کمک این سرویس می‌توانید کپشن با شناسه captionId را حذف کنید.
آدرس وب سرویس
:captionIdپارامترها
بدون ورودی
خروجی
شی BooleanResponse در خروجی ارسال میشود.
کامنت‌ها
با کمک این سرویس می‌توانید کامنت‌های دریافت شده در شبکه‌های اجتماعی را در یک داشبورد مدیریت کنید.
تمامی قابلیت‌های مشاهده، پاسخ و حذف در دسترس است و همچنین نوین هاب قابلیت‌های بیشتری نیز همچون ایجاد برچسب و دسته بندی، دریافت فایل خروجی و… را نیز در اختیار شما قرار می‌دهد.
لیست کامنت‌ها
با کمک این سرویس می‌توانید لیست کامنت‌های کاربر مورد نظر را دریافت کنید.
آدرس وب سرویس
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
| tag | Integer[] | (اختیاری) فیلتر شناسه تگ‌های کامنت |
| status | String | (اختیاری) فیلتر وضعیت کامنت |
| date_from | String | (اختیاری) فیلتر کامنت‌های بعد از تاریخ |
| date_to | String | (اختیاری) فیلتر کامنت‌های قبل از تاریخ |
| search | String | (اختیاری) جستجوی در متن کامنت |
دریافت کامنت ها بر اساس قبل و بعد تاریخ
برای فیلتر کامنت ها در بازه زمانی خاص می توانید با کمک فیلد های after و before فیلتر مورد نظر خودتان را اعمال کنید. برای مثال برای دریافت کامنت ها قبل از تاریخ 01-01-2022 مقدار after=2022-01-01 را به صورت GET ارسال کنید.
دقت کنید که خروجی این endpoint نزولی هست و after و before به معانی صفحه بعد و قبل می باشد، بنابراین اگر داده های قبل تاریخ مد نظر را میخواهید از فیلد after در غیر این صورت از فیلد before استفاده کنید. برای اطلاعات بیشتر به بخش صفحه‌بندی با اشاره مراجعه کنید
نمونه
خروجی
آرایه از Comment در فرمت CursorPagination در خروجی ارسال میشود.
برای اطلاعات بیشتر به بخش صفحه‌بندی با اشاره مراجعه کنید.
مشخصات کامنت
با کمک این سرویس می‌توانید مشخصات کامنت با شناسه commentId را دریافت کنید.
آدرس وب سرویس
:commentIdپارامترها
بدون ورودی
خروجی
شی Comment در خروجی ارسال میشود.
پاسخ‌های کامنت
با کمک این سرویس می‌توانید لیست پاسخ‌های کامنت با شناسه commentId را دریافت کنید.
آدرس وب سرویس
:commentId/repliesپارامترها
بدون ورودی
خروجی
آرایه از Comment در فرمت Pagination در خروجی ارسال میشود.
برای اطلاعات بیشتر به بخش صفحه‌بندی مراجعه کنید.
ارسال پاسخ به کامنت
با کمک این سرویس می‌توانید پاسخ جدید بر کامنت با شناسه commentId اضافه کنید.
آدرس وب سرویس
:commentId/replyپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| comment | String | متن کامنت |
| username | String | نام کاربری کامنت اصلی |
خروجی
شی Comment ایجاد شده در خروجی ارسال میشود.
لایک کامنت
با کمک این سرویس می‌توانید لایک به کامنت با شناسه commentId اضافه یا حذف کنید.
آدرس وب سرویس
:commentId/likeپارامترها
بدون ورودی
خروجی
شی BooleanResponse در خروجی ارسال میشود.
تغییر تگ کامنت
با کمک این سرویس می‌توانید تگ‌های کامنت با شناسه commentId را بروزرسانی کنید.
آدرس وب سرویس
:commentId/tagپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| tag | Integer[] | شناسه تگ کامنت |
خروجی
شی Comment ویرایش شده در خروجی ارسال میشود.
حذف کامنت
با کمک این سرویس می‌توانید کامنت با شناسه commentId را حذف کنید.
آدرس وب سرویس
:commentIdپارامترها
بدون ورودی
خروجی
شی BooleanResponse در خروجی ارسال میشود.
فعال سازی کامنت اکانت
با کمک این سرویس می‌توانیداکانت های مورد نظر را برای دریافت کامنت فعال نمایید.
آدرس وب سرویس
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
| account_ids | Integer[] | شناسه اکانت‌ها |
خروجی
شی BooleanResponse در خروجی ارسال میشود.
تگ کامنت‌ها
با کمک این سرویس می‌توانید تگ (برچسب) به کامنت‌ها اضافه کنید.
با استفاده از این قابلیت می‌توانید کامنت‌ها را دسته بندی کنید.
لیست تگ کامنت‌ها
با کمک این سرویس می‌توانید لیست تمام تگ های کامنت کاربر مورد نظر را دریافت کنید.
آدرس وب سرویس
پارامترها
بدون ورودی
خروجی
آرایه از CommentTag در خروجی ارسال میشود.
ایجاد تگ کامنت
با کمک این سرویس می‌توانید تگ کامنت جدید اضافه کنید.
آدرس وب سرویس
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
| name | String | نام تگ |
| color | String | کد HEX رنگ |
خروجی
شی CommentTag ایجاد شده در خروجی ارسال میشود.
مشخصات تگ کامنت
با کمک این سرویس می‌توانید مشخصات تگ کامنت با شناسه commentTagId را دریافت کنید.
آدرس وب سرویس
:commentTagIdپارامتر ها
بدون ورودی
خروجی
شی CommentTag در خروجی ارسال میشود.
ویرایش تگ کامنت
با کمک این سرویس می‌توانید تگ کامنت با شناسه commentTagId را ویرایش نمایید.
آدرس وب سرویس
:commentTagIdپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| name | String | نام تگ |
| color | String | کد HEX رنگ |
خروجی
شی CommentTag ویرایش شده در خروجی ارسال میشود.
حذف تگ کامنت
با کمک این سرویس می‌توانید تگ کامنت با شناسه commentTagId را حذف کنید.
آدرس وب سرویس
:commentTagIdپارامترها
بدون ورودی
خروجی
شی BooleanResponse در خروجی ارسال میشود.
مکالمه‌ها
با کمک سرویس مکالمه‌ها در نوین هاب می‌توانید تمامی پیام‌های دایرکت (پیام مستقیم) را در شبکه‌های اجتماعی خود از طریق نوین هاب مدیریت کنید.
امکان پاسخگویی، دسته‌بندی، مشاهده همزمان و … در نوین هاب برای مدیریت راحت‌تر و بهتر پیام‌ها فراهم شده است.
لیست مکالمه‌ها
با کمک این سرویس می‌توانید لیست مکالمه‌های کاربر مورد نظر را دریافت کنید.
آدرس وب سرویس
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
| tag | Integer[] | (اختیاری) فیلتر شناسه تگ‌های مکالمه |
| status | String | (اختیاری) فیلتر وضعیت مکالمه |
| search | String | (اختیاری) جستجوی در مکالمه |
دریافت مکالمه ها بر اساس قبل و بعد تاریخ
برای فیلتر مکالمه ها در بازه زمانی خاص می توانید با کمک فیلد های after و before فیلتر مورد نظر خودتان را اعمال کنید. برای مثال برای دریافت مکالمه ها قبل از تاریخ 01-01-2022 مقدار after=2022-01-01 را به صورت GET ارسال کنید.
دقت کنید که خروجی این endpoint نزولی هست و after و before به معانی صفحه بعد و قبل می باشد، بنابراین اگر داده های قبل تاریخ مد نظر را میخواهید از فیلد after در غیر این صورت از فیلد before استفاده کنید. برای اطلاعات بیشتر به بخش صفحه‌بندی با اشاره مراجعه کنید
نمونه
خروجی
آرایه از Conversation در فرمت CursorPagination در خروجی ارسال می شود.
برای اطلاعات بیشتر به بخش صفحه‌بندی با اشاره مراجعه کنید.
مشخصات مکالمه
با کمک این سرویس می‌توانید مشخصات مکالمه با شناسه conversationId را دریافت کنید.
آدرس وب سرویس
:conversationIdپارامترها
بدون ورودی
خروجی
شی Conversation در خروجی ارسال میشود.
لیست پیغام‌ها
با کمک این سرویس می‌توانید لیست تمام پیغام‌های مکالمه با شناسه conversationId کاربر مورد نظر را دریافت کنید.
آدرس وب سرویس
:conversationId/messagesپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| date_from | String | (اختیاری) فیلتر کامنت‌های بعد از تاریخ |
| date_to | String | (اختیاری) فیلتر کامنت‌های قبل از تاریخ |
خروجی
آرایه از Message در خروجی ارسال میشود.
مشخصات پیغام
با کمک این سرویس می‌توانید مشخصات پیغام با شناسه messageId را دریافت کنید.
آدرس وب سرویس
:messageIdپارامترها
بدون ورودی
خروجی
شی Message در خروجی ارسال میشود.
ارسال پاسخ به مکالمه
با کمک این سرویس می‌توانید پاسخ جدید بر مکالمه با شناسه conversationId اضافه کنید.
آدرس وب سرویس
:conversationId/replyپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| content | String | متن پیغام |
| attachment | File | (اختیاری) فایل ارسالی در پیغام |
برای اطلاعات بیشتر به بخش آپلود فایل مراجعه کنید.
خروجی
شی Message ایجاد شده در خروجی ارسال میشود.
اکشن روی پیغام
با کمک این سرویس می‌توانید اکشن به مکامله با شناسه conversationId اضافه یا حذف کنید.
آدرس وب سرویس
:messageId/reactionپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| type | String | نوع اکشن در حال حاضر فقط مقدار like پشتیبانی میشود. |
خروجی
شی BooleanResponse در خروجی ارسال میشود.
تغییر تگ مکالمه
با کمک این سرویس می‌توانید تگ‌های مکالمه با شناسه conversationId را بروزرسانی کنید.
آدرس وب سرویس
:conversationId/tagپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| tag | Integer[] | شناسه تگ مکالمه |
خروجی
شی Conversation ویرایش شده در خروجی ارسال میشود.
فعال سازی دایرکت اکانت
با کمک این سرویس می‌توانیداکانت‌های مورد نظر را برای دریافت مکالمه فعال نمایید.
آدرس وب سرویس
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
| account_ids | Integer[] | شناسه اکانت‌ها |
خروجی
شی BooleanResponse در خروجی ارسال میشود.
تگ مکالمه‌ها
با کمک این سرویس می‌توانید تگ (برچسب) به مکالکه‌ها اضافه کنید.
با این قابلیت می‌توانید مکالمه‌ها را به سادگی دسته بندی کنید.
لیست تگ مکالمه‌ها
با کمک این سرویس می‌توانید لیست تمام تگ‌های مکالمه کاربر مورد نظر را دریافت کنید.
آدرس وب سرویس
پارامترها
بدون ورودی
خروجی
آرایه از ConversationTag در خروجی ارسال میشود.
ایجاد تگ مکالمه
با کمک این سرویس می‌توانید تگ مکالمه جدید اضافه کنید.
آدرس وب سرویس
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
| name | String | نام تگ |
| color | String | کد HEX رنگ |
خروجی
شی ConversationTag ایجاد شده در خروجی ارسال میشود.
مشخصات تگ مکالمه
با کمک این سرویس می‌توانید مشخصات تگ مکالمه با شناسه conversationTagId را دریافت کنید.
آدرس وب سرویس
:conversationTagIdپارامترها
بدون ورودی
خروجی
شی ConversationTag در خروجی ارسال میشود.
ویرایش تگ مکالمه
با کمک این سرویس می‌توانید تگ مکالمه با شناسه conversationTagId را ویرایش نمایید.
آدرس وب سرویس
:conversationTagIdپارامترها
بدون ورودی
خروجی
شی ConversationTag ویرایش شده در خروجی ارسال میشود.
حذف تگ مکالمه
با کمک این سرویس می‌توانید تگ مکالمه با شناسه conversationTagId را حذف کنید.
آدرس وب سرویس
:conversationTagIdپارامترها
بدون ورودی
خروجی
شی BooleanResponse در خروجی ارسال میشود.
مدیریت فایل‌ها
با کمک این سرویس می‌توانید فایل جدید آپلود کنید و یا فایل‌های موجود را مدیریت نمایید برای مشاهده وضعیت فضای استفاده شده از me/files استفاده نمایید.
لیست فایل‌ها
با کمک این سرویس می‌توانید لیست تمام فایل‌های کاربر مورد نظر را دریافت کنید.
آدرس وب سرویس
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
| type | String | (اختیاری) فیلتر نوع غایل |
| search | String | (اختیاری) جستجوی در نام فایل |
خروجی
آرایه از File در فرمت Pagination در خروجی ارسال میشود.
برای اطلاعات بیشتر به بخش صفحه بندی مراجعه کنید.
آپلود فایل
با کمک این سرویس می‌توانید فایل جدید اضافه کنید.
آدرس وب سرویس
خروجی
شی File ایجاد شده در خروجی ارسال میشود.
مشخصات فایل
با کمک این سرویس می‌توانید مشخصات فایل با شناسه fileId را دریافت کنید.
آدرس وب سرویس
:fileIdپارامترها
بدون ورودی
خروجی
شی File در خروجی ارسال میشود.
حذف فایل
با کمک این سرویس می‌توانید فایل با شناسه fileId را حذف کنید.
آدرس وب سرویس
:fileIdپارامترها
بدون ورودی
خروجی
شی BooleanResponse در خروجی ارسال میشود.
دایرکت هوشمند
با استفاده از سرویس دایرکت هوشمند نوین‌هاب می‌توانید اتوماتیک و سریع به همه پیام‌های دایرکت با دستورات از پیش تعریف شده به صورت خودکار پاسخ دهید.
پیام‌ها
با استفاده از سرویس های زیر قادر به دریافت،ایجاد،ویرایش و حذف پیام ها در بخش دایرکت هوشمند خواهید بود.
آدرس وب سرویس دریافت پیام ها
accountId/messageپارامترها
بدون ورودی
خروجی
آرایه‌ای از AutomationMessage ایجاد شده در خروجی ها ارسال میشود.
آدرس وب سرویس ساخت پیام ها
accountId/messageپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| title | String | عنوان |
| type | String-یکی از مقادیر text-button-media-products | نوع پیام |
| text | String | متن |
| quick_replies | []QuickReplies | پاسخ سریع |
| buttons | []Buttons | دکمه |
| file_id | Integer-اختیاری | شناسه فایل |
| product_ids | Array-اختیاری-[PRODUCT_IDS] | شناسه محصولات و خدمات |
با توجه به مقدار type می‌بایست یکی از پارامترهای اختیاری را انتخاب کنید.
خروجی
شی AutomationMessage ایجاد شده در خروجی ارسال میشود.
آدرس وب سرویس ویرایش پیام ها
accountId/message/messageIdپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| title | String | عنوان |
| type | String-یکی از مقادیر text-button-media-products | نوع پیام |
| text | String | متن |
| quick_replies | []QuickReplies | پاسخ سریع |
| buttons | []Buttons | دکمه |
| file_id | Integer-اختیاری | شناسه فایل |
| product_ids | Array-اختیاری-[PRODUCT_IDS] | شناسه محصولات و خدمات |
با توجه به مقدار type می‌بایست یکی از پارامترهای اختیاری را انتخاب کنید.
خروجی
شی AutomationMessage ایجاد شده در خروجی ارسال میشود.
آدرس وب سرویس حذف پیام ها
accountId/message/messageIdپارامترها
بدون ورودی
خروجی
شی BooleanResponse ایجاد شده در خروجی ارسال میشود.
منوی ثابت
پس از تنظیم این بخش، یک منو به بالای گوشه سمت راست بخش گفتگوی دایرکت اضافه میشود که می‌توانید لینک‌ها و گزینه‌های اصلی را در این بخش قرار دهید.
آدرس وب سرویس دریافت منوها
accountId/menuپارامترها
بدون ورودی
خروجی
آرایه []AutomationMenu ایجاد شده در خروجی ارسال میشود.
آدرس وب سرویس ساخت منو
accountId/menuپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| menu | []Menu | دکمه‌ها |
خروجی
شی AutomationMenu ایجاد شده در خروجی ارسال میشود.
سوالات متداول
با استفاده از سرویس های زیر می‌توانید حداکثر چهار سوال پر تکرار را ایجاد کنید و مشاهده کنید.
آدرس وب سرویس دریافت سوالات متداول
accountId/questionپارامترها
بدون ورودی
خروجی
آرایه []AutomationQuestion ایجاد شده در خروجی ارسال میشود.
آدرس وب سرویس ساخت سوالات متداول
accountId/questionپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| question | []Question | سوالات |
خروجی
شی AutomationQuestion ایجاد شده در خروجی ارسال میشود.
محصولات و خدمات
از طریق این سرویس می‌توانید محصولات و خدمات خود را مدیریت کنید.
لیست محصولات و خدمات
با کمک این سرویس می‌توانید لیست تمام محصولات و خدمات را دریافت کنید.
آدرس وب سرویس
accountId/productپارامترها
بدون ورودی
خروجی
آرایه‌ای از []Product ایجاد شده در خروجی ها ارسال میشود.
مشخصات محصول و خدمت
با کمک این سرویس می‌توانید مشخصات فایل با شناسه fileId را دریافت کنید.
آدرس وب سرویس
accountId/product/productIdپارامترها
بدون ورودی
خروجی
شی از Product ایجاد شده در خروجی ها ارسال میشود.
ایجاد محصول و خدمت
آدرس وب سرویس ساخت محصولات و خدمات
accountId/productپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| title | String | عنوان |
| subtitle | String | توضیحات |
| file_id | integer | شناسه فایل عکس |
| url | String | لینک تصویر محصول |
| buttons | []Buttons | دکمه |
خروجی
شی Product ایجاد شده در خروجی ارسال میشود.
ویرایش محصول و خدمت
آدرس وب سرویس ویرایش محصولات و خدمات
accountId/product/productIdپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| title | String | عنوان |
| subtitle | String | توضیحات |
| file_id | integer | شناسه فایل عکس |
| url | String | لینک تصویر محصول |
| buttons | []Buttons | دکمه |
خروجی
شی Product ایجاد شده در خروجی ارسال میشود.
حذف محصول و خدمت
آدرس وب سرویس حذف محصولات و خدمات
accountId/product/productIdپارامترها
بدون ورودی
خروجی
شی BooleanResponse ایجاد شده در خروجی ارسال میشود.
پاسخ خودکار
با استفاده از سرویس های موجود در این قسمت می‌توانید ساز و کار پیام های خودکار را مدیریت کنید.
لیست پاسخ خودکار
آدرس وب سرویس دریافت لیست پاسخ خودکار
accountId/responseپارامترها
بدون ورودی
خروجی
آرایه‌ای از MessageResponse ایجاد شده در خروجی ها ارسال میشود.
مشخصات پاسخ خودکار
آدرس وب سرویس دریافت پاسخ خودکار
accountId/response/responseIdپارامترها
بدون ورودی
خروجی
شی از MessageResponse ایجاد شده در خروجی ها ارسال میشود.
خروجی پاسخ خودکار
آدرس وب سرویس خروجی پاسخ خودکار
accountId/response/responseId/exportپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| String | آدرس ایمیل |
خروجی
شی BooleanResponse ایجاد شده در خروجی ارسال میشود.
ایجاد پاسخ خودکار
آدرس وب سرویس ساخت پاسخ خودکار
accountId/responseپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| direct | 0|1 | با دریافت دایرکت پیام آماده ارسال شود |
| comment | 0|1 | با دریافت کامنت پیام آماده ارسال شود |
| condition | [{join:'OR'|'AND', type: 'EQUAL'|'INCLUDE', value:VALUE}] | شرایط و مقادیر کلمات کلیدی |
| message_ids | Array[MESSAGE_IDS] | شناسه پیام های مدنظر ارسال |
| user_should_follow_business_text | string | متن پیام برای گزینه شرط فالو |
| user_should_follow_business_button | string | متن دکمه شرط فالو |
| react_to_direct | 0|1 | لایک پیام‌های دریافتی |
خروجی
شی MessageResponse ایجاد شده در خروجی ارسال میشود.
ویرایش پاسخ خودکار
آدرس وب سرویس ویرایش پاسخ خودکار
accountId/response/responseIdپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| direct | 0|1 | با دریافت دایرکت پیام آماده ارسال شود |
| comment | 0|1 | با دریافت کامنت پیام آماده ارسال شود |
| condition | [{join:'OR'|'AND', type: 'EQUAL'|'INCLUDE', value:VALUE}] | شرایط و مقادیر کلمات کلیدی |
| user_should_follow_business_text | string | متن پیام برای گزینه شرط فالو |
| user_should_follow_business_button | string | متن دکمه شرط فالو |
| message_ids | Array[MESSAGE_IDS] | شناسه پیام های مدنظر ارسال |
خروجی
شی MessageResponse ایجاد شده در خروجی ارسال میشود.
حذف پاسخ خودکار
آدرس وب سرویس حذف پاسخ خودکار
accountId/response/responseIdپارامترها
بدون ورودی
خروجی
شی BooleanResponse ایجاد شده در خروجی ارسال میشود.
فرم ساز
با استفاده از سرویس های زیر می‌توانید فرم ها را مدیریت کرده و پیام های مشتریان را خروجی بگیرید.
لیست فرم
آدرس وب سرویس دریافت لیست فرم ها
accountId/formپارامترها
بدون ورودی
خروجی
آرایه‌ای از AutomationForm ایجاد شده در خروجی ها ارسال میشود.
مشخصات فرم
با کمک این سرویس می‌توانید مشخصات فایل با شناسه fileId را دریافت کنید.
آدرس وب سرویس
accountId/form/formIdپارامترها
بدون ورودی
خروجی
شی از Product ایجاد شده در خروجی ها ارسال میشود.
لیست پاسخ های فرم
آدرس وب سرویس دریافت پاسخ های فرم
accountId/form/formId/responseپارامترها
بدون ورودی
خروجی
آرایه‌ای از AutomationFormResponse ایجاد شده در خروجی ها ارسال میشود.
ایجاد فرم
آدرس وب سرویس ساخت فرم
accountId/formپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| title | String | عنوان |
| start_command | String | دستور شروع |
| cancel_command | String | دستور لغو |
| cancel_message | String | پیام لغو |
| end_message | String | پیام پایان |
| auto_form_messages | [{text: QUESTION_TEXT}] | سوالات فرم(ترتیب مهم است) |
خروجی
شی AutomationForm ایجاد شده در خروجی ارسال میشود.
تغییر وضعیت فرم
آدرس وب سرویس تغییر وضعیت فرم
accountId/form/formId/statusپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| status | true|false | وضعیت فعال بودن فرم |
خروجی
شی از BooleanResponse ایجاد شده در خروجی ها ارسال میشود.
ویرایش فرم
آدرس وب سرویس ویرایش فرم
accountId/form/formIdپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| title | String | عنوان |
| start_command | String | دستور شروع |
| cancel_command | String | دستور لغو |
| cancel_message | String | پیام لغو |
| end_message | String | پیام پایان |
| auto_form_messages | [{text: QUESTION_TEXT}] | سوالات فرم(ترتیب مهم است) |
خروجی
شی AutomationForm ایجاد شده در خروجی ارسال میشود.
حذف فرم
آدرس وب سرویس حذف فرم
accountId/form/formIdپارامترها
بدون ورودی
خروجی
شی BooleanResponse ایجاد شده در خروجی ارسال میشود.
آنالیز
با استفاده از این سرویس می‌توانید اکانت‌ها یا محتواهای منتشر شده را آنالیز کنید و دیتاهای کاملی از وضعیت آنها دریافت کنید.
آنالیز اکانت
با کمک این سرویس می‌توانید لیست تمام پیغام‌های مکالمه با شناسه conversationId کاربر مورد نظر را دریافت کنید.
آدرس وب سرویس
:accountIdپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| metric | String[] | نوع داده‌های درخواستی |
| period | String | یکی از مقادیر week، month، three_months، lifetime و یا custom |
| date_from | String | (اختیاری) تاریخ شروع در صورت custom |
| date_to | String | (اختیاری) تاریخ پایان در صورت custom |
خروجی
شی InsightsResponse در خروجی ارسال میشود.
آنالیز پست
با کمک این سرویس می‌توانید داده های آنالیز گروه پست با شناسه postGroupId کاربر مورد نظر را دریافت کنید.
آدرس وب سرویس
:postGroupIdپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| metric | String[] | نوع داده‌های درخواستی |
| period | String | یکی از مقادیر week، month، three_months، lifetime و یا custom |
| date_from | String | (اختیاری) تاریخ شروع در صورت custom |
| date_to | String | (اختیاری) تاریخ پایان در صورت custom |
خروجی
شی InsightsResponse در خروجی ارسال میشود.
اطلاعات کاربر
این سرویس مشخصات کاربر وارد شده با توکن را نشان می‌دهد، تمامی تاریخ‌ها و زمان‌ها به فرمت موجود در این قسمت به خروجی ارسال میشود.
مشخصات کاربر
با کمک این سرویس می‌توانید مشخصات کاربر فعلی را دریافت کنید.
آدرس وب سرویس
پارامترها
بدون ورودی
خروجی
شی User در خروجی ارسال میشود.
مشخصات فایل
با کمک این سرویس می‌توانید مشخصات فضای ذخیره‌سازی کاربر وارد شده را دریافت کنید.
آدرس وب سرویس
پارامترها
بدون ورودی
خروجی
شی StorageInfo در خروجی ارسال میشود.
پست‌ها
در این سرویس شما می‌توانید پست‌های مختلف ارسال نمایید.
لیست گروه پست‌ها
با کمک این سرویس می‌توانید لیست گروه پست‌های کاربر مورد نظر را دریافت کنید.
آدرس وب سرویس
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
| account_ids | Integer[] | (اختیاری) فیلتر شناسه‌های اکانت |
| order | String | (اختیاری) تعیین نحوه مرتب سازی پست یکی از مقادیر id یا schedule_date |
| publish_from | String | (اختیاری) فیلتر پست‌های بعد از تاریخ |
| publish_to | String | (اختیاری) فیلتر پست‌های قبل از تاریخ |
خروجی
آرایه از PostGroup در فرمت Pagination در خروجی ارسال می شود.
برای اطلاعات بیشتر به بخش صفحه بندی مراجعه کنید.
ایجاد پست
با کمک این سرویس می‌توانید پست جدید اضافه کنید.
آدرس وب سرویس
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
| caption | String | متن کپشن |
| custom_captions | Object | (اختیاری) کپشن‌های سفارشی بر اساس شبکه اجتماعی. اندیس هر عضو نام شبکه اجتماعی و مقدار آن کپشن سفارشی می‌باشد. |
| type | String | نوع پست (یکی از مقادیر text، image، album، video, document, story یا poll) |
| account_ids | Integer[] | شناسه اکانت |
| media_ids | Integer[] | شناسه فایل |
| is_scheduled | 0|1 | زمانبندی بودن پست |
| schedule_date | Integer | تاریخ زمانبندی پست بر اساس UTC |
| is_draft | 0|1 | پیش نویس بودن پست |
| location | String | مقدار value موقعیت دریافت شده از جستجوی موقعیت مکانی |
| hashtag | String[] | (اختیاری) هشتگ |
| photo_tags | Object | (اختیاری) آرایه از تگ‌های تصویر. اندیس هر عضو آرایه برابر با شناسه فایل مورد نظر می‌باشد. مقدار هر عضو یک ارایه به مقدایر locationX، locationY، text و id می‌باشد. مقدار id برابر با pk از بخش جستجوی کاربر می‌باشد. |
| poll | Object | (اختیاری) آرایه ای متشکل از دو مقدار سوال و پاسخ ها می‌باشد.سوال(question) به شکل رشته می‌باشد و پاسخ ها(answers) به شکل آرایه ای از پاسخ ها. |
| auto_delete | Array | پست پس از انتشار، بعد از ساعت مشخص شده به صورت خودکار از اکانت شما حذف میشود (حداکثر 47).این فیلد آرایه ای شامل ساعت (hour) و اکانت های انتخابی (account_ids) می‌باشد.همچنین مقدار account_ids باید به شکل آرایه ارسال گردد. |
همچنین برای شبکه‌های اجتماعی در لیست زیر ورودی های جداگانه نیاز است که در هر بخش ذکر شده است.
پارامترهای InstagramOfficial
| نام | نوع | توضیحات |
|---|---|---|
| thumbnail_second | Object | ثانیه ویدیو برای پیش نمایش. اندیس هر عضو برابر شناسه فایل و مقدار آن ثانیه می‌باشد. |
| reels | 0|1 | پست به شکل ریلز ارسال میشود. |
| audio_name | string | نام صدای ریلز. |
| video_cover | integer | شناسه تصویر کاور ریلز. |
| first_comment | string | نظر اول |
| reels_tags | [{"username": "novinhub"}] | تگ کردن فرد در ویدئوی ریلز. |
| reels_sharetofeed | 0|1 | ارسال ریلز به فید. |
پارامترهای Linkedin
| نام | نوع | توضیحات |
|---|---|---|
| linkedin_title | string | عنوان ویدیو |
پارامترهای Pinterest
| نام | نوع | توضیحات |
|---|---|---|
| pinterest_title | string | عنوان |
| pinterest_url | string | لینک |
پارامترهای Telegram
| نام | نوع | توضیحات |
|---|---|---|
| thumbnail_second | Object | ثانیه ویدیو برای پیش نمایش. اندیس هر عضو برابر شناسه فایل و مقدار آن ثانیه می‌باشد. |
| telegram_buttons | array | دکمه‌های شیشه‌ای. هر عضو ارایه شامل یک رشته به فرمت title:link می‌باشد. |
| telegram_pin_message | 0|1 | پست به صورت پین در بالای کانال نمایش داده میشود. |
| telegram_has_signature | 0|1 | یوزرنیم (username) کانال به انتهای متن در پست‌ها اضافه خواهد شد. |
پارامترهای Twitter
| نام | نوع | توضیحات |
|---|---|---|
| tweets | string[] | آرایه از متن توییت‌ها برای رشته توییت |
پارامترهای TikTok
| نام | نوع | توضیحات |
|---|---|---|
| tiktok_privacy_level | string | مشخص کنید پس از انتشار ویدیو چه کسی می‌تواند ویدیو را ببیند |
| tiktok_disable_comment | 0|1 | غیرفعال کردن نظرات |
| tiktok_disable_duet | 0|1 | غیرفعال کردن Duet |
| tiktok_disable_stitch | 0|1 | غیرفعال کردن Stitch |
| thumbnail_second | Object | ثانیه ویدیو برای پیش نمایش. اندیس هر عضو برابر شناسه فایل و مقدار آن ثانیه می‌باشد. |
پارامترهای Youtube
| نام | نوع | توضیحات |
|---|---|---|
| youtube_category | string | شناسه دسته بندی |
| youtube_title | string | عنوان ویدیو |
| youtube_privacy | string | یکی از سه مقدار public - private - unlisted |
پارامترهای Aparat
| نام | نوع | توضیحات |
|---|---|---|
| aparat_category | string | شناسه دسته بندی |
| aparat_title | string | عنوان ویدیو |
| aparat_video_cover | integer | شناسه تصویر کاور ویدیو |
پارامترهای Bale
| نام | نوع | توضیحات |
|---|---|---|
| bale_has_signature | 0|1 | یوزرنیم (username) کانال به انتهای متن در پست‌ها اضافه خواهد شد. |
پارامترهای Eitaa
| نام | نوع | توضیحات |
|---|---|---|
| eitaa_pin_message | 0|1 | پست به صورت پین در بالای کانال نمایش داده میشود. |
| eitaa_has_signature | 0|1 | یوزرنیم (username) کانال به انتهای متن در پست‌ها اضافه خواهد شد. |
پارامترهای Gap
| نام | نوع | توضیحات |
|---|---|---|
| gap_has_signature | 0|1 | یوزرنیم (username) کانال به انتهای متن در پست‌ها اضافه خواهد شد. |
خروجی
شی Post ایجاد شده در خروجی ارسال میشود
مشخصات گروه پست
با کمک این سرویس می‌توانید مشخصات گروه پست با شناسه postGroupId را دریافت کنید.
آدرس وب سرویس
:postGroupIdپارامترها
بدون ورودی
خروجی
شی PostGroup در خروجی ارسال میشود.
مشخصات پست
با کمک این سرویس می‌توانید مشخصات پست با شناسه postId را دریافت کنید.
آدرس وب سرویس
:postIdپارامترها
بدون ورودی
خروجی
شی Post در خروجی ارسال میشود.
ویرایش پست
با کمک این سرویس می‌توانید پست با شناسه postGroupId را ویرایش کنید.
آدرس وب سرویس
:postGroupIdپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| caption | String | متن کپشن |
| custom_captions | Object | (اختیاری) کپشن‌های سفارشی بر اساس شبکه اجتماعی. اندیس هر عضو نام شبکه اجتماعی و مقدار آن کپشن سفارشی می‌باشد. |
| type | String | نوع پست ( یکی از مقادیر text، image، album، video یا document ) |
| account_ids | Integer[] | شناسه اکانت |
| media_ids | Integer[] | شناسه فایل |
| is_scheduled | 0|1 | زمانبندی بودن پست |
| schedule_date | Integer | تاریخ زمانبندی پست بر اساس UTC |
| is_draft | 0|1 | پیش نویس بودن پست |
| location | String | مقدار value موقعیت دریافت شده از جستجوی موقعیت مکانی |
| hashtag | String[] | (اختیاری) هشتگ |
| photo_tags | Object | (اختیاری) آرایه از تگ‌های تصویر. اندیس هر عضو آرایه برابر با شناسه فایل مورد نظر می‌باشد. مقدار هر عضو یک ارایه به مقدایر locationX، locationY، text و id می‌باشد |
همچنین برای شبکه‌های اجتماعی در این لیست ورودی‌های جداگانه نیاز است که در هر بخش ذکر شده است.
خروجی
شی Post ایجاد شده در خروجی ارسال میشود
ویرایش پست بعد از انتشار
با کمک این سرویس می‌توانید پست با شناسه postGroupId را ویرایش کنید.
در حال حاضر ویرایش برای شبکه‌های Telegram و Instagram پشتیبانی میشود.
آدرس وب سرویس
:postGroupId/editپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| caption | String | متن کپشن |
| custom_captions | Object | (اختیاری) کپشن‌های سفارشی بر اساس شبکه اجتماعی. اندیس هر عضو نام شبکه اجتماعی و مقدار آن کپشن سفارشی می باشد. |
| type | String | نوع پست ( یکی از مقادیر text، image، album، video یا document ) |
| account_ids | Integer[] | شناسه اکانت |
| media_ids | Integer[] | شناسه فایل |
| is_scheduled | 0|1 | زمانبندی بودن پست |
| schedule_date | Integer | تاریخ زمانبندی پست بر اساس UTC |
| is_draft | 0|1 | پیش نویس بودن پست |
| location | String | مقدار value موقعیت دریافت شده از جستجوی موقعیت مکانی |
| hashtag | String[] | (اختیاری) هشتگ |
| photo_tags | Object | (اختیاری) آرایه از تگ‌های تصویر. اندیس هر عضو آرایه برابر با شناسه فایل مورد نظر می‌باشد. مقدار هر عضو یک ارایه به مقدایر locationX، locationY، text و id می‌باشد |
همچنین برای شبکه‌های اجتماعی در این لیست ورودی‌های جداگانه نیاز است که در هر بخش ذکر شده است.
خروجی
شی Post ایجاد شده در خروجی ارسال میشود
تلاش مجدد پست
با کمک این سرویس می‌توانید گروه پست با شناسه postGroupId را برای تلاش مجدد ثبت کنید.
آدرس وب سرویس
:postGroupId/retryپارامترها
بدون ورودی
خروجی
شی BooleanResponse در خروجی ارسال میشود.
لغو پست
با کمک این سرویس می‌توانید گروه پست با شناسه postGroupId را کنسل کنید.
آدرس وب سرویس
:postGroupId/cancelپارامترها
بدون ورودی
خروجی
شی BooleanResponse در خروجی ارسال میشود.
حذف پست
با کمک این سرویس می‌توانید گروه پست با شناسه postGroupId را حذف کنید.
آدرس وب سرویس
:postGroupIdپارامترها
بدون ورودی
خروجی
شی BooleanResponse در خروجی ارسال میشود.
لیست پیش نویس‌ها
با کمک این سرویس می‌توانید لیست گروه پست‌های پیشنویس کاربر مورد نظر را دریافت کنید.
آدرس وب سرویس
پارامترها
بدون ورودی
خروجی
آرایه از PostGroup در فرمت Pagination در خروجی ارسال میشود.
برای اطلاعات بیشتر به بخش صفحه بندی مراجعه کنید.
تگ گروه پست‌ها
با کمک این سرویس می‌توانید تگ (برچسب) به گروه پست‌ها اضافه کنید.
با استفاده از این قابلیت می‌توانید گروه پست‌ها را دسته بندی کنید.
لیست تگ گروه پست‌ها
با کمک این سرویس می‌توانید لیست تمام تگ های گروه پست کاربر مورد نظر را دریافت کنید.
آدرس وب سرویس
پارامترها
بدون ورودی
خروجی
آرایه از PostGroupTag در خروجی ارسال میشود.
ایجاد تگ گروه پست
با کمک این سرویس می‌توانید تگ گروه پست جدید اضافه کنید.
آدرس وب سرویس
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
| name | String | نام تگ |
| color | String | کد HEX رنگ |
خروجی
شی PostGroupTag ایجاد شده در خروجی ارسال میشود.
مشخصات تگ گروه پست
با کمک این سرویس می‌توانید مشخصات تگ گروه پست با شناسه postGroupTagId را دریافت کنید.
آدرس وب سرویس
:postGroupTagIdپارامتر ها
بدون ورودی
خروجی
شی PostGroupTag در خروجی ارسال میشود.
ویرایش تگ گروه پست
با کمک این سرویس می‌توانید تگ گروه پست با شناسه postGroupTagId را ویرایش نمایید.
آدرس وب سرویس
:postGroupTagIdپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| name | String | نام تگ |
| color | String | کد HEX رنگ |
خروجی
شی PostGroupTag ویرایش شده در خروجی ارسال میشود.
حذف تگ گروه پست
با کمک این سرویس می‌توانید تگ گروه پست با شناسه postGroupTagId را حذف کنید.
آدرس وب سرویس
:postGroupTagIdپارامترها
بدون ورودی
خروجی
شی BooleanResponse در خروجی ارسال میشود.
دریافت مشخصات کاربر
با کمک این سرویس می‌توانید مشصخات کاربر در شبکه اجتماعی را با شناسه sociaUserId را دریافت کنید.
آدرس وب سرویس
پارامتر ها
بدون ورودی
خروجی
شی SocialUser در خروجی ارسال میشود.
ویرایش مشخصات کاربر
با کمک این سرویس می‌توانید اطلاعات مربوط به کاربر را با شناسه sociaUserId ویرایش نمایید.
آدرس وب سرویس
:sociaUserIdپارامترها
| نام | نوع | توضیحات |
|---|---|---|
| number | string | موبایل |
| string | ایمیل | |
| company | string | شرکت |
| job | string | شغل |
| location | string | موقعیت مکانی |
خروجی
شی SocialUser ویرایش شده در خروجی ارسال میشود.
جستجو
در این قسمت می‌توانید از سرویس جستجو برای برخی از بخش‌ها همچون هشتگ، لوکیشن، استکیر و ...استفاده کنید.
جستجو موقعیت مکانی
با کمک این سرویس می‌توانید هشتگ‌های مشابه هشتگ ارسالی را جستجو کنید.
آدرس وب سرویس
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
| query | String | متن جستجو |
| account_ids | String | شناسه اکانت |
خروجی
آرایه از SearchLocation در خروجی ارسال میشود.
جستجو کاربران
با کمک این سرویس می‌توانید هشتگ‌های مشابه هشتگ ارسالی را جستجو کنید.
آدرس وب سرویس
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
| query | String | متن جستجو |
| account_ids | String | شناسه اکانت |
خروجی
آرایه از SearchPeople در خروجی ارسال میشود.
جستجو هشتگ مشابه
با کمک این سرویس می‌توانید هشتگ‌های مشابه هشتگ ارسالی را جستجو کنید.
آدرس وب سرویس
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
| query | String | متن جستجو |
| account_ids | String | شناسه اکانت |
خروجی
آرایه از string در خروجی ارسال میشود.
Reference
در این قسمت می‌توانید لیست کاملی از مواردی که در هر سرویس از API در دسترس دارید را ببینید.
این صفحه به شما کمک می‌کند خیلی سریعتر به لیست تمامی دستورات در هر سرویس دستیابی داشته باشید.
Account
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه اکانت |
| identifier | String | شناسه منحصر اکانت |
| name | String | نام اکانت |
| login_required | Integer | نیاز به ورود مجدد |
| relogin_reason | String | شناسه اکانت |
| date | String | تاریخ ثبت |
| type | String | نام شبکه اجتماعی |
| comment_subscribe | Integer | اشتراک کامنت |
| profile_url | String | لینک پروفایل اکانت |
| picture_url | String | لینک تصویر اکانت |
| info | String | توضیحات اکانت |
| insights_order | Integer | ترتیب آنالیز |
| direct_subscribe | Integer | اشتراک مکالمه |
| social_user_id | Integer | شناسه کاربر در شبکه اجتماعی |
AccountGroup
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه گروه اکانت |
| name | String | نام گروه اکانت |
| date | String | تاریخ ثبت |
| account_ids | Integer[] | شناسه اکانت‌ها در گروه |
AccountPost
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه پست |
| type | String | نوع پست ( text, image, album, video, link, document, story ) |
| post_id | String | شناسه منحصر پست |
| image | String | لینک تصویر |
| content | String | محتوی پست |
| date | String | تاریخ ثبت |
| like_count | Integer | تعداد لایک |
| comment_count | Integer | تعداد کامنت |
| social_user_id | Integer | شناسه کاربر ارسال کننده |
| user_id | Integer | شناسه کاربر |
| account_id | Integer | شناسه اکانت |
| permalink | String | لینک پست |
| social | String | شبکه اجتماعی پست |
BooleanResponse
| نام | نوع | توضیحات |
|---|---|---|
| success | boolean | در صورت موفقیت بودن عملیات true است. |
Caption
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه کپشن |
| name | String | نام کپشن |
| caption | String | متن کپشن |
| date | String | تاریخ ثبت |
Comment
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه کامنت |
| comment_id | Integer | شناسه منحصر کامنت |
| text | String | متن کامنت |
| date | String | تاریخ ثبت |
| can_delete | Integer | قابل حذف |
| can_reply | Integer | قابل پاسخ |
| can_like | Integer | قابل لایک |
| status | Integer | وضعیت |
| like | Integer | لایک |
| post_id | String | شناسه پست |
| parent_id | String | شناسه کامنت اصلی ( در صورت موجود ) |
| social_user_id | Integer | شناسه کاربر ارسال کننده |
| account_id | Integer | شناسه اکانت |
| user_id | Integer | شناسه کاربر |
| social | String | شبکه اجتماعی پست |
| from | Integer | نام ارسال کننده ( در صورت ارسال از پنل ) |
| tags | CommentTag[] | تگ های کامنت |
| parentName | Integer | نام ارسال کننده کامنت اصلی |
Field expansions
برای اطلاعات بیشتر به صفحه Field expansion مراجعه کنید
CommentTag
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه تگ |
| name | String | نام تگ |
| color | String | کد رنگ تگ |
| user_id | Integer | شناسه کاربر |
Conversation
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه مکالمه |
| conversation_id | Integer | شناسه منحصر مکالمه |
| update_date | String | تاریخ آخرین تغییر |
| account_id | Integer | شناسه اکانت |
| participants | ConversationParticipant[] | کاربران مکالمه |
| last_message | String | متن آخرین پیغام |
| last_seen_message_id | Integer | شناسه آخرین پیغام دیده شده |
| last_seen_time | String | تاریخ آخرین پیغام دیده شده |
| tags | ConversationTag[] | تگ های مکالمه |
| status | Integer | وضعیت |
ConversationTag
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه تگ |
| name | String | نام تگ |
| color | String | کد رنگ تگ |
| user_id | Integer | شناسه کاربر |
ConversationParticipant
| نام | نوع | توضیحات |
|---|---|---|
| social_user_id | Integer | شناسه کاربر |
| socialUser | SocialUser[] | کاربر |
CursorPagination
| نام | نوع | توضیحات |
|---|---|---|
| data | Object | لیست آیتم‌های صفحه بندی |
| paging | Array | آرایه صفحه بندی با اندیس های before، after و total |
Department
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه واحد |
| name | String | نام واحد |
ErrorResponse
| نام | نوع | توضیحات |
|---|---|---|
| message | String | متن خطا |
| type | String | نوع خطا |
| trace_id | String | شناسه پیگیری خطا |
File
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه فایل |
| title | String | نام فایل |
| filesize | Integer | حجم فایل به بایت |
| date | String | تاریخ ثبت |
| url | String | لینک فایل |
| star | 0|1 | نشان دار بودن |
| thumbnailUrl | String | لینک پیش نمایش |
| fileType | String | نوع فایل ( image, video, document ) |
| ext | String | پسوند فایل |
GenerateImage
| نام | نوع | توضیحات |
|---|---|---|
| image | String | فایل تولید شده به صورت base64 |
| mime | String | نوع فایل |
AutomationMessage
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه |
| title | String | عنوان |
| type | String | نوع |
| text | String | متن |
| file_id | Integer | شناسه فایل |
| quick_replies | Array | دکمه |
| buttons | Array | دکمه |
| created_at | String | تاریخ ایجاد |
AutomationMenu
| نام | نوع | توضیحات |
|---|---|---|
| title | String | عنوان |
| type | String | نوع |
| payload | String | مقدار |
AutomationQuestion
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه |
| title | String | عنوان |
| subtitle | String | متن |
| file_id | Integer | شناسه فایل |
| url | String | لینک |
| buttons | Array | دکمه‌ها |
| created_at | String | تاریخ ایجاد |
AutomationQuestionParams
| نام | نوع | توضیحات |
|---|---|---|
| title | String | عنوان |
| payload | MESSAGE_ID | مقدار |
Product
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه |
| title | String | عنوان |
| subtitle | String | متن |
| file_id | String | شناسه فایل |
| url | String | لینک |
| buttons | Array | دکمه‌ها |
| created_at | String | تاریخ ایجاد |
MessageResponse
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه |
| direct | Integer | از نوع دایرکت |
| comment | Integer | از نوع کامنت |
| condition | String | شرایط و مقادیر کلمات کلیدی |
| message_id | String | شناسه پیام |
| message_ids | Array | شناسه پیام ها |
| user_should_follow_business_text | String | متن پیام برای گزینه شرط فالو |
| user_should_follow_business_button | String | متن دکمه شرط فالو |
| react_to_direct | 0|1 | لایک پیام‌های دریافتی |
| created_at | String | تاریخ ایجاد |
AutomationMessageResponse
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه |
| auto_message_id | String | شناسه پیام خودکار |
| source_message_id | String | شناسه کامنت اصلی |
| source_comment_id | String | شناسه پیام اصلی |
| response_message_id | String | شناسه پاسخ پیام |
| auto_response_id | String | شناسه پاسخ خودکار |
| message | String | پیام |
| created_at | String | تاریخ ایجاد |
Field expansions
برای اطلاعات بیشتر به صفحه Field expansion مراجعه کنید
AutomationForm
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه |
| title | String | عنوان |
| status | String | وضعیت |
| start_command | String | دستور شروع |
| cancel_command | String | دستور لغو |
| cancel_message | String | پیام لغو |
| end_message | String | پیام پایان |
| created_at | String | تاریخ ایجاد |
AutomationFormMessage
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه |
| text | String | متن |
| form_id | Integer | شناسه فایل |
| quick_replies | Array | دکمه |
| created_at | String | تاریخ ایجاد |
AutomationFormResponse
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه |
| social_user_id | Integer | شناسه کاربر |
| status | String | وضعیت |
| created_at | String | تاریخ ایجاد |
| seen_at | String | تاریخ مشاهده |
AutomationQuickReply
| نام | نوع | توضیحات |
|---|---|---|
| title | String | عنوان |
| message_id | Integer | شناسه پیام |
AutomationButton
| نام | نوع | توضیحات |
|---|---|---|
| title | String | عنوان |
| type | link|message | نوع |
| payload | LINK|MESSAGE_ID | مقدار |
Insights
| نام | نوع | توضیحات |
|---|---|---|
| metric | String[] | نام داده |
| data | Integer|String|array|object | داده آنالیز |
InsightsResponse
| نام | نوع | توضیحات |
|---|---|---|
| insights | Insights[] | آرایه از داده‌های آنالیز |
| metric | String[] | داده‌های لود شده |
Message
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه پیام |
| message_id | Integer | شناسه منحصر مکالمه |
| type | String | نوع پیام ( text, media, share, mention_story, reply_story, unsupported ) |
| attachment | String | لینک فایل پیوست ( در صورت موجود ) |
| text | String | متن پیغام |
| date | String | تاریخ ثبت |
| can_delete | Integer | قابل حذف |
| can_reaction | Integer | قابل واکنش |
| social_user_id | Integer | شناسه کاربر ارسال کننده |
| reactions | MessageReaction[] | واکنش‌های پیام |
| account_id | Integer | شناسه اکانت |
| conversation_id | Integer | شناسه مکالمه |
MessageReaction
| نام | نوع | توضیحات |
|---|---|---|
| social_user_id | Integer | شناسه کاربر |
| is_owner | boolean | در صورتی که صاحب اکانت باشد true است |
| socialUser | SocialUser[] | کاربر |
Pagination
| نام | نوع | توضیحات |
|---|---|---|
| data | Object | لیست آیتم‌های صفحه بندی |
| paging | Array | آرایه صفحه بندی با اندیس‌های prev، next، page، total و totalPage |
Post
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه پست |
| caption | String | متن |
| media_ids | Integer[] | شناسه های فایل |
| account_id | Integer | شناسه اکانت |
| publish_date | String | تاریخ انتشار |
| location | String | موقعیت مکانی |
| status | String | وضعیت پست |
| log | String | متن خطای پست |
Field expansions
برای اطلاعات بیشتر به صفحه Field expansion مراجعه کنید
PostGroup
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه گروه پست |
| type | String | نوع پست |
| is_scheduled | String | پست زمانبندی شده |
| create_date | String | تاریخ ثبت |
| schedule_date | String | تاریخ زمانبندی |
| from_user | String | نام ارسال کننده ( در صورت ارسال از پنل ) |
| caption | String | متن |
PostGroupTag
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه تگ |
| name | String | نام تگ |
| color | String | کد رنگ تگ |
| user_id | Integer | شناسه کاربر |
| created_at | String | تاریخ ایجاد |
| updated_at | String | تاریخ ویرایش |
RedirectResponse
| نام | نوع | توضیحات |
|---|---|---|
| redirect | String | آدرس صفحه که کاربر نیاز است به آن هدایت شود. |
SocialUser
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه کاربر |
| user_id | String | شناسه کاربر در نوین‌هاب |
| username | String | نام کاربری |
| name | String | نام کاربر |
| image | String | تصویر پروفایل |
| social | String | شبکه اجتماعی پست |
SocialUserMeta
| نام | نوع | توضیحات |
|---|---|---|
| name | String | نام |
| social_user_id | Integer | شناسه کاربر |
| account_id | Integer | شناسه حساب |
SearchLocation
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه موقعیت |
| name | String | نام موقعیت |
| description | String | توضیحات |
| social | String | نام شبکه اجتماعی |
| lat | String | مقدار latitude |
| lng | String | مقدار longitude |
| type | location | مقدار ثابت |
SearchPeople
| نام | نوع | توضیحات |
|---|---|---|
| pk | Integer | شناسه کاربر |
| username | String | نام کاربری |
| profile_pic_url | String | تصویر شبکه اجتماعی |
StorageInfo
| نام | نوع | توضیحات |
|---|---|---|
| total_files | Integer | تعداد کل فایل ها |
| max_file_size | Integer | سقف آپلود هر فایل |
| max_file_size_readable | String | سقف آپلود هر فایل فرمت شده |
| total_storage | Integer | کل فضای موجود |
| total_storage_readable | String | کل فضای موجود فرمت شده |
| used_storage | Integer | فضای استفاده شده |
| used_storage_readable | String | فضای استفاده شده فرمت شده |
| remaining_storage | Integer | فضای باقی مانده |
| remaining_storage_readable | String | فضای باقی مانده فرمت شده |
User
| نام | نوع | توضیحات |
|---|---|---|
| id | Integer | شناسه |
| String | ایمیل | |
| mobile | String | شماره تماس |
| user_type | String | نوع کاربر ( real, legal ) |
| natioanl_code | String | کد ملی ( در صورت حقیقی بودن ) |
| company | String | نام شرکت ( در صورت حقوقی بودن ) |
| national_id | String | شناسه ملی ( در صورت حقوقی بودن ) |
| tax_number | String | کد اقتصادی ( در صورت حقوقی بودن ) |
| registration_number | String | شماره ثبت ( در صورت حقوقی بودن ) |
| name | String | نام |
| package_id | Integer | شناسه پکیج |
| timezone | String | موقیت زمانی |
| timezone_offset | String | اختلاف زمانی با UTC |
| dateformat | String | فرمت تاریخ |
| timeformat | String | فرمت ساعت |
| language | String | زبان |
| expire_date | String | تاریخ انقضا |
| packageTitle | Stringr | عنوان پکیج |
| notifications | String | وضعیت اطلاع‌رسانی |
| has_webserivce | String | فعال بودن وب سرویس |
| activity | String | فعالیت |
| postal_code | String | کد پستی |
| address | String | آدرس |
اطلاعات کاربر در شبکه اجتماعی
در این سرویس شما می‌توانید اطلاعات مربوط به کاربر در شبکه های اجتماعی و همچنین اطلاعات دسته‌بندی شده شخص در نوین‌هاب را مدیریت کنید.