API settings

هشدار

نسخه 1و2و3 منسوخ شده است

این قسمت مربوط به تنظیمات SEA و SA می‌باشد که به تشریح آن می‌پردازیم.

پارامترهای Simotel Event API

• API Enabled: مشخص می‌کند سرویس SEA فعال باشد یا خیر.
• API Version: سیموتل توانایی ارسال اطلاعات به سمت وب‌سرویس تحت فرمت‌های مختلف را دارد، بطور کلی دوقالب اصلی وجود دارد
  • سرویس های G (General): در سرویس های G تمام رویداد ها منحصرا به آدرس وب‌سرویس ارسال می گردند و فراهم کننده، رویدادها را با استفاده از پارامتر event_name تفکیک می کند.
  • سرویس های Rest:در سرویس های Rest، نام رویداد به انتهای آدرس اضافه شده و سپس اطلاعات به سمت وب‌سرویس ارسال می‌شوند.

نمونه‌ فراخوانی rest

Call <WebService_address>/newstateCall <WebService_address>/cdr

• API Method
  • Get: سیموتل داده ها در قالب پارامتر به وب‌سرویس ارسال می‌کند.
  • Post: از ورژن 4 (Rest4، G4)، داده‌ها با فرمت json در بدنه درخواست قرار گرفته و به سمت WebService ارسال می گردد. در ورژن های 2 و 3 همانند GET به صورت پارامتر ارسال می گردد.

نمونه فراخوانی سرویسG4:

Get

curl -u username:password --location --request GET \'http://192.168.51.193/call/?event_name=NewState&exten=991&state=Unavailable' --data-raw ''

Post

curl -u username:password --location --request POST 'http://192.168.51.193/call/' \--header 'Content-Type: application/json' \--data-raw '{"event_name": "NewState","exten": "991","state": "Unavailable"}'

نمونه فراخوانی سرویسRest4:

Get

curl -u username:password --location -- \request GET 'http://192.168.51.193/call/NewState?event_name=NewState&exten=991&state=Unavailable'

Post

curl -u username:password --location --request POST 'http://192.168.51.193/call/NewState' \--header 'Content-Type: application/json' \--data-raw '{"event_name": "NewState","exten": "991","state": "Unavailable"}'

• API Events: در این قسمت اطلاعات و رویدادهای سیستم دسته‌بندی شده اند و بسته به نیاز شما مشخص می‌کنید چه اطلاعاتی باید به سمت وب‌سرویس شما ارسال شود، رویدادها و اطلاعت آنها بصورت دقیق‌تر در بخش‌های آینده بررسی می‌شوند.

• API Address: در اینجا نیز آدرس وب‌سرویس قرار می‌گیرد.

• API Username: در صورتی که احرازهویتی از سمت وب‌سرویس انجام ‌شود،نام کاربری اینجا وارد می‌شود.

• API Password: در صورتی که احرازهویتی از سمت وب‌سرویس انجام ‌شود،رمزعبور اینجا وارد می‌شود.

پارامترهای SA

• Allow All IPs: با زدن تیک این بخش دسترسی تمامی IPها برای ارسال درخواست به سمت سیموتل باز می‌شود.

• Allowed IPs: در صورتی که IP خاصی مد نظر می‌باشد در این بخش وارد کنید و در نهایت دکمه Enter را وارد کنید.