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

تائید حساب

شما می‌توانید با نوشتن چند خط کد ترتیبی دهید که صحت یک حساب کاربری از طریق پیام صوتی تائید شود.

یادآوری صوتی

سیستم موارد مختلف را به مشتری یادآوری می‌کند. به این ترتیب مشتری ، پرداخت هزینۀ سالیانۀ یک سرویس و … را فراموش نخواهد کرد.

هشدار صوتی

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

حسابداری

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

وب سرویس پیام صوتی چیست ؟

وب سرویس تل آوا

وب سرویس ها برنامه (قطعه کد) هایی هستند که تحت وب قابل دسترسی اند و از طریق پروتکل های استانداردی مانند Http به انتقال و مبادله دیتا با سایر برنامه های کاربردی می پردازند. اساس کار وب سرویس (Web Service) ها بر پایه دریافت و تولید پیغام بنیان گذاری شده است. بدین معنی که آنها منتظر می مانند که کلاینت ها به آنها وصل شده و بنا به درخواست کلاینت ها به آن ها پاسخ می دهند . راه ارتباطی انتقال این پیغام ها یک آدرس است که شما میتوانید با افزودن آن در برنامه خود از خصوصیات آن استفاده نمائید

API تل آوا چیست ؟

API تل آوا

  API به معنی رابط کاربردی برنامه نویسی یا Application Programming Interface و همچنین جنبه اساسی تشکیل وب ۲ است. اما واقعا API چیست؟ ما در این مطلب به توضیح این موضوع خواهیم پرداخت. این کلمه توجه خاصی به رابط یا Interface دارد. اگر شما هر گونه تجربه ای در برنامه نویسی داشته باشید، همه معانی و مخفف ها با شنیدن کلمه Interface به ذهنتان می آید؛ اما ما بیشتر علاقمند به دانستن معنی کلاسیک و معمولی آن هستیم. یک رابط (Interface) یک مرز مشترک بین دو سیستم و سرویس جدا است. از جمله می توان این موضوع را برداشت کرد که بین این دو سیستم ارتباط برقرار است.

شما در اینجا چه از وب سرویس استفاده نمائید و چه از وب Api متدهایی که میتوانید از آن استفاده نمائید یکسان هستند ، شما میتوانید متدها را با توضیحات کامل به علاوه ی ورودی ها و خروجی های آن مشاهده نمائید:
برای راحتی کار شما در پایان توضیحات هر متد نمونه کدهایی از زبان های رایج نیز برایتان فراهم شده است.

MakeSecureCall

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

ورودی ها

نام نوع شرح
UserName String نام کاربری شما در سامانه تل آوا
Password String رمز عبور شما در سامانه تل آوا
srcNumber String شماره مبدا
dstNumber String شماره مقصد
holdMessageId int آیدی پیام جهت انتظار
serverId int کد سرور ارسال کننده پیام

خروجی ها

مقدار خروجی عنوان خروجی
نام کاربری یا رمزعبور صحیح نیست
کد سرور صحیح نیست
اعتبار کافی نیست، به ازای هر درخواست باید ۱۰۰۰ تومان اعتبار در حساب وجود داشته باشد
کد پیام انتظار صحیح نیست
عدم فعالسازی تماس امن
۰ خطا در زیر ساخت

دریافت نمونه کد

UploadMessage

از طریق این متد میتوانید فایل صوتی خود را که در قالب wav با فرمت PCM 8000h 16k mono تنظیم کرده اید، در سامانه آپلود و در ارسال ها استفاده نمایید.

ورودی ها

نام نوع شرح
UserName String نام کاربری شما در سامانه تل آوا
Password String رمز عبور شما در سامانه تل آوا
Title String عنوان فایل صوتی شما
File Byte[ ] dicbinaryfile فایل صوتی شما که میبایست با پسوند wav و به صورت آرایه ای از نوع بایت باشد
فایل صوتی شما میبایست در قالب mono,8000Hz,16b بوده و حجم آن نیز از ۵مگابایت بیشتر نباشد

