مقدمه

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

بدیهی است هر مقدار فایل ارسال شده طولانی تر باشد ، زمان انتظار برای دریافت خروجی طولانی تر خواهد بود.

مراحل فراخوانی سرویس:

  1. اجرای سرویس تبدیل صوت به متن و ارسال آدرس اینترنتی فایل صوتی
  2. دریافت شناسه پیگیری
  3. فراخوانی سرویس استعلام قیمت که با توجه به اینکه سرویس از نوع کال بکی می باشد لذا کاربر میبایست تا پایان عملیات دریافت فایل اینترنتی و پردازش آن صبر نماید.
  4. دریافت مشخصات فایل صوتی ارسال شده و مشاهده کارمزد سرویس
  5. پس از کسر کارمز سرویس به صورت خودکار پردازش فایل آغاز خواهد شد.
  6. فراخوانی سرویس نتیجه پردازش که در این مرحله با توجه به اینکه ممکن است پردازش فایل صوتی زمان بر باشد لذا کاربر میبایستی تا پایان پردازش صبر نماید که در این صورت پاسخ مناسب در هر مرحله از وضعیت پردازش دریافت خواهد کرد.

 

پیش از شروع

  • URL فراخوانی سرویس­ها:

Production Server: https://api.pod.ir/srv/sc/nzh/doServiceCall

Sandbox Server:https://sandbox.pod.ir/srv/sc/nzh/doServiceCall

  • تمامی درخواست­ها با متد POST ارسال می­شوند.
  • فیلدهای زیر درHeader تمامی درخواست­ها ثابت است:

پارامتر

توضیحات

_token_

توکن کسب­وکاری دریافتی از پنل

_token_issuer_

مقدار ثابت "1"

  • فیلدهای زیر در بدنه‌ی تمامی درخواست‌ها ثابت است (با فرمت x-www-form-urlencoded):

پارامتر

توضیحات

scProductId

شناسه­‌ی سرویس مدنظر

scApiKey

راهنمای دریافت این پارامتر در این لینک موجود است.

  • علاوه بر موارد بالا که ثابت هستند، اگر سرویس نیاز به پارامتر دیگری داشته باشد در داکیومنت مربوطه ذکر شده است.
  • خروجی: ساختار کلی پاسخ دریافتی در این لینک به تفصیل شرح داده شده است.

نکته: پس از درخواست سرویس به پادیوم، همکاران ما درخواستهای ارسالی را بررسی می‌کنند. در صورت عدم دریافت تایید کرد بر روی درخواست ارسالی ظرف یک روز کاری،به همکاران ما از طریق شماره تلفن (021-89518989) و یا در گروه واتس‌اپ اطلاع دهید تا دسترسی به سرویس موردنظر برای شما فعال شود.

 

سرویس ارسال فایل صوتی

در این سرویس میبایست فایل صوت مورد نظر ابتدا در فضای اینترنت آپلود و آدرس فیزیکی آن به عنوان ورودی ارسال گردد.

  • نکته مهم: سرویس های پردازش به صورت کال بکی میباشد و کاربر باید تا اماده سازی پاسخ منتظر بماند.

بدیهی است در هر مرحله از پردازش پاسخ مناسب صادر خواهد شد.

  • نکته مهم: آدرس فایل اینترنتی باید معتبر و با فرمت mp3  باشد.
  • شناسه سرویس اصلی: 3620028

  • شناسه سرویس سندباکس : 156165
  • پارامتر ورودی سرویس

نام پارامتر

نوع

اختیاری / اجباری

توضیحات

file_url

String

اجباری

آدرس اینترنتی فایل صوتی با فرمت mp3

  •  پارامتر های خروجی:

نام پارامتر

نوع

توضیحات

hasError

bool

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

messageId

int

پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد.

referenceNumber

string

شناسه ی درخواست در پلتفرم پاد.

errorCode

int

کد ارور پلتفرمی.

Count

int

پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد.

Ott

string

پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد.

Result

object

نتیجه ی فراخوانی سرویس در این آبجکت نمایش داده می شود که در ادامه شرح داده خواهد شد.

نکته: طبق موارد مطرح شده، پاسخ مد نظر سرویس دریافت اطلاعات آدرس در فیلد result موجود است.

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

  • پارامتر های پاسخ سرویس در Result :

نام پارامتر

نوع

توضیحات

result

String

نتیجه پاسخ سرویس

header

String

هدر پاسخ سرویس

statusCode

String

وضعیت پاسخ سرویس بر اساس کد های http status codes

scTrackerId

String

شناسه پیگیری پاسخ سرویس کال بکی

به صورت کلی پاسخ خروجی result  صورت زیر میباشد.

json

 

 

  • مشخصات پارامتر پاسخ

نام پارامتر

نوع

توضیحات

Url

String

آدرس فایل صوتی ارسال شده

Status

String

وضعیت پاسخ

Message

String

متن پاسخ سرویس

trackerId

String

شناسه پیگیری سرویس

 

سرویس استعلام قیمت

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

  • شناسه سرویس اصلی: 3733710

  • شناسه سرویس سندباکس : 164952
  • پارامتر ورودی سرویس

نام پارامتر

نوع

اختیاری / اجباری

