وب سرویس نظرسنجی

سازنده صائب خانزاده


ساده و کاربردی

مستندات بهره گیری

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

آغاز کار

درخواست های شما باید برای نشانی زیر فرستاده شود:
 http://vote.subz.ir/apiv2.php

پارامتر ها

otherapp

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

chat_id

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

data

دستور خود را می توانید با استفاده از این پارامتر بفرستید.
نمونه ساختار ارسال به وب سرویس
 http://vote.subz.ir/apiv2.php?otherapp=app_name&chat_id=1&data=/new

دستورات پارامتر data

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

/create

با این دستور وب سرویس برای «پلتفرم-کاربر» معرفی شده یک پرونده باز می کند.
 http://vote.subz.ir/apiv2.php?otherapp=app_name&chat_id=1&data=/create
خروجی نمونه موفق
 {"okay":true,"chat_id":"1","text":"ready"}

/done

در صورت اینکه ثبت گزینه ها توسط کاربر به پایان رسید با فرستادن این دستور ثبت می شود.
 http://vote.subz.ir/apiv2.php?otherapp=app_name&chat_id=1&data=/create
خروجی نمونه موفق
 {"okay":true,"chat_id":"1","text":"saved","voteid":1}

/cancel

در هر مرحله می توانید از ساخت نظرسنجی انصراف دهید.
 http://vote.subz.ir/apiv2.php?otherapp=app_name&chat_id=1&data=/cancel
خروجی نمونه موفق
 {"okay":true,"chat_id":"1","text":"canceled"}

/delete_{vote_id}

{vote_id} کد اختصاصی نظرسنجی ساخته شده است. برای پاک کردن یک نظرسنجی کافی است که با همان «پلتفرم-کاربر» به ربات دستور پاک کردن را بفرستید.
 http://vote.subz.ir/apiv2.php?otherapp=app_name&chat_id=1&data=/delete_1
خروجی نمونه موفق
 {"okay":true,"chat_id":"1","text":"deleted"}
خروجی نمونه ناموفق
 {"okay":false,"chat_id":"1","text":"Poll ID not Found"}
کد خطا ها
de1: شناسه کد پیدا نیست
de2: مشکلی با مرکز اطلاعات پیدا شده
de3: مجوز دسترسی به این شناسه را ندارید

/public_{vote_id}

{vote_id} کد اختصاصی نظرسنجی ساخته شده است. برای عمومی کردن یک نظرسنجی کافی است که با همان «پلتفرم-کاربر» به ربات دستور عمومی کردن را بفرستید.
عمومی کردن به این معنی هست که نوع پیام عمومی می شود و در صفحه سایت vote.subz.ir قرار میگیرد.
 http://vote.subz.ir/apiv2.php?otherapp=app_name&chat_id=1&data=/public_1
خروجی نمونه موفق
 {"okay":true,"chat_id":"1","text":"done","voteid":"1"}
خروجی نمونه ناموفق
 {"okay":false,"chat_id":"1","text":"Poll ID not Found","error":"pu3"}
کد خطا ها
pu1: شناسه کد پیدا نیست
pu2: مشکلی با مرکز اطلاعات پیدا شده
pu3: مجوز دسترسی به این شناسه را ندارید

/unpublic_{vote_id}

{vote_id} کد اختصاصی نظرسنجی ساخته شده است. برای خصوصی کردن یک نظرسنجی کافی است که با همان «پلتفرم-کاربر» به ربات دستور خصوصی کردن را بفرستید.
خصوصی کردن به این معنی هست که نوع نظرسنجی خصوصی می شود و از صفحه سایت vote.subz.ir خارج می شود.
 http://vote.subz.ir/apiv2.php?otherapp=app_name&chat_id=1&data=/unpublic_1
خروجی نمونه موفق
 {"okay":true,"chat_id":"1","text":"done","voteid":"1"}
خروجی نمونه ناموفق
 {"okay":false,"chat_id":"1","text":"Poll ID not Found","error":"up1"}
کد خطا ها
up1: شناسه کد پیدا نیست
up2: مشکلی با مرکز اطلاعات پیدا شده
up3: مجوز دسترسی به این شناسه را ندارید

/close_{vote_id}

{vote_id} کد اختصاصی نظرسنجی ساخته شده است. برای بستن یک نظرسنجی کافی است که با همان «پلتفرم-کاربر» به ربات دستور بستن را بفرستید.
بستن نظرسنجی یعنی دیگر نظری ثبت نشود.
 http://vote.subz.ir/apiv2.php?otherapp=app_name&chat_id=1&data=/close_1
خروجی نمونه موفق
 {"okay":true,"chat_id":"1","text":"done","voteid":"1"}
خروجی نمونه ناموفق
 {"okay":false,"chat_id":"1","text":"Poll ID not Found","error":"cl1"}
کد خطا ها
cl1: شناسه کد پیدا نیست
cl2: مشکلی با مرکز اطلاعات پیدا شده
cl3: مجوز دسترسی به این شناسه را ندارید

/open_{vote_id}

{vote_id} کد اختصاصی نظرسنجی ساخته شده است. برای بازکردن یک نظرسنجی کافی است که با همان «پلتفرم-کاربر» به ربات دستور بازکردن را بفرستید.
باز کردن نظرسنجی یعنی شرکت کنندگان تازه بتوانند رای دهند.
 http://vote.subz.ir/apiv2.php?otherapp=app_name&chat_id=1&data=/open_1
خروجی نمونه موفق
 {"okay":true,"chat_id":"1","text":"done","voteid":"1"}
خروجی نمونه ناموفق
 {"okay":false,"chat_id":"1","text":"Poll ID not Found","error":"op1"}
کد خطا ها
op1: شناسه کد پیدا نیست
op2: مشکلی با مرکز اطلاعات پیدا شده
op3: مجوز دسترسی به این شناسه را ندارید

/mine

{vote_id} کد اختصاصی نظرسنجی ساخته شده است. برای بازکردن یک نظرسنجی کافی است که با همان «پلتفرم-کاربر» به ربات دستور بازکردن را بفرستید.
باز کردن نظرسنجی یعنی شرکت کنندگان تازه بتوانند رای دهند.
 http://vote.subz.ir/apiv2.php?otherapp=app_name&chat_id=1&data=/mine
خروجی نمونه موفق
 {"okay":true,"chat_id":"1","text":"\n1. question 1\n2. question 2","options":{"texts":["question 1","question 2"],"commands":["\/mine;1","\/mine;2"]}}
متن پرسش ها در خانه texts و متن دستور برای دیدن جزئیات رای گیری در خانه commands هستند خروجی نمونه ناموفق
 {"okay":false,"chat_id":"1","text":"user not found","error":"mi1"}
کد خطا ها
mi1: کاربر پیدا نشد

/voteto;{vote_id};{choice_id}

{vote_id} کد اختصاصی نظرسنجی ساخته شده است. {choice_id} کد گزینه است. برای رای دادن این موارد را پر کنید. این موارد در پاسخ ربات به شما داده می شود.
http://vote.subz.ir/apiv2.php?otherapp=app_name&chat_id=1&data=/voteto;1;0

 <hr/>


کد نظرسنجی را وارد کنید
جای شما
دیده شوید. تماس بگیرید