خروجی ها

 

مقدار خروجی عنوان خروجی
اعتبارسنجی
-۱۰ فرمت نامناسب
-۲۰ خطای ناشناخته
-۳۰ اشکال در آپلود
بزرگتر از صفر آی دی پیام آپلود شده
دریافت نمونه کد

DownloadMessage

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

ورودی ها

نام نوع شرح
UserName String نام کاربری شما در سامانه تل آوا
Password String رمز عبور شما در سامانه تل آوا
messageId int کد فایل صوتی

خروجی ها

مقدار خروجی عنوان خروجی
null اعتبارسنجی و یا عدم وجود فایل

دریافت نمونه کد

DeleteMessage

از طریق این متد می توانید فایل آپلود شده در سامانه را حذف نمایید.

ورودی ها

نام نوع شرح
UserName String نام کاربری شما در سامانه تل آوا
Password String رمز عبور شما در سامانه تل آوا
messageId int کد [id] فایل آپلود شده

خروجی ها

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

CreateCampaign

از طریق این متد میتوانید یک لیست ارسال ایجاد و در صورت تمایل ارسال نمایید

ورودی ها

نام نوع شرح
userName string متن ساده
password string متن ساده
title string عنوان لیست ارسال
numbers string شماره های لیست ارسال. شمارها باید با کما “,” از هم جدا شوند
maxTryCount int حداکثر تعداد تلاش برای هر شماره
minuteBetweenTries int مدت تاخیر بین تلاش ها بر اسا دقیقه
startDate string ۲۱۱۶-۱۱- تاریخ شروع ارسال لیست به میلادی. مانند: ۱۱
startTime string ساعت شروع ارسال لیست. مانند: ۱۸:۱۱
endDate string ۲۱۱۶-۱۱- تاریخ خاتمه ارسال لیست به میلادی. مانند: ۱۱
endTime string ساعت خاتمه ارسال لیست. مانند: ۱۸:۱۱
messageId int کد [id] پیام صوتی آپلود شده در سامانه
removeInvalids bool حذف شماره های اشتباه و تکراری بصورت خودکار
autoStart bool شروع خودکار لیست پس از ایجاد
vote bool فعال سازی امکان نظرسنجی بر روی تماس ها
serverid int کد سرور ارسال کننده پیام

خروجی ها

مقدار خروجی عنوان خروجی
اعتبارسنجی
سرور آیدی اشتباه است یا وجود ندارد
-۳۰ لیست ارسال وجود ندارد
-۵۰ کمبود اعتبار
-۶۰ کد پیام ناصحیح
-۷۰ اطلاعات لیست ارسال صحیح نیست
بزرگتر از صفر کد لیست ایجاد شده

نکته: serverid پارامتر جدیدی است که برای انتخاب شماره ارسال کننده پیام(سرور) گذاشته شده است.
شما میتوانید برای ارسال پیام های خود یکی از گزینه های زیر را انتخاب کنید:

ارسال از مشهد عدد ۱
ارسال از مازندران عدد ۱۵
ارسال از تهران شمال ۲۰
ارسال از تهران جنوب ۲۵
ارسال از تهران شرق ۳۰
ارسال از تهران غرب ۳۵
ارسال از خراسان شمالی ۴۰
دریافت نمونه کد

StartCampaign Method

از طریق این متد میتوانید یک لیست ارسال ایجاد و در صورت تمایل ارسال نمایید

ورودی ها

