همان طور که شاید تا به حال شنیده باشید API مخفف عبارت
Application Programming Interface
میباشد که به برنامه نویسان امکان رد و بدل کردن اطلاعات مابین پلتفرم های مختلف را از طریق ارسال یک درخواست
HTTP(S)
ساده و فراخوانی متد های مورد نظر میدهد
در واقع REST یک روش ساده و انعطاف پذیری برای استفاده از API
است
و البته محبوب ترین و پر کاربرد ترین که میتوان توسط این ساختار
از هر کلاینت و پلتفرمی درخواست ساده
HTTP(S)
را ارسال و پاسخ آن را دریافت نمود.
حال فرض کنید در خواست مورد نظر اطلاعات مربوط به ارسال یک پیامک باشد و جواب آن نتیجه و وضعیت پیامک ارسالی باشد.
وب سرویس ارسال پیامک
کاوه نگار
شماره گیرنده ، متن پیامک و شماره فرستنده را از طریق پارامتر های ورودی در متد
GET یا POST
دریافت میکند و خروجی را در قالب فرمت های
XML و JSON
برگشت میدهد.
نکته : اگر با JSON آشنائی ندارید میتوانید با مراجعه به سایت
json.org
هم از ساختار فرمت آن مطلع شوید و هم درایور مربوط به زبان برنامه نویسی مورد نظر خود را دریافت نمائید.
شروع
قبل از آن که در مورد ساختار خروجی متد ها توضیح دهیم این متد را باهم اجرا کنیم :
در صورتی که مایل هستید بافرمت XML خروجی را دریافت کنید کافیست پسوند آدرس مورد نظر را از JSON به XML تغییر دهید.
این متد تاریخ و زمان سرور کاوه نگار و همچنین زمان معادل آن به فرمت
UnixTime را به شما نشان می دهد.
کلیه فیلدهای مربوط به تاریخ در وب سرویس کاوه نگار به فرمت
UnixTime
میباشد.
دلیل استفاده از این فرمت جلوگیری از بروز خطا در هنگام پردازش آنهاست.
برای آشنائی با فرمت UnixTime میتوانید به
اینجا
مراجعه کنید
و همچنین نمونه کد تبدیل آن را برای زبان های برنامه نویسی مختلف از
اینجا
دریافت کنید.
در صورتی که برای تست وب سرویس کاوه نگار
API-KEY
ندارید میتوانید از این بخش
ثبت نام
کنید و ۱۰,۰۰۰ ریال هم اعتبار هدیه دریافت کنید.
شناسائی و اعتبار سنجی حساب
کاربری
Authorization
در سرویس کاوه نگار توسط
رشته
API-KEY
انجام میشود.
فراخوانی متد ها از طریق لایه SSL
امکان پذیر است.
خطا های مربوط به حساب کاربری
401
حساب کاربری غیر فعال است
403
حساب کاربری معتبر نمیباشد. این خطا در صورتی که کد شناسائی API-Key اشتباه ارسال شود رخ میدهد
ساختار خروجی
مسلما بعد از اجرای هر متد نیاز است نتیجه حاصل از اجرای آن را دریافت و پردازش کنید.
سرویس کاوه نگار برای سهولت این موضوع از دو فرمت خروجی رایج
JSON
و
XML
استفاده نموده است.
نتیجه حاصل از فراخوانی متد را توسط جدول کدهای برگشتی در
Http Status Code
برگشت داده میشود.
برای مثال در صورتی که متد مورد نظر وجود نداشته باشد مقدار
404
در
Status Code
قرار میگیرد.
علاوه بر آن ساختار خروجی هم این خطا را نشان میدهد برای مثال به خروجی زیر لطفا توجه نمائید.
Status :
کد حاصل از اجرای متد که نشان دهنده اجرای موفق یا ناموفق آن است. در صورتی که مقدار آن
200
باشد به معنای اجرای درست متد است
و در غیر اینصورت باید به جدول
شماره 1 کدهای برگشتی
مراجعه نمائید.
Message :
توضیح مربوط به کد میباشد.
خطا های احتمالی در هنگام اجرای متد ها
400
پارامترها ناقص هستند
402
عملیات ناموفق بود
404
متدی با این نام پیدا نشده است
405
متد
فراخوانی
Get یا Post
اشتباه است
409
سرور قادر به پاسخگوئی نیست بعدا تلاش کنید
ساختار پیام کوتاه
طول پیامک
طول استاندارد یک پیام کوتاه 140 ﺑﺎﻳﺖ که معادل 70 کاراکتر برای یک پیامک فارسی و 140 کاراکتر برای یک پیامک لاتین و 140 بایت برای پیامک باینری میباشد بنابراین هر کاراکتر فارسی معادل 2 بایت محاسبه میشود. این موضوع به دلیل گنجاندن کاراکتر های فارسی در فرمت یونیکد میباشد که با وجود حتی یک کاراکتر فارسی در پیامک باعث میشود تا طول آن بر حسب فرمت یونیکد (هر کاراکتر 2 بایت) محاسبه شده و پیامک فارسی شود (پیامک های فارسی ارزان تر از پیامک های لاتین هستند).
پیامک های چند بخشی
در صورتی که پیامک از طول استاندارد 140 بایت بیشتر شود باید به بخش های 140 بایتی تقسیم شده و سپس به مقصد ارسال شود که البته این کار توسط وب سرویس موجود انجام میشود و نیاز نیست برای این موضوع عملیاتی انجام دهید کافیست کل پیام را در فراخوانی وب سرویس ارسال نمائید. البته به این موضوع باید توجه داشت که به ازای هر بخش از یک پیامک فارسی طولانی، 3 کاراکتر و به ازای هر بخش از کی پیامک لاتین طولانی ،7 کاراکتر از فضای استاندارد متین پیامک به کد UDH اختصاص پیدا میکند.یعنی در واقع هر بخش از پیامک چند قسمتی فارسی حداکثر 67 کاراکتروهربخش ازپیامک چند قسمتی لاتین حداکثر 153 کاراکتررادرخودجای میدهد.
ﺣﺪاﻛﺜﺮ ﻃﻮل پیامک
حداکثر طول کل متن پیامک 900 کاراکتر می باشد. درصورتی که بیشتر از این مقدار ارسال شود مقدار پارامتر Status معادل 413 به معنای "متن پیام خالی است و یا طول آن بیشتر از حد مجاز میباشد" را برگشت میدهد. علاوه بر این موضوع در هر بار فراخوانی متدهای ارسال پیامک میتوانید حداکثر 200 پیامک ارسال کنید. این محدودیت برای حفظ کیفیت در ارسال و سرعت پاسخگوئی قرارداده شده است همچنین در هر بار فراخوانی متدهای کنترل وضعیت Status و انصراف از ارسال پیامک Cancel میتوانید حداکثر 500 شناسه را در ورودی قرار دهید.
خطای مربوط به حداکثر رکورد درخواستی در هر بار فراخوانی
414
حجم درخواست بیشتر از حد مجاز است
در ارسال پیامک هر فراخوانی
200 رکورد و کنترل وضعیت
هر فراخوانی 500 رکورد
توجه :
شما میتوانید با فراخوانی متد ها از طریق ساختار
Multi-Threaded
میزان درخواست همزمان خود را افزایش دهید.
موضوع محدودیت مربوط به تعداد در هر بار فراخوانی
(Per Request)
میباشد.
فرمت داده های ورودی
در طراحی وب سرویس کاوه نگار سعی شده تا جای ممکن نسبت به داده های ورودی حساسیت وجود نداشته باشد در نهایت پارامتر ها با فرمت زیر قابل تشخیص هستند در غیر اینصورت احتمال دریافت کد خطا در داده های ورودی وجود دارد.
در هنگام ارسال درخواست با متد
HTTP GET حتما مقدار پارامتر ها را
URL Encode
نمائید.
فرمت درست خط اختصاصی فرستنده
(این شماره به عنوان مثال قید شده است)
+9810004346
009810004346
10004346
فرمت درست شماره گیرنده
(این شماره به عنوان مثال قید شده است)
خطاهای مربوط به فرمت اشتباه گیرنده و فرستنده و متن پیامک
411
شماره گیرنده پیام معتبر نمی باشد
412
شماره فرستنده معتبر نمیباشد
413
پیام خالی است و یا طول پیام بیش از حد مجاز میباشد
حداکثر طول کل متن پیامک 900 کاراکتر می باشد
414
تعداد رکورد ها بیشتر از حد مجاز است
در ارسال پیامک حداکثر
200
گیرنده در کنترل وضعیت حداکثر
500
شناسه
Sendارسال ساده
از این متد برای ارسال پیامک استفاده می کنیم که
امکان ارسال یک پیامک خاص به چندین گیرنده
(Receptor)
در این متد وجود دارد کافیست آنها را از طریق کاراکتر ویرگول « , » از هم جدا کنید.
اگر میخواهید چندین پیامک مختلف را از شماره های مختلف ارسال کنید ، این متد کارائی زیادی برای شما دارد.
نکته قابل توجه در استفاده از این متد آن است که مقادیر به صورت آرایه
(فرمت Json)
دریافت می شوند و باید تعداد اجزا آرایه ها با هم برابر باشد.
برای مثال :
3 ارسال کننده، 3 پیام، 3 گیرنده،
علاوه بر این متد فراخوانی حتما باید POST باشد.
پارامترهای ورودی
receptor
اجباری
Array of String
شماره های دریافت کنندگان پیام
sender
اجباری
Array of String
شماره خط های ارسال کننده پیام
message
اجباری
Array of String
متن پیام کوتاه ، بهتر است هر متن پیامک را در حالت POST حتما HTML-Encode شود
،
برای بحث
(Delimeters)
پیامک ها بعد از ارسال از طریق وب سرویس،
وضعیت
در صف
خواهند داشت ، در کمتر از 1 ثانیه
به مخابرات تحویل داده میشوند
و وضعیت ارسال به مخابرات را خواهند گرفت
،
بعد از 5 دقیقه از زمان تحویل به مخابرات تا زمانی که وضعیت آنها تغییر نکند دائما کنترل میشوند
،
در نهایت
پیامک های ارسالی یکی از مقادیر
جدول 2 وضعیت پیامک ها
را خواهند داشت.
از این تابع برای کنترل وضعیت رسید
Delivery
پیامک استفاده میشود.
برای این منظور باید شناسه یکتای هر پیامک
messageid
را که در هنگام ارسال پیامک از خروجی دریافت کرده اید را
ارسال نمائید.
در هر بار اجرای این متد میتوانید از وضعیت ۵۰۰ پیامک با خبر شوید.
کافیست شناسه یکتای پیامک ها را از طریق کاراکتر ویرگول
« , »
از هم جدا کنید.
شما علاوه بر واکشی وضعیت پیامک های ارسال توسط
متد
Status
،میتوانید توسط پارامتر
localid
که در هنگام ارسال پیامک پاس داده اید هم وضعیت پیامک ها را واکشی نمائید،
ساختار خروجی این متد همانند متد
Status
میباشد.
ممکن است به هر دلیلی ساختار پایگاه داده شما به نحوی باشد که توانائی
ذخیره سازی
شناسه یکتای پیامک
messageid
را نداشته باشید،
آنگاه برای واکشی وضعیت پیامک های ارسالی میتوانید از این متد استفاده نمائید.
در نهایت
پیامک های ارسالی یکی از مقادیر
جدول 2 وضعیت پیامک ها
را خواهند داشت.
در هر بار اجرای این متد میتوانید از وضعیت 3،000 پیامک با خبر شوید.
کافیست شناسه محلی پیامک ها
localid
را از طریق کاراکتر ویرگول
« , »
از هم جدا کنید.
در صورتی که میخواهید اطلاعات
پیامک ارسالی
را بازیابی نمائید،
میتوانید با
messageid
و استفاده از این متد
اطلاعات رکورد را دریافت کنید.
در هر بار اجرای این متد میتوانید از وضعیت ۵۰۰ پیامک با خبر شوید.
کافیست شناسه یکتای پیامک ها را از طریق کاراکتر ویرگول
« , »
از هم جدا کنید.
پارامترهای ورودی
messageid
اجباری
Long
شناسه پیام مورد نظر، می تواند چندین شناسه را
با کاراکتر ویرگول
« , »
از هم جدا کنید
در صورتی که شناسه پیامک
messageid
معتبر نباشد یا متعلق به شما نباشد مقدار فیلد
status=100
خواهد بود، معادل معتبر نبودن
تفاوت این متد با متد
status
در نوع خروجی است ، این متد اطلاعات بیشتر همراه خود دارد ولی بهتر است برای کنترل وضعیت
پیامک از متد
status
استفاده کنید زیرا حجم اطلاعات خروجی کمتر و سرعت آن بیشتر
است
برای استفاده از این متد اقدام به تنظیم IP در بخش تنظیمات امنیتی نمایید
خطاها
400
پارامترها ناقص
هستند
407
دسترسی به اطلاعات مورد نظر برای شما امکان پذیر نیست
استفاده از این متد نیاز به تنظیم IP در بخش تنظیمات امنیتی دارد
414
حجم درخواست بیشتر از حد مجاز است ، هر فراخوانی 500 شناسه پیامک
گاهی پیش می آید نیاز داریم فهرست پیامک های ارسال شده را در بازه زمانی مشاهده کنیم ، در این حالت از این متد استفاده کنید.
برای این کار کافیست
تاریخ شروع و پایان بازه زمانی مورد نظر را به فرمت UnixTime
را ارسال کنید .
برای دریافت آخرین پیامک های ارسال شده میتوانید از این متد استفاده نمائید.
با ارسال مقدار پارامتر
pagesize
میتوانید تعداد رکورد های مورد نیاز را مشخص نمائید.
پارامترهای ورودی
pagesize
اختیاری
Long
تعداد آخرین رکورد های مورد نیاز
(حداکثر 500 رکورد)
شما میتوانید در هنگام ارسال پیامک از طریق پارامتر Date تاریخ ارسال پیامک را مشخص نمائید. در صورتی که ارسال پیامک در تاریخ معینی تنظیم شود پیامک زمانبندی میشود. حال اگر شما مایل هستید این زمان بندی را لغو نمائید ، راه حل شما استفاده از این متد است.
در هر بار اجرای این متد میتوانید ارسال حداکثر 500 پیامک را لغو نمائید. کافیست شناسه ها را از طریق کاراکتر ویرگول « , » از هم جدا کنید.
در صورتی که شناسه پیامک
MessageId
معتبر نباشد یا متعلق به شما نباشد مقدار فیلد
Status
برابر با 100
خواهد بود.
در صورت ارسال درخواست برای لغو پیامکی که ارسال شده است.
برای اطلاع از وضعیت پیامک ها به جدول
وضعیت پیامک ها
مراجعه نمائید
فقط در صورتی که پیامک مورد نظر زمانبندی شده باشد امکان لغو آن وجود دارد
در صورت لغو شدن ارسال پیامک هزینه آن به اعتبار حساب شما بازگشت داده میشود
خطاها
412
درخواست لغو شد ( تعداد شناسه پیامک ها بیشتر از 200 بوده است )
API
کاوه نگار علاوه برامکان ارسال پیامک های دریافت شده به
URL شما
Receive via Callback URL
امکان این را دارد که شما از طریق فراخوانی این متد پیامک های دریافتی خط مورد نظر را واکشی کنید.
بعد از فراخوانی این متد پیامک های که در خروجی قرار می گیرند وضعیت خوانده شده
isRead = 1
را خواهند داشت.
علاوه بر این شما میتوانید سیستم دریافت پیامک خود را با تنظیم URL در بخش تنظیمات
به صورت Real-Time داشته باشید که به محض دریافت پیامک از مخابرات آن را برای شما از طریق URL ارسال نماید.
در نهایت در صورتی که پیامک های دریافت شده از طریق URL به هر دلیلی به دست شما نرسد
وضعیت خوانده نشده
isRead = 0
خواهند داشت که میتوانید با اجرای این متد کلیه پیام ها را دریافت کنید.
پارامترهای ورودی
linenumber
اجباری
String
شماره خط مورد نظر ( مثل 30002225 )
isread
اجباری
Integer
خوانده شده : 1 ، خوانده نشده : 0
برای دریافت پیامک های خوانده نشده (جدید) مقدار 0 را باید در این پارامتر قرار دهید .
پارامترهای خروجی
messageid
Long
شناسه پیام دریافتی
message
String
متن پیام دریافت شده
sender
String
شماره ارسال کننده پیامک
receptor
String
شماره دریافت کننده
date
UnixTime
تاریخ دریافت پیامک
یادداشت
در هر بار فراخوانی این متد 100 پیامک دریافت شده در خروجی قرار می گیرد.
برای ادامه کافیست مادامی که تعداد رکورد های خروجی برابر 100 است این متد را فراخوانی نمائید.
از طریق این متد میتوانید برای احراز هویت کاربران با ارسال کد اعتبار سنجی و یا اطلاعات ضروری مانند ارسال رمزعبور، کد تایید عضویت ، شماره فاکتور، کدهای خرید و تخفیف و ... استفاده نمائید. فرق این متد با متد ارسال پیامک
در این است که پیامک های این متد بالاترین اولویت را دارند و هیچ کدام از پیامک های آن فیلتر نخواهند شد( ارسال پیامک به افرادی که پیامک تبلیغاتی خود را بسته اند) همچنین این متد قابلیت ارسال پیامک به ۱۴۸ کشور دنیا را دارد.
برای مشاهده ویژگی های این سرویس به صفحه معرفی آن مراجعه کنید.
(معرفی سرویس اعتبار سنجی)
در ساختار این متد نیازی نیست فرستنده
را
ارسال کنید
کافیست گیرنده و مقدار کد Token
را ارسال نمائید.
سیستم
بهترین پیش شماره داخلی یا خارجی را انتخاب می کند و پیامک را ارسال می کند.
برای استفاده از این متد نیاز است ابتدا الگوی پیام خود را از طریق پنل مشخص نمائید.
مثالی از متن الگو
کد تایید عضویت
token%
ممنون از خرید شما
کد شارژ : %token
سریال : %token2
مدت اعتبار : %token3
پارامتر
type
دارای دو مقدار است که توضیح هر کدام به شرح زیر است :
call :
در صورتی که نیاز به ارسال پیام صوتی دارید
sms :
در صورتی که نیاز به ارسال پیام متنی دارید
برای اطلاع از وضعیت پیامک به جدول
وضعیت پیامک ها
مراجعه نمائید
برای پیامک به کشور های دیگر کد کشور را با دو صفر ارسال نمائید
برای استفاده از این متد نیاز است سرویس پیشرفته را فعال نمائید
در صورت وجود اختلال در پیش شماره های داخلی ، پیامک از پیش شماره های بین المللی ارسال خواهد شد
در صورت تمایل، واحد فنی توکن های بیشتری با قابلیت فضای خالی (Space) در اختیار شما قرار خواهد داد.
توجه : در صورتی که
Token
فقط شامل عدد باشد استفاده از تماس تلفنی امکان پذیر است.
اگر گیرنده تلفن ثابت ایران باشد نوع پیام به صورت خودکار به تماس
تلفنی تغییر خواهد کرد.
مقدار پیش فرض این پارامتر
SMS
است.
خطاها
418
اعتبار حساب شما کافی نیست
422
داده ها به دلیل وجود کاراکتر نامناسب قابل پردازش نیست
424
الگوی مورد نظر پیدا نشد ، زمانی که نام الگو نادرست باشد یا طرح آن هنوز تائید نشده باشد رخ میدهد
426
استفاده از این متد نیازمند سرویس پیشرفته میباشد
428
ارسال کد از طریق تماس تلفنی امکان پذیر نیست،
درصورتی که توکن فقط حاوی عدد نباشد این خطا رخ میدهد
431
ساختار کد صحیح نمیباشد
،
اگر توکن حاوی خط جدید،فاصله،
UnderLine
یا جداکننده باشد
این خطا رخ میدهد
432
پارامتر کد در متن پیام پیدا نشد
، اگر در هنگام تعریف الگو پارامتر
token%
را تعریف نکرده باشید این خطا رخ میدهد
از این متد برای ارسال تماس صوتی استفاده می کنیم، امکان ارسال یک تماس صوتی خاص به چندین گیرنده
( Receptor )
در این متد وجود دارد کافیست آنها را از طریق کاراکتر ویرگول
«
,
»
از هم جدا کنید .
پارامترهای ورودی
receptor
اجباری
String
شماره دریافت کننده پیامک را مشخص می کند که می توان با کاراکتر ویرگول "," آنها را از هم جدا کرد
message
اجباری
String
متن پیام کوتاه ، متن مورد نظر را در حالت POST یا GET حتما بایدEncode شود
در صورتي که تماس ارسالي به گيرنده نرسد سرويس کاوه نگار با توجه به مقدار پارامتر repeat که بين بازه 0 تا 5 مي باشد دوباره اقدام به ارسال آن تماس مي کند که بازه زماني بين هر تکرار 3 دقيقه مي باشد.
برای اطلاع از وضعیت پیامک به جدول
وضعیت پیامک ها
مراجعه نمایید .
برای دریافت اطلاعات و نحوه کار با تاریخ به فرمت UnixTime به
اینجا
مراجعه
نمایید .
در مورد شناسه محلی
LocalId
به چند نکته توجه نمائید :
به وسیله مقدار دهی به این پارامتر میتوانید از ارسال پیامک تکرار جلوگیری نمائید.
...
اطلاعات بیشتر
در صورت مقدار دهی ،
تعداد آن باید برابر تعداد گیرنده باشد
،
با کاراکتر ویرگول
,
آنها را از هم جدا کنید.
در صورت وجود این شناسه محلی
LocalId
در لیست ارسال های شما، ارسال تکراری انجام نمیشود و رکورد مربوط به این شناسه در خروجی قرار خواهد گرفت.
خطاها :
414
تعداد دریافت کننده ها ( Receptor) بیشتر از 200 است .
417
تاریخ ارسال اشتباه است ، تاریخ آن گذشته و یا به فرمت درست ارسال نشده است .
این متد برای دریافت اطلاعات حساب خود و یا مشتریان ایجاد شده توسط شما استفاده میشود.
دریافت اعتبار باقی مانده و تاریخ یکی از مهم ترین فیلدهای خروجی این متد است.
از این متد میتوانید برای دریافت تنظیمات حساب و یا تغییر مقادیر آن استفاده نمائید، برای دریافت مقادیر کافیست درخواست GET بدون هیچ پارامتری ارسال نمائید، همچنین برای تنظیم مقدار هر پارامتر نام پارامتر به همراه مقدار آن را توسط درخواست GET یا POST ارسال نمائید.
وضعیت لاگ کردن رکوئست های وب سرویس را مشخص می کند، اطلاعات بیشتر در یادداشت
dailyreport
اختیاری
String
وضعیت
ارائه گزارش روزانه ارسال و دریافت پیامک
را مشخص می کند، اطلاعات بیشتر در یادداشت
debugmode
اختیاری
String
در صورت فعال بودن این مقدار حساب شما در حالت دیباگ قرار گرفته و هیچ کدام از درخواست های ارسال پیامک را انجام نمی هد تا شما کد خود را تست کنید
defaultsender
اختیاری
String
با تنظیم این پارامتر خط پیش فرض ارسال کنند اکانت شما مشخص میشود
در صورتی که در هنگام ارسال پیامک ارسال کننده را مشخص نکنید مقدار این پارامتر به عنوان خط ارسال کنند لحاظ میشود.
mincreditalarm
اختیاری
Integer
این پارامتر حداقل اعتبار حساب شما برای دریافت هشدار کمبود اعتبار را به ریال تنظیم می کند
resendfailed
اختیاری
String
این پارامتر وضعیت ارسال مجدد و خودکار پیامک هایی که به گیرنده نرسیده اند را مشخص می کند
پارامترهای خروجی
با هر بار تنظیم مقادیر جدید در خروجی بروز میشوند .
پارامتر
نوع
توضیح
apilogs
String
مقادیر این پارامتر دارای سه حالت است که توصیه میشود بخش یادداشت را مطالع نمائید
dailyreport
String
در صورت فعال بودن هر روز ساعت 10 صبح گزارش ارسال و دریافت دیروز را برای شما پیامک میکند
debugmode
String
در صورت فعال بودن هیچ یک از پیامک های شما ارسال نخواهند شد و وضعیت لغو شده خواهند گرفت
defaultsender
String
خط ارسال کننده پیش فرض اکانت را مشخص می کند برای اطلاعات بیشتر به یادداشت مراجعه فرمائید
mincreditalarm
Integer
این پارامتر حداقل اعتبار حساب شما (به ریال) برای دریافت هشدار کمبود اعتبار را تنظیم می کند
resendfailed
String
این پارامتر وضعیت ارسال مجدد و خودکار پیامک هایی که به گیرنده نرسیده اند را مشخص می کند
یادداشت
پارامتر
apilogs
دارای سه مقدار است که توضیح هر کدام به شرح زیر است :
justfaults :
در صورتی که در فراخوانی متد های وب سرویس فقط خطایی رخ دهد لاگ آن ذخیره خواهد شد
enabled :
لاگ
کلیه درخواست های وب سرویس چه خطا دار و چه موفق ذخیره خواهند شد
disabled :
لاگ هیچ درخواستی ذخیره نخواهد شد
با فعال بودن
dailyreport
گزارشی از تعداد ارسال و دریافت و خطاهای
API
و هزینه ارسال روز قبل از طریق پیامک هر روز 10 صبح ارسال میشود
enabled :
ارسال گزارش فعال است
disabled :
ارسال گزارش غیرفعال است
در مواقعی که در حال تست کد های خود هستید و مایل نیستید در صورت فراخوانی متد های ارسال پیامک،
ارسالی انجام شود و اعتبار شما هزینه شود میتوانید
debugMode
را فعال کنید
enabled :
حالت دیباگ فعال است
disabled :
حالت دیباگ غیرفعال است
همان طور که مشاهده کرده اید پارامتر
sender
در متد ارسال پیامک
send
اجباری نمیباشد ،
در صورتی که شما در هنگام استفاده از متد
send
این پارامتر را مقداردهی نکنید
سیستم
defaultsender
را به عنوان ارسال کننده پیش فرض در نظر خواهد گرفت.
منظور از
پارامتر
mincreditalarm
حداقل مبلغ اعتبار حساب
شما برای دریافت پیامک هشدار کمبود اعتبار
است
درصورت فعال بودن پارامتر
resendfailed
اگر پیامک های ارسال شما وضعیت نرسیده به گیرنده را بگیرند به صورت خودکار دوباره ارسال خواهند شد
enabled :
وضعیت ارسال مجدد فعال است
disabled :
وضعیت ارسال مجدد غیر فعال است
خطاها
407
دسترسی به اطلاعات مورد نظر برای شما امکان پذیر نیست
برای استفاده از متدهای Select، SelectOutbox و LatestOutBox و یا ارسال با خط بین المللی نیاز به تنظیم IP در بخش تنظیمات امنیتی می باشد
دسترسی به اطلاعات مورد نظر برای شما امکان پذیر نیست
برای استفاده از متدهای Select، SelectOutbox و LatestOutBox و یا ارسال با خط بین المللی نیاز به تنظیم IP در بخش تنظیمات امنیتی می باشد
409
سرور قادر به پاسخگوئی نیست بعدا تلاش کنید
411
دریافت کننده نامعتبر است
412
ارسال کننده نامعتبر است
413
پیام خالی است و یا طول پیام بیش از حد مجاز میباشد. حداکثر طول کل متن پیامک 900 کاراکتر می باشد
414
حجم درخواست بیشتر از حد مجاز است ،ارسال پیامک :هر فراخوانی حداکثر 200 رکورد و کنترل وضعیت :هر فراخوانی 500 رکورد
415
اندیس شروع بزرگ تر از کل تعداد شماره های مورد نظر است
416
IP سرویس مبدا با تنظیمات مطابقت ندارد
417
تاریخ ارسال اشتباه است و فرمت آن صحیح نمی باشد.
418
اعتبار شما کافی نمیباشد
419
طول آرایه متن و گیرنده و فرستنده هم اندازه نیست
420
استفاده از لینک در متن پیام برای شما محدود شده است
422
داده ها به دلیل وجود کاراکتر نامناسب قابل پردازش نیست
424
الگوی مورد نظر پیدا نشد
426
استفاده از این متد نیازمند سرویس پیشرفته میباشد
427
استفاده از این خط نیازمند ایجاد سطح دسترسی می باشد
428
ارسال کد از طریق تماس تلفنی امکان پذیر نیست
429
IP محدود شده است
431
ساختار کد صحیح نمیباشد
432
پارامتر کد در متن پیام پیدا نشد
451
فراخوانی بیش از حد در بازه زمانی مشخص IP محدود شده
501
فقط امکان ارسال پیام تست به شماره صاحب حساب کاربری وجود دارد
جدول ۲ - وضعیت پیامک ها
مقدار
توضیحات
1
در صف ارسال قرار دارد
2
زمان بندی شده (ارسال در تاریخ معین)
4
ارسال شده به مخابرات
5
ارسال شده به مخابرات (همانند وضعیت 4)
6
خطا در ارسال پیام که توسط سر شماره پیش می آید و به معنی عدم رسیدن پیامک میباشد (Failed)
10
رسیده به گیرنده (Delivered)
11
نرسیده به گیرنده ، این وضعیت به دلایلی از جمله خاموش یا خارج از دسترس بودن گیرنده اتفاق می افتد (Undelivered)
13
ارسال پیام از سمت کاربر لغو شده یا در ارسال آن مشکلی پیش آمده که هزینه آن به حساب برگشت داده میشود
14
بلاک شده است، عدم تمایل گیرنده به دریافت پیامک از خطوط تبلیغاتی که هزینه آن به حساب برگشت داده میشود
100
شناسه پیامک نامعتبر است ( به این معنی که شناسه پیام در پایگاه داده کاوه نگار ثبت نشده است یا متعلق به شما نمیباشد)
جدول ۳ - نوع نمایش پیام
کد
توضیحات
0
پیامک بصورت مستقیم برروی صفحه موبایل شخص گیرنده ظاهرمیشود.این حالت پیامک درموبایل یا سیم کارت شخص گیرنده بصورت اتوماتیک ذخیره نمیشود و با خروج از آن حذف میشود(پیامک خبری)
1
در حافظه ﻣﻮﺑﺎﻳﻞ ﺷﺨﺺ گیرنده ذخیره میشود. (پیامک عادی) در صورتی که پارامتر مربوطه خالی ارسال شود به صورت پیش فرض پیامک مورد نظر با این نوع ارسال میشود
2
پیامک برروی حافظه سیمکارت گوشی گیرنده ذخیره میشود
3
درصورتی که موبایل شخص گیرنده دارای یک نرم افزار کابردی خاص برای ذخیره پیامک باشد و یا به یک نرم افزار کاربردی خاص برروی یک کامپیوترمتصل باشد، پیامک دریافتی درآن نرم افزارها ذخیره میشود
آخرین تغییرات
متد استعلام با کدپستی CountPostalCode حذف گرید.
متد ارسال پیام با کد پستی SendByPostalCode حذف گرید.
برای استفاده از متدهای Select، SelectOutbox و LatestOutBox نیاز دارید تا IP را از بخش تنظیمات > تنظیمات امنیتی تنظیم نمایید.
بازه ارسال در متدهای SelectOutbox , LatestOutBox به 1 روز تغییر پیدا کرد.
تاریخ شروع در متدهای SelectOutbox , LatestOutBox نباید کوچکتر از 60 روز قبل باشد.
پارامتر Pagesize در سایر متدها از مقدار 500 به 200 تغییر پیدا کرد.
اگر مقداری عددی پارامتر hide برابر 1 باشد شماره گیرنده در فهرست ارسال ها و کنسول وب نمایش داده نمی شود.