راهنمای وب سرویس مدیریت مشتریان
در موارد زیادی مشاهده شده که با اضافه شدن امکان ارسال و دریافت پیامک به محصولات نرم افزاری میتوان برای مشتریان ارزش آفرینی کرد و براساس آن درآمد را افزایش داد . از این رو نیاز به سیستمی که بتواند امکانات زیر را ارائه دهد حس می شود.
- نگهدرای اطالاعات مربوط به مشتریان
- امکان ارسال و دریافت پیامک را در کنسول وب یا محیط نرم افزار ارائه دهد
- قابلیت مدیریت اطلاعات آنها از بستر وب سرویس فراهم باشد
- گزارشات دقیق در مورد میزان ارسال و درصد خطا
- نمایس شارژ حساب
کاربرد مدیریت مشتریان
- ایجاد سیستم آنلاینی که مشتری شما علاوه بر استفاده از ابزار تهیه شده توسط شما نیاز دارد برخی از امور خود را از طریق پیامک مدیریت کند مانند دسته بندی مخاطبین و ارسال و دریافت پیامک , مدیریت میزان شارژ و...
- وجود امکان ارسال پیامک در نرم افزاری های رومیزی که در آن مشتری با شما دائما در ارتباط نخواهد بود به این معنی که محصول کپسوله شده شما در بازار در حال فروش است و شما اطلاع دقیقی ندارید که توسط چه افرادی در حال استفاده است.
توجه : این نسخه از مستندات صرفا برای مشتریان کاوه نگار قابل استفاده است که از تراکنش بالائی برخوردارند. و در حال حاضر فقط از طریق REST قابل استفاده است.
نحوی بکارگیری
این بخش از واسط های وب سرویس پیام کوتاه کاوه نگار در حال حاضر توسط مدل REST قابل دسترسی است و خروجی آن به دو روش XML و JSON خواهد بود
در این بخش ما با دو واژه شناسه والد و شناسه فرزند روبرو خواهیم شد.
- شناسه والد همان API-Key صاحب اصلی حساب که شما (توسعه دهندگان) باشید است (Master API Key)
- شناسه فرزند همان API-Key مشتریان است که توسط شناسه والد ایجاد و مدیریت میشود(Slave API Key)
آدرس پایه این بخش با مسیر زیر در دسترس است
http://api.kavenegar.com/v1/{MasterAPI-KEY}/client/methodname.output
آدرس دسترسی به متدها
http://api.kavenegar.com/v1/{MasterAPI-KEY}/client/add.output
http://api.kavenegar.com/v1/{MasterAPI-KEY}/client/update.output
http://api.kavenegar.com/v1/{MasterAPI-KEY}/client/fetch.output
http://api.kavenegar.com/v1/{MasterAPI-KEY}/client/fetchbylocalid.output
http://api.kavenegar.com/v1/{MasterAPI-KEY}/client/chargecredit.output
http://api.kavenegar.com/v1/{MasterAPI-KEY}/client/setstatus.output
http://api.kavenegar.com/v1/{MasterAPI-KEY}/client/renewkey.output
http://api.kavenegar.com/v1/{MasterAPI-KEY}/client/list.output
منظور از output نوع خروجی به دو فرمت XML و JSON است که فراخوانی متد ها توسط توسعه کنندگان مشخص میشود.
مثال
http://api.kavenegar.com/v1/{MasterAPI-KEY}/client/renewkey.json
منظور از Master-API-KEY همان شناسه اصلی حساب شما است که در بخش حساب کاربری دریافت کرده اید.
Add مشتری جدید
امکان ساخت حساب کاربری برای مشتریان که توسط آن میتوانید میزان شارژ و شناسه داخلی و نام کاربری و.. مشتری را مشخص کنید.
در واقع برای ساخت هر شناسه جدید (API-Key) میتوانید از این تابع استفاده نمائید.
ساختار URL
http://api.kavenegar.com/v1/{API_KEY}/client/add.json
پارامتر های ورودی
نام | نوع | توضیحات | وضعیت |
---|---|---|---|
localid | String |
شناسه داخلی پایگاه شما که می خواهید برای آن API-Key تولید کنید این خصوصیت بعدا به شما در واکشی اطلاعات کمک خواهد کرد | اختیاری |
Credit | Long |
میزان اعتبار اولیه که باید از اعتبار حساب شما کمتر باشد (ریال) | اختیاری |
Username | String |
نام کاربری مشتری که باید یکتا باشد . از آن میتوانید برای ورود به سیستم استفاده کرد. (راهنمائی در بخش ملاحضات) | اجباری |
password | String |
رمز عبور مشتری که درصورتی که نیاز به ورود داشته باشد از آن استفاده خواهد کرد | اجباری |
Fullname | String |
نام مشتری که از طریق آن میتوانید آن را در بین مشتریان خود شناسائی نمائید. | اجباری |
Planid | Int |
شناسه تعرفه تعریف شده در بخش مدیریت مشتریان که مایل هستید به این مشتری اختصاص یابد (در صورتی که تعرفه پیش فرض تنظیم نشده باشد این پارامتر اجباری است) | اختیاری |
Mobile | String |
شماره موبایل مشتری که حتما باید صحت داشته باشد زیرا پیامک های شما در بخش اخبار و یا اطلاع رسانی در صورت تمایل شما ارسال خواهد شد. | اختیاری |
Status | String |
وضعیت مشتری که سه حالت دارد :
|
اجباری |
Mininumallowedcredit | Int |
حداقل میزانی که این مشتری میتواند حساب خود را شارژ کند به ریال | اجباری |
Lines | String | خطوطی که مایل هستید به مشتری اختصاص داده شود که میتوانید آنها را با کاراکتر "," ویرگول از هم جدا کنید. | اختیاری |
expiredate | UnixTime | اگر متد expiredate مقدار دهی نشود تاریخ انقضا برای زیر مشتری شما قرار نمی گیرد وخروجی آن برابر 9999/12/31 قرار خواهد گرفت. | اختیاری |
پارامتر های خروجی
نام | توضیحات |
---|---|
Username | نام کاربری انتخاب شده برای این مشتری |
Localid | شناسه داخلی این مشتری که در پایگاه داده شما ذخیر شده است |
RemainCredit | اعتبار تخصیص داده شده که معال پارامتر ورودی میباشد |
Apikey | شناسه جدید (شناسه فرزند) ایجاد شده که توسط آن میتوانید اقدام به مدیریت مشتری نمائید |
Status | وضعیت مشتری که معادل پارامتر ورودی میباشد |
SMSFarsicost | قیمت هر پیامک فارسی که معادل پارامتر ورودی میباشد |
SMSEnglishcost | قیمت هر پیامک انگلیسی که معادل 2.3 تعرفه فارسی میباشد |
PricingName | نام تعرفه انتخاب شده |
ExpireDate | تاریخ انقضاء سرویس این مشتری که به صورت خودکار تمدید میشود |
LastLoginDate | تاریخ آخرین ورود این مشتری به فرمت UnixDate |
AssignedLines | خطوط اختصاص داده شده که با کاراکتر ویرگول , از هم جدا میشوند |
PwdHashed | رمز عبور Hash شده با ساختار MD5 که میتوانید برای لاگین از استفاده کنید |
Mobile | شماره موبایل این مشتری |
Mininumallowedcredit | حداقل میزانی که این مشتری میتواند حساب خود را شارژ کند |
توجه نمائید که کلیه متد های مربوط به مدیریت مشتریان خروجی همانند این شی خواهند داشت
یادداشت
- در صورتی که expiredate مقدار داشته باشد سرویس مشتری در تاریخ مورد نظر غیر فعال خواهد شد و به معنای این است که اجرای متدهای وب سرویس را نخواهند داشت.
درخواست
http://api.kavenegar.com/v1/24631363144694172773952773FGH324234DSF123123SSDFSDFG/client/add.json?Username=Customer&password=159753&Fullname=reza Mohamadi&Planid=1484&Mobile=09125258596&&Status=1
پاسخ
{ "return": { "status": 200, "message": "تایید شد" }, "entries": { "remaincredit": 0, "expiredate": 0, "apikey": "JKDSDS462B5348686D5172577DSFSDF34", "fullname": "Reza Mohammadi", "username": "Customer", "pricingname": "Price", "smsfarsicost": "150", "smsenglishcost": "360", "calllocalcost": "37", "lastlogindate": 1559137140, "mininumallowedcredit": 100000, "status": "Approved", "pwdhashed": "8ASDPO234UIY324SFSDGDFH54645634", "mobile": "09125258596", "localid": "" } }
Updateویرایش اطلاعات مشتری
برای ویرایش اطلاعات مشتریان میتوانید از این تابع استفاده نمائید.
نکته : در ویرایش کافیست فقط مقادیری که میخواهید ویرایش شوند را ارسال نمائید و در صورتی که پارامتری نباید ویرایش شود کافیست آن را در فراخوانی متد ارسال نکنید.
قابل توجه است که مقدار
LocalId
و
API-Key
در این متد قابل ویرایش نیست.
هدف از ارسال API-Key فرزند به منظور شناسائی مشتری مورد نظر است . در واقع همان شناسه ای است که در هنگام ساخت مشتری به عنوان شناسه فرزند دریافت کرده اید.
کلیه پارامتر های این متد انتخابی است و در صورتی که مقدار دهی شوند ویرایش خواهند شد.
ساختار URL
http://api.kavenegar.com/v1/{API_KEY}/client/update.json
پارامتر های ورودی
نام | نوع | توضیحات | وضعیت |
---|---|---|---|
localid | String |
شناسه داخلی پایگاه شما که می خواهید برای آن API-Key تولید کنید این خصوصیت بعدا به شما در واکشی اطلاعات کمک خواهد کرد | اختیاری |
Username | String | نام کاربری مشتری که باید یکتا باشد. از آن میتوانید برای ورود به سیستم استفاده کرد. | اختیاری |
Password | String | رمز عبور جدید مشتری برای ورود به سیستم. | اختیاری |
Apikey | String | API-Key مشتری که مایل به ویرایش اطلاعات آن هستید. | اجباری |
Fullname | String | نام مشتری که از طریق آن میتوانید آن را در بین مشتریان خود شناسائی نمائید. | اختیاری |
Mobile | Int | شماره موبایل مشتری که حتما باید صحت داشته باشد زیرا پیامک های شما در بخش اخبار و یا اطلاع رسانی در صورت تمایل شما ارسال خواهد شد | اختیاری |
Status | Byte |
وضعیت مشتری که سه حالت دارد :
|
اختیاری |
expiredate | UnixTime | اگر متد expiredate مقدار دهی نشود تاریخ انقضا برای زیر مشتری شما قرار نمی گیرد وخروجی آن برابر 9999/12/31 قرار خواهد گرفت. | اختیاری |
پارامتر های خروجی
نام | توضیحات |
---|---|
Username | نام کاربری انتخاب شده برای این مشتری |
Localid | شناسه داخلی این مشتری که در پایگاه داده شما ذخیر شده است |
RemainCredit | اعتبار تخصیص داده شده که معال پارامتر ورودی میباشد |
Apikey | شناسه جدید (شناسه فرزند) ایجاد شده که توسط آن میتوانید اقدام به مدیریت مشتری نمائید |
Status | وضعیت مشتری که معادل پارامتر ورودی میباشد |
SMSFarsicost | قیمت هر پیامک فارسی که معادل پارامتر ورودی میباشد |
SMSEnglishcost | قیمت هر پیامک انگلیسی که معادل 2.3 تعرفه فارسی میباشد |
PricingName | نام تعرفه انتخاب شده |
ExpireDate | تاریخ انقضاء سرویس این مشتری که به صورت خودکار تمدید میشود |
LastLoginDate | تاریخ آخرین ورود این مشتری به فرمت UnixDate |
AssignedLines | خطوط اختصاص داده شده که با کاراکتر ویرگول , از هم جدا میشوند |
PwdHashed | رمز عبور Hash شده با ساختار MD5 که میتوانید برای لاگین از استفاده کنید |
Mobile | شماره موبایل این مشتری |
Mininumallowedcredit | حداقل میزانی که این مشتری میتواند حساب خود را شارژ کند |
یادداشت
- در صورتی که expiredate مقدار داشته باشد سرویس مشتری در تاریخ مورد نظر غیر فعال خواهد شد و به معنای این است که اجرای متدهای وب سرویس را نخواهند داشت.
درخواست
http://api.kavenegar.com/v1/24631363144694172773952773FGH324234DSF123123SSDFSDFG/client/update.json?Apikey=JKDSDS462B5348686D5172577DSFSDF34&Username=Customer1&Fullname=AliReza Mohammadi&Password=10203040&Mobile=09125258596
پاسخ
{ "return": { "status": 200, "message": "تایید شد" }, "entries": { "remaincredit": 0, "expiredate": 0, "apikey": "JKDSDS462B5348686D5172577DSFSDF34", "fullname": "AliReza Mohammadi", "username": "Customer", "pricingname": "Price", "smsfarsicost": "150", "smsenglishcost": "360", "calllocalcost": "37", "lastlogindate": 1559137140, "mininumallowedcredit": 100000, "status": "Approved", "pwdhashed": "8765ASFSDKJG645634", "mobile": "09125258596", "localid": "" } }
واکشی و فراخوانی اطلاعات مشتریFetch
برای دریافت اطلاعات حساب مشتری میتوانید از این تابع استفاده نمائید.
ساختار URL
http://api.kavenegar.com/v1/{API_KEY}/client/fetch.json
پارامتر های ورودی
نام | نوع | توضیحات | وضعیت |
---|---|---|---|
Apikey | String | شناسه مشتری که مایل به واکشی اطلاعات آن هستید | اجباری |
پارامتر های خروجی
نام | توضیحات |
---|---|
Username | نام کاربری انتخاب شده برای این مشتری |
Localid | شناسه داخلی این مشتری که در پایگاه داده شما ذخیر شده است |
RemainCredit | اعتبار تخصیص داده شده که معال پارامتر ورودی میباشد |
Apikey | شناسه جدید (شناسه فرزند) ایجاد شده که توسط آن میتوانید اقدام به مدیریت مشتری نمائید |
Status | وضعیت مشتری که معادل پارامتر ورودی میباشد |
SMSFarsicost | قیمت هر پیامک فارسی که معادل پارامتر ورودی میباشد |
SMSEnglishcost | قیمت هر پیامک انگلیسی که معادل 2.3 تعرفه فارسی میباشد |
PricingName | نام تعرفه انتخاب شده |
ExpireDate | تاریخ انقضاء سرویس این مشتری که به صورت خودکار تمدید میشود |
LastLoginDate | تاریخ آخرین ورود این مشتری به فرمت UnixDate |
AssignedLines | خطوط اختصاص داده شده که با کاراکتر ویرگول , از هم جدا میشوند |
PwdHashed | رمز عبور Hash شده با ساختار MD5 که میتوانید برای لاگین از استفاده کنید |
Mobile | شماره موبایل این مشتری |
Mininumallowedcredit | حداقل میزانی که این مشتری میتواند حساب خود را شارژ کند |
درخواست
http://api.kavenegar.com/v1/24631363144694172773952773FGH324234DSF123123SSDFSDFG/client/fetch.json?apikey=JKDSDS462B5348686D5172577DSFSDF34
بدنه پاسخ
{ "return": { "status": 200, "message": "تایید شد" }, "entries": { "remaincredit": 0, "expiredate": 0, "apikey": "JKDSDS462B5348686D5172577DSFSDF34", "fullname": "Reza Mohammadi", "username": "Customer", "pricingname": "Price", "smsfarsicost": "150", "smsenglishcost": "360", "calllocalcost": "37", "lastlogindate": 1559137140, "mininumallowedcredit": 100000, "status": "Approved", "pwdhashed": "8765ASFSD8758LKH645634", "mobile": "09125258596", "localid": "" } }
ChargeCreditمدیریت شارژ مشتری
از طریق این متد میتوانید اقدام به افزایش یا کاهش اعتبار ریالی مشتری نمائید.
در صورتی که مایل به افزایش باشید یک فاکتور بدهکار برای شما صادر میشود و یه فاکتور بستانکار برای مشتری مورد نظر و اعتبار از حساب شما کسر و به حساب مشتری اضافه میشود.
در صورتی که مایل به کاهش باشید این اتفاق بلعکس رخ خواهد داد.
قابل توجه است درصورتی که حساب شما به میزان کافی اعتبار ریالی نداشته باشد با خطای
418
به معنای اعتبار شما کافی نمیباشد روبرو می شوید.
بعد از افزایش اعتبار سود حاصل از آن طی فاکتوری در لیست تراکنش های مالی شما قابل دسترس خواهد بود که به اعتبار حساب شما اضافه میشود و
همچنین فاکتوری برای زیر مشتری صادر خواهد شدکه در آن مبلغ و نحوه انتقال اعتبار قابل مشاهده خواهد بود.
ساختار URL
http://api.kavenegar.com/v1/{API_KEY}/client/chargecredit.json
پارامتر های ورودی
نام | نوع | توضیحات | وضعیت |
---|---|---|---|
Apikey | String |
شناسه API-Key مشتری که مایل به افزایش اعتبارش هستید. | اجباری |
Credit | Long |
میزان اعتبار ریال | اجباری |
Desc | String |
توضیح این تراکنش که توسط مشتری قابل مشاهده خواهد بود. | اختیاری |
vat | Bool |
به منظور محاسبه ارزش افزوده در این تراکنش (0 یا 1) | اختیاری |
یادداشت
- برای کاهش اعتبار حساب میزان اعتبار را منفی وارد نمائید
- میزان اعتبار نباید کمتر از 1000 ریال برای افزایش و کمتر 1000- ریال برای کاهش باشد
- شما میتوانید بعد از اجرای این متد اقدام به فراخوانی متد info نمائید تا میزان اعتبار مشتری را در واسط کاربری آن بروز کنید
- در صورتی که مایل به تغییر تعرفه مشتری بودید میتوانید با این متد کل اعتبار مشتری را از او بگیرد و بعد از تغییر تعرفه دوباره مبلغ را برای آن با افزایش اعتبار انجام دهید
پارامتر های خروجی
نام | توضیحات |
---|---|
Username | نام کاربری انتخاب شده برای این مشتری |
Localid | شناسه داخلی این مشتری که در پایگاه داده شما ذخیر شده است |
RemainCredit | اعتبار تخصیص داده شده که معال پارامتر ورودی میباشد |
Apikey | شناسه جدید (شناسه فرزند) ایجاد شده که توسط آن میتوانید اقدام به مدیریت مشتری نمائید |
Status | وضعیت مشتری که معادل پارامتر ورودی میباشد |
SMSFarsicost | قیمت هر پیامک فارسی که معادل پارامتر ورودی میباشد |
SMSEnglishcost | قیمت هر پیامک انگلیسی که معادل 2.3 تعرفه فارسی میباشد |
PricingName | نام تعرفه انتخاب شده |
ExpireDate | تاریخ انقضاء سرویس این مشتری که به صورت خودکار تمدید میشود |
LastLoginDate | تاریخ آخرین ورود این مشتری به فرمت UnixDate |
AssignedLines | خطوط اختصاص داده شده که با کاراکتر ویرگول , از هم جدا میشوند |
PwdHashed | رمز عبور Hash شده با ساختار MD5 که میتوانید برای لاگین از استفاده کنید |
Mobile | شماره موبایل این مشتری |
Mininumallowedcredit | حداقل میزانی که این مشتری میتواند حساب خود را شارژ کند |
درخواست
http://api.kavenegar.com/v1/24631363144694172773952773FGH324234DSF123123SSDFSDFG/client/chargecredit.json?apikey=JKDSDS462B5348686D5172577DSFSDF34&Credit=25000
بدنه پاسخ
{ "return": { "status": 200, "message": "تایید شد" }, "entries": { "remaincredit": 25000, "expiredate": 0, "apikey": "JKDSDS462B5348686D5172577DSFSDF34", "fullname": "Reza Mohammadi", "username": "Customer", "pricingname": "Price", "smsfarsicost": "150", "smsenglishcost": "360", "calllocalcost": "37", "lastlogindate": 1559137140, "mininumallowedcredit": 100000, "status": "Approved", "pwdhashed": "8765ASFSDGF87685DFH54645634", "mobile": "09125258596", "localid": "" } }
تغییر وضعیت حساب کاربری SetStatus
گاهی اوقات نیاز دارید تا حساب برخی از مشتریان خود را غیرفعال یا فعال و یا امکان ورود به سیستم را برای آنها محدود کنید . این متد برای همین عملیات طراحی شده است.
پارامتر های ورودی
نام | نوع | توضیحات | وضعیت |
---|---|---|---|
ApiKey | String | شناسه API-Key مشتری | اجباری |
Status | Integer |
وضعیت این مشتری که سه حالت دارد : 0 غیر فعال 1 فعال با امکان ورود به سیستم 2 فعال بدون امکان ورود به سیستم |
اجباری |
ساختار URL
http://api.kavenegar.com/v1/{API_KEY}/client/setstatus.json
پارامتر های خروجی
نام | توضیحات |
---|---|
Username | نام کاربری انتخاب شده برای این مشتری |
Localid | شناسه داخلی این مشتری که در پایگاه داده شما ذخیر شده است |
RemainCredit | اعتبار تخصیص داده شده که معال پارامتر ورودی میباشد |
Apikey | شناسه جدید (شناسه فرزند) ایجاد شده که توسط آن میتوانید اقدام به مدیریت مشتری نمائید |
Status | وضعیت مشتری که معادل پارامتر ورودی میباشد |
SMSFarsicost | قیمت هر پیامک فارسی که معادل پارامتر ورودی میباشد |
SMSEnglishcost | قیمت هر پیامک انگلیسی که معادل 2.3 تعرفه فارسی میباشد |
PricingName | نام تعرفه انتخاب شده |
ExpireDate | تاریخ انقضاء سرویس این مشتری که به صورت خودکار تمدید میشود |
LastLoginDate | تاریخ آخرین ورود این مشتری به فرمت UnixDate |
AssignedLines | خطوط اختصاص داده شده که با کاراکتر ویرگول , از هم جدا میشوند |
PwdHashed | رمز عبور Hash شده با ساختار MD5 که میتوانید برای لاگین از استفاده کنید |
Mobile | شماره موبایل این مشتری |
Mininumallowedcredit | حداقل میزانی که این مشتری میتواند حساب خود را شارژ کند |
درخواست
http://api.kavenegar.com/v1/24631363144694172773952773FGH324234DSF123123SSDFSDFG/client/setstatus.json?apikey=JKDSDS462B5348686D5172577DSFSDF34&Status=1
بدنه پاسخ
{ "return": { "status": 200, "message": "تایید شد" }, "entries": { "remaincredit": 25000, "expiredate": 0, "apikey": "JKDSDS462B5348686D5172577DSFSDF34", "fullname": "Reza Mohammadi", "username": "Customer", "pricingname": "Price", "smsfarsicost": "150", "smsenglishcost": "360", "calllocalcost": "37", "lastlogindate": 1559137140, "mininumallowedcredit": 100000, "status": "Approved", "pwdhashed": "8765ASFSDGDFH54645634KGK", "mobile": "09125258596", "localid": "" } }
تغییر کلید شناسائیReNewKey
در برخی موارد مانند واضح شدن (لو رفتن ) کلید شناسائی مشتری (Child-API-KEY) و یا تغییر در برخی از ساختار های دسترسی و .. نیاز دارید تا این شناسه تغییر و دوباره توسط سیستم ایجاد شود.
ساختار URL
http://api.kavenegar.com/v1/{API_KEY}/client/renewkey.json
پارامتر های ورودی
نام | نوع | توضیحات | وضعیت |
---|---|---|---|
Apikey | String |
شناسه API-Key مشتری که مایل به تغییر آن هستید | اجباری |
localid | String |
شناسه داخلی مشتری که درهنگام ساخت ارسال کرده اید و در صورتی که API-Key مشتری در درسترس شما نباشد متوانید از این پارامتر استفاده نمائید . | اختیاری |
پارامتر های خروجی
نام | توضیحات |
---|---|
Username | نام کاربری انتخاب شده برای این مشتری |
Localid | شناسه داخلی این مشتری که در پایگاه داده شما ذخیر شده است |
RemainCredit | اعتبار تخصیص داده شده که معال پارامتر ورودی میباشد |
Apikey | شناسه جدید (شناسه فرزند) ایجاد شده که توسط آن میتوانید اقدام به مدیریت مشتری نمائید |
Status | وضعیت مشتری که معادل پارامتر ورودی میباشد |
SMSFarsicost | قیمت هر پیامک فارسی که معادل پارامتر ورودی میباشد |
SMSEnglishcost | قیمت هر پیامک انگلیسی که معادل 2.3 تعرفه فارسی میباشد |
PricingName | نام تعرفه انتخاب شده |
ExpireDate | تاریخ انقضاء سرویس این مشتری که به صورت خودکار تمدید میشود |
LastLoginDate | تاریخ آخرین ورود این مشتری به فرمت UnixDate |
AssignedLines | خطوط اختصاص داده شده که با کاراکتر ویرگول , از هم جدا میشوند |
PwdHashed | رمز عبور Hash شده با ساختار MD5 که میتوانید برای لاگین از استفاده کنید |
Mobile | شماره موبایل این مشتری |
Mininumallowedcredit | حداقل میزانی که این مشتری میتواند حساب خود را شارژ کند |
درخواست
http://api.kavenegar.com/v1/24631363144694172773952773FGH324234DSF123123SSDFSDFG/client/renewkey.json?apikey=JKDSDS462B5348686D5172577DSFSDF34
بدنه پاسخ
{ "return": { "status": 200, "message": "تایید شد" }, "entries": { "remaincredit": 25000, "expiredate": 0, "apikey": "SSDG65644KF64HFFD87584KFYT985987545", "fullname": "Reza Mohammadi", "username": "Customer", "pricingname": "Price", "smsfarsicost": "150", "smsenglishcost": "360", "calllocalcost": "37", "lastlogindate": 1559137140, "mininumallowedcredit": 100000, "status": "Approved", "pwdhashed": "8765ASFSDGDFsdH54645634", "mobile": "09125258596", "localid": "" } }
واکشی اطلاعات با شناسه داخلیFetchByLocalid
برای دریافت اطلاعات حساب مشتری با استفاده از Localid که در زمان ثبت نام ارسال کرده اید میتوانید از این تابع استفاده نمائید.
ساختار URL
http://api.kavenegar.com/v1/{API_KEY}/client/fetchbylocalid.json
پارامتر های ورودی
نام | نوع | توضیحات | وضعیت |
---|---|---|---|
Localid | String |
شناسه داخلی مشتری که در پایگاه داده شما ثبت شده است که مایل به واکشی اطلاعات آن هستید | اجباری |
پارامتر های خروجی
نام | توضیحات |
---|---|
Username | نام کاربری انتخاب شده برای این مشتری |
Localid | شناسه داخلی این مشتری که در پایگاه داده شما ذخیر شده است |
RemainCredit | اعتبار تخصیص داده شده که معال پارامتر ورودی میباشد |
Apikey | شناسه جدید (شناسه فرزند) ایجاد شده که توسط آن میتوانید اقدام به مدیریت مشتری نمائید |
Status | وضعیت مشتری که معادل پارامتر ورودی میباشد |
SMSFarsicost | قیمت هر پیامک فارسی که معادل پارامتر ورودی میباشد |
SMSEnglishcost | قیمت هر پیامک انگلیسی که معادل 2.3 تعرفه فارسی میباشد |
PricingName | نام تعرفه انتخاب شده |
ExpireDate | تاریخ انقضاء سرویس این مشتری که به صورت خودکار تمدید میشود |
LastLoginDate | تاریخ آخرین ورود این مشتری به فرمت UnixDate |
AssignedLines | خطوط اختصاص داده شده که با کاراکتر ویرگول , از هم جدا میشوند |
PwdHashed | رمز عبور Hash شده با ساختار MD5 که میتوانید برای لاگین از استفاده کنید |
Mobile | شماره موبایل این مشتری |
Mininumallowedcredit | حداقل میزانی که این مشتری میتواند حساب خود را شارژ کند |
درخواست
http://api.kavenegar.com/v1/24631363144694172773952773FGH324234DSF123123SSDFSDFG/client/fetchbylocalid.json?
بدنه پاسخ
{ "return": { "status": 200, "message": "تایید شد" }, "entries": { "remaincredit": 25000, "expiredate": 0, "apikey": "SSDG65644KF64HFFD87584KFYT985987545", "fullname": "Reza Mohammadi", "username": "Customer", "pricingname": "Price", "smsfarsicost": "150", "smsenglishcost": "360", "calllocalcost": "37", "lastlogindate": 1559137140, "mininumallowedcredit": 100000, "status": "Approved", "pwdhashed": "8765ASFSDGDFsdH54645634", "mobile": "09125258596", "localid": "" } }
فهرست مشتریان List
با استفاده از این متد شما می توانید لیست تمامی کاربران خود را مشاهده نمائید.
ساختار URL
http://api.kavenegar.com/v1/{API_KEY}/client/list.json
پارامتر های خروجی
نام | توضیحات |
---|---|
Username | نام کاربری انتخاب شده برای این مشتری |
Localid | شناسه داخلی این مشتری که در پایگاه داده شما ذخیر شده است |
RemainCredit | اعتبار تخصیص داده شده که معال پارامتر ورودی میباشد |
Apikey | شناسه جدید (شناسه فرزند) ایجاد شده که توسط آن میتوانید اقدام به مدیریت مشتری نمائید |
Status | وضعیت مشتری که معادل پارامتر ورودی میباشد |
SMSFarsicost | قیمت هر پیامک فارسی که معادل پارامتر ورودی میباشد |
SMSEnglishcost | قیمت هر پیامک انگلیسی که معادل 2.3 تعرفه فارسی میباشد |
PricingName | نام تعرفه انتخاب شده |
ExpireDate | تاریخ انقضاء سرویس این مشتری که به صورت خودکار تمدید میشود |
LastLoginDate | تاریخ آخرین ورود این مشتری به فرمت UnixDate |
AssignedLines | خطوط اختصاص داده شده که با کاراکتر ویرگول , از هم جدا میشوند |
PwdHashed | رمز عبور Hash شده با ساختار MD5 که میتوانید برای لاگین از استفاده کنید |
Mobile | شماره موبایل این مشتری |
Mininumallowedcredit | حداقل میزانی که این مشتری میتواند حساب خود را شارژ کند |
درخواست
http://api.kavenegar.com/v1/24631363144694172773952773FGH324234DSF123123SSDFSDFG/client/list.json?
بدنه پاسخ
{ "return": { "status": 200, "message": "تایید شد" }, "entries": { "remaincredit": 25000, "expiredate": 0, "apikey": "SSDG65644KF64HFFD87584KFYT985987545", "fullname": "Reza Mohammadi", "username": "Customer", "pricingname": "Price", "smsfarsicost": "150", "smsenglishcost": "360", "calllocalcost": "37", "lastlogindate": 1559137140, "mininumallowedcredit": 100000, "status": "Approved", "pwdhashed": "8765ASFSDGDFH54645634", "mobile": "09125258596", "localid": "10050" }, { "remaincredit": 0, "expiredate": 0, "apikey": "SSDG65644KF64HFFD8234234247584KFYT985987545", "fullname": "رضا", "username": "Customer1", "pricingname": "test1", "smsfarsicost": "180", "smsenglishcost": "432", "calllocalcost": "45", "lastlogindate": 1484399580, "mininumallowedcredit": 500000, "status": "Removed", "pwdhashed": "8765ASFSDGDFH546456", "mobile": "09123821388" } }
فهرست کدهای برگشتی
کد | توضیحات |
---|---|
200 |
درخواست تایید شد |
400 |
پارامترها ناقص هستند |
401 |
حساب کاربری غیرفعال شده است |
402 |
عملیات ناموفق بود |
403 |
کد شناسائی ( API KEY ) یا اطلاعات ورود (نام کاربری و رمز عبور ) معتبر نمیباشد. |
409 |
سرور قادر به پاسخگوئی نیست بعدا تلاش کنید |
411 |
دریافت کننده نامعتبر است |
412 |
ارسال کننده نامعتبر است |
413 |
پیام خالی است و یا طول پیام بیش از حد مجاز میباشد. لاتین 612 ﻛﺎراﻛﺘﺮ و ﻓﺎرﺳﻲ 268 ﻛﺎراﻛﺘﺮ |
414 |
تعداد رکورد ها بیشتر از حد مجاز است . در هر فراخوانی حداکثر 200 رکورد . |
417 |
تاریخ معتبر نمیباشد. مقدار 0 به معنای زمانی فعلی است و در غیر اینصورت فرمتUNIXTIME |
418 |
اعتبار حساب شما کافی نیست. لطفا برای شارژ حساب اقدام نمائید. |
419 |
طول آرایه متن و گیرنده ها و فرستنده ها هم اندازه نیست . |
502 |
نام کاربری انتخاب شده تکراری میباشد. |
503 |
شناسه داخلی انتخاب شده تکراری است (localid) |
504 |
تعرفه ارسال پیامک ارزان تر از تعرفه والد میباشد. |
505 |
سرویس والد منقضی شده است.(در صورتی مدت سرویس ویژه شما به اتمام رسیده باشد با این خطا روبرو خواهید شد) |
506 |
تغییر تعرفه در صورتی مانده اعتبار کمتر از 1000 ریال باشد امکان پذیر است. |
507 |
شماره موبایل انتخاب شده تکراری است |
601 |
کلید تعیین شده در ساختار پیام خودکار تکراری است |
602 |
نام الگوی اعتبار سنجی تکراری است |
603 |
امکان تعریف منشی پیامکی بروی این خط برای شما امکان پذیر نیست |