نام نوع شرح
userName string متن ساده
password string متن ساده
title string عنوان لیست ارسال
numbers string شماره های لیست ارسال. شمارها باید با کما “,” از هم جدا شوند
maxTryCount int حداکثر تعداد تلاش برای هر شماره
minuteBetweenTries int مدت تاخیر بین تلاش ها بر اسا دقیقه
startDate string ۲۱۱۶-۱۱- تاریخ شروع ارسال لیست به میلادی. مانند: ۱۱
startTime string ساعت شروع ارسال لیست. مانند: ۱۸:۱۱
endDate string ۲۱۱۶-۱۱- تاریخ خاتمه ارسال لیست به میلادی. مانند: ۱۱
endTime string ساعت خاتمه ارسال لیست. مانند: ۱۸:۱۱
messageId int کد [id] پیام صوتی آپلود شده در سامانه
removeInvalids bool حذف شماره های اشتباه و تکراری بصورت خودکار
autoStart bool شروع خودکار لیست پس از ایجاد
vote bool فعال سازی امکان نظرسنجی بر روی تماس ها
serverid int کد سرور ارسال کننده پیام

خروجی ها

مقدار خروجی عنوان خروجی
اعتبارسنجی
سرور آیدی اشتباه است یا وجود ندارد
-۳۰ لیست ارسال وجود ندارد
-۵۰ کمبود اعتبار
-۶۰ کد پیام ناصحیح
-۷۰ اطلاعات لیست ارسال صحیح نیست
بزرگتر از صفر کد لیست ایجاد شده

نکته: serverid پارامتر جدیدی است که برای انتخاب شماره ارسال کننده پیام(سرور) گذاشته شده است.
شما میتوانید برای ارسال پیام های خود یکی از گزینه های زیر را انتخاب کنید:

ارسال از مشهد عدد ۱
ارسال از مازندران عدد ۱۵
ارسال از تهران شمال ۲۰
ارسال از تهران جنوب ۲۵
ارسال از تهران شرق ۳۰
ارسال از تهران غرب ۳۵
ارسال از خراسان شمالی ۴۰
دریافت نمونه کد

StopCampaign

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

ورودی ها

نام نوع شرح
UserName String نام کاربری شما در سامانه تل آوا
Password String رمز عبور شما در سامانه تل آوا
campaignId int کد [id] لیست ارسال موردنظر

خروجی ها

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

GetCampaignByDate

مــــتد دریافت نام و شماره شناسایی کاربــر

ورودی ها

نام نوع شرح
username string متن ساده
password string متن ساده
fromdate string ۲۱۱۶-۱۱- تاریخ شروع به میلادی. مانند: ۱۱
todate string ۲۱۱۶-۱۱- تاریخ پایان به میلادی. مانند: ۱۱

خروجی ها

خروجی این متد لیستی از لیست های ارسال ایجاد شده در بازه زمانی تعیین شده می باشد.
در صورتی که این متد مقدار null را بازگرداند به معنی این است که در قسمت اعتبارسنجی به مشکل خورده اید.

دریافت نمونه کد

GetCampaignById

از طریق این متد می توانید اطلاعات یک لیست های ایجاد شده را بر اساس کد `{`id`}` لیست دریافت نمایید.

ورودی ها

نام نوع شرح
UserName String نام کاربری شما در سامانه تل آوا
Password String رمز عبور شما در سامانه تل آوا
campaignId Int کد [id] لیست ارسال

خروجی ها

خروجی این متد اطلاعات لیست ارسال مورد نظر می باشد.
در صورتی که این متد مقدار null را بازگرداند به معنی این است که در قسمت اعتبارسنجی به مشکل خورده اید.
یکی از مشخصه های لیست خروجی statusid است که میتواند یکی از حالت ذیل باشد.

مقدار خروجی عنوان خروجی
۸ عدم تائید
۹ در انتظار
۱۰ تائید شده
۱۱ در حال ارسال
۱۲ تمام شده
۲۷ متوقف شده
دریافت نمونه کد

GetCampaignNumbersBySendDate

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

ورودی ها

نام نوع شرح
UserName String نام کاربری شما در سامانه تل آوا
Password String رمز عبور شما در سامانه تل آوا
fromDate string ۲۱۱۶-۱۱- تاریخ شروع به میلادی. مانند: ۱۱
toDate string ۲۱۱۶-۱۱- تاریخ پایان به میلادی. مانند: ۱۱