توضیحات

trackerID

String

اجباری

شناسه پیگیری دریافتی

  •  پارامتر های خروجی:

نام پارامتر

نوع

توضیحات

hasError

bool

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

messageId

int

پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد.

referenceNumber

string

شناسه ی درخواست در پلتفرم پاد.

errorCode

int

کد ارور پلتفرمی.

Count

int

پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد.

Ott

string

پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد.

Result

object

نتیجه ی فراخوانی سرویس در این آبجکت نمایش داده می شود که در ادامه شرح داده خواهد شد.

نکته: طبق موارد مطرح شده، پاسخ مد نظر سرویس دریافت اطلاعات آدرس در فیلد result موجود است.

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

json

 

 

  • پارامتر های پاسخ سرویس در Result :
  • مشخصات پارامتر پاسخ result

نام پارامتر

نوع

توضیحات

trackerID

String

شناسه پیگیری درخواست سرویس

status

Json

وضعیت پردازش سرویس

file_url

String

آدرس اینترنتی فایل ارسال شده

name

String

نام فایل

time

String

زمان فایل

size

String

حجم فایل

price

String

کارمزد سرویس

processID

String

شناسه پردازش (در صورتی خالی بودن هنوز پردازشی نشده)

result

Json

نتیجه پردازش در صورتی که پردازش به اتمام رسیده باشد

created_at

String

تاریخ درخواست پردازش

نکته: در صورتی که سرویس بدون خطا اجرا و پاسخ دریافت گردد پردازش روی فایل ارسالی شروع خواهد شد و در غیر این صورت هیچ عملیاتی روی فایل انجام نخواهد شد و کارمزدی نیز دریافت نخواهد شد.

 

 سرویس دریافت متن فایل صوتی

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

  • شناسه سرویس اصلی: 3620250

  • شناسه سرویس سندباکس : 164954
  • پارامتر ورودی سرویس

نام پارامتر

نوع

اختیاری / اجباری

توضیحات

trackerID

String

اجباری

شناسه پردازش دریافتی از مرحله قبل

  • پارامتر های خروجی:

نام پارامتر

نوع

توضیحات

hasError

bool

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

messageId

int

پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد.

referenceNumber

string

شناسه ی درخواست در پلتفرم پاد.

errorCode

int

کد ارور پلتفرمی.

Count

int

پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد.

Ott

string

پارامتر درون پلتفرمی ای که با توجه به این سرویس خاص موضوعیت ندارد.

Result

object

نتیجه ی فراخوانی سرویس در این آبجکت نمایش داده می شود که در ادامه شرح داده خواهد شد.

نکته: طبق موارد مطرح شده، پاسخ مد نظر سرویس دریافت اطلاعات آدرس در فیلد result موجود است.

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

json

 

 

  • پارامتر های پاسخ سرویس در Result :
  • مشخصات پارامتر پاسخ result

نام پارامتر

نوع

توضیحات

trackerID

String

شناسه پیگیری درخواست سرویس

status

Json

وضعیت پردازش سرویس

file_url

String

آدرس اینترنتی فایل ارسال شده

name

String

نام فایل

time

String

زمان فایل

size

String

حجم فایل

price

String

کارمزد سرویس

processID

String

شناسه پردازش (در صورتی خالی بودن هنوز پردازشی نشده)

result

Json

نتیجه پردازش در صورتی که پردازش به اتمام رسیده باشد

created_at

String

تاریخ درخواست پردازش

به صورت کلی پاسخ خروجی result  خروجی نهایی به صورت زیر میباشد.

نام پارامتر

نوع

توضیحات

transcription

Json

محتوای اصلی متن پردازش شده

final

True/false

نتیجه اتمام فایل صوتی

Text

True/false

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

Conf

String

 

End

String

زمان پایان گفتار متن

Start

String

زمان شروع گفتار متن

Word

String

متن پردازش شده

space_after

True/false

در صورتی که بعد از متن فاصله با (space) باشد این مقدار true خواهد بود

کدهای خطای سرویس

کد

عنوان

توضیحات

429

اتمام اعتبار

اعتبار سرویس به پایان رسیده است

430

آدرس اینترنتی ارسالی نامعتبر است

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

431

فایل ارسال شده غیر مجاز است

درصورتی که محتوای فایل غیر مجاز باشد

432

شناسه پیگیری یافت نشد یا غیر مجاز است

درصورت عدم دریافت میبایست سرویس مجدد فراخانی گردد

433

 خطای در انجام پردازش

در صورتی که در هر مرحله پردازش دچار اختلال شود.

کدهای وضعیت سرویس

کد

عنوان

توضیحات

200

Downloading

درحال دریافت فایل از آدرس اینترنتی وارد شده

250

Processing

اطلاعات با موفقیت دریافت شده و درحال پردازش میباشد

251

Waiting

اطلاعات پردازش شده و درحال ایجاد پاسخ می باشد

252

Completed

پاسخ سرویس آماده شده است

253

Uploading

در حال بارگزاری فایل پردازش شده

254

Corrupted_url

خطا در دریافت فایل از آدرس ارسال شده

Clasor npm package version 2.1.4
به پادیوم قدرت داده اند:
pasargad
fanap
pod