خروجی ها

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

دریافت نمونه کد

GetCampaignNumbersDataByIds

از طریق این متد می توانید با ارسال رشته ای از کد های شماره )جدا شده توسط کاما “,” (، اطلاعات آنها را در قالب یک لیست دریافت نمایید

ورودی ها

نام نوع توضیحات
UserName String نام کاربری شما در سامانه تل آوا
Password String رمز عبور شما در سامانه تل آوا
campaignNumberIds string رشته ای از کد های شماره )جدا شده توسط کاما “,” ) .

خروجی ها

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

دریافت نمونه کد

GenerateTTS

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

ورودی ها

نام نوع توضیحات
UserName String نام کاربری شما در سامانه تل آوا
Password String رمز عبور شما در سامانه تل آوا
Speaker string انتخاب گوینده – male برای گوینده اقا – female برای گوینده خانم
your Text string متن مورد نظر شما جهت تبدیل شدن به صوت
title string عنوان فایل صوتی
نکته: توجه نمایید به ازای هر درخواست به وب سرویس آواخوان، ۱۰ ثانیه اعتبار از شما کسر می شود. (هزینه ی تولید صدا کاملا از هزینه ی ارسال مجزا می باشد)
به عنوان مثال اگر فایل شما ۱۵ ثانیه شود، هزینه ۱۰ ثانیه از حساب شما کسر خواهد شد و فرقی نمی کند که فایل تولیدی به یک نفر یا ۱۰۰۰۰ نفر ارسال شود
کسر این ۱۰ ثانیه صرفا جهت جلوگیری از درخواست های نامربوط و خارج از سرویس می باشد.
این نکته را مدنظر داشته باشید که فقط استفاده از وب سرویس آواخوان این هزینه را دارد و در صورتی که شما از سرویس آواخوان درون پنل استفاده نمائید شامل هزینه نمی شود و رایگان است.

خروجی ها

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

QuickSendWithTTS

استفاده از سرویس ویژه آواخوان

ورودی ها

نام نوع توضیحات
UserName String نام کاربری شما در سامانه تل آوا
Password String رمز عبور شما در سامانه تل آوا
Text text متن مورد نظر شما جهت تبدیل شدن به صوت
number string شماره تماس
vote bool فعال سازی نظرسنجی بر روی ارسال
serverid int کد سرور برای ارسال پیام

نکته: serverid پارامتر جدیدی است که برای انتخاب شماره ارسال کننده پیام(سرور) گذاشته شده است.
شما میتوانید برای ارسال پیام های خود یکی از گزینه های زیر را انتخاب کنید:

ارسال از مشهد عدد ۱
ارسال از مازندران عدد ۱۵
ارسال از تهران شمال ۲۰
ارسال از تهران جنوب ۲۵
ارسال از تهران شرق ۳۰
ارسال از تهران غرب ۳۵
ارسال از خراسان شمالی ۴۰

 

نکته: به ازای هر درخواست به وب سرویس آواخوان، معادل ۱۰ ثانیه به هزینه ی فایل صوتی اضافه می گردد.
به عنوان مثال یک فایل ۱۵ ثانیه ای، ۱۵+۱۰ یعنی ۲۵ ثانیه محاسبه می گردد.
**** تفاوت متد QuickSendWithTTS با متد GenerateTTS در این است که این متد در هر بار درخواست محتوایی دیگر را درخواست داده لذا در هر درخواست هزینه ی مازاد (معادل یک ارسال ۱۰ ثانیه ای) تعلق میگیرد.

خروجی ها

مقدار خروجی عنوان خروجی
۰ کاربر دمو است
اعتبارسنجی
سرور آیدی اشتباه است یا وجود ندارد
اشکال در آپلود
کمبود اعتبار
عدم اتصال به TTS
تعداد کاراکتر بیشتر از ۱۰۰۰ است
خارج از محدوده زمانی ارسال است
بزرگتر از صفر آی دی پیام آپلود شده
دریافت نمونه کد

SendOTP

ارسال کد اعتبار سنجی

تذکر: تعداد کد ارسالی برای کاربر توسط OTP دارای محدودیت ۴ تا ۸ رقمی است . برای استفاده از حالات دیگر میتوانید همین سیستم را با استفاده از سرویس آوخوان پیاده سازی کنید.

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

ورودی ها

نام نوع توضیحات
UserName String نام کاربری شما در سامانه تل آوا
Password String رمز عبور شما در سامانه تل آوا
Length int طول کد ( حداقل ۴ و حداکثر ۸)
number string شماره تماس
text string متن مورد نظر شما جهت تبدیل شدن به صوت
serverid id کد سرور ارسال کننده پیام صوتی

خروجی ها

مقدار خروجی عنوان خروجی
مشکل در اعتبارسنجی
سرور آیدی اشتباه است یا وجود ندارد
اشکال در آپلود
کمبود اعتبار
عدم اتصال به TTS
تعداد کاراکتر بیشتر از ۱۰۰۰ است
خارج از محدوده زمانی ارسال است
بزرگتر از صفر یک کد با طول تعیین شده به صورت تصادفی

نکته: serverid پارامتر جدیدی است که برای انتخاب شماره ارسال کننده پیام(سرور) گذاشته شده است.
شما میتوانید برای ارسال پیام های خود یکی از گزینه های زیر را انتخاب کنید:

ارسال از مشهد عدد ۱
ارسال از مازندران عدد ۱۵
ارسال از تهران شمال ۲۰
ارسال از تهران جنوب ۲۵
ارسال از تهران شرق ۳۰
ارسال از تهران غرب ۳۵
ارسال از خراسان شمالی ۴۰
دریافت نمونه کد

SendOCV

اعتبار سنجی با یک کلیک

ورودی ها

نام نوع توضیحات
UserName String نام کاربری شما در سامانه تل آوا
Password String رمز عبور شما در سامانه تل آوا
number string شماره تماس
callbackUrl string آدرس برگشت برای دریافت عدد وارد شده توسط کاربر
serverid int کد سرور برای ارسال پیام

خروجی ها

مقدار خروجی عنوان خروجی
مشکل در اعتبارسنجی
سرور آیدی اشتباه است یا وجود ندارد
اشکال در آپلود
کمبود اعتبار
عدم اتصال به TTS
تعداد کاراکتر بیشتر از ۱۰۰۰ است
خارج از محدوده زمانی ارسال است
بزرگتر از صفر یک کد با طول تعیین شده به صورت تصادفی

نکته: serverid پارامتر جدیدی است که برای انتخاب شماره ارسال کننده پیام(سرور) گذاشته شده است.
شما میتوانید برای ارسال پیام های خود یکی از گزینه های زیر را انتخاب کنید:

ارسال از مشهد عدد ۱
ارسال از مازندران عدد ۱۵
ارسال از تهران شمال ۲۰
ارسال از تهران جنوب ۲۵
ارسال از تهران شرق ۳۰
ارسال از تهران غرب ۳۵
ارسال از خراسان شمالی ۴۰
دریافت نمونه کد

نمونه کد کامل استفاده از وب سرویس (همراه با ابزار تبدیل و ترکیب صوت)

نمونه کد نوشته شده به زبان سی شارپ (Windows Form)

زبان برنامه نویسی : C# WinForm – .Net 4.5 حجم فایل : ۳٫۲۳MB

Price Reader - نمونه کد نوشته شده به زبان سی شارپ - قیمت خوان

نکته : این کد به عنوان مثال است و تا ارقام میلیارد بیشتر پشتیبانی نمیکند. زبان برنامه نویسی : ASP.Net MVC

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

زبان برنامه نویسی : php ورژن فایل : ۱٫۵

به کمک بیشتری نیاز دارید ؟