مفاهیم اولیه

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

هشدار

برای افزایش امنیت حتما باید از وب سرویس کاوه نگار در اپلیکیشن سمت سرور خود استفاده کنید و به هیچ عنوان از وب سرویس کاوه نگار در اپلیکیشن موبایل استفاده کنید.

نکات

  • خروجی و ورودی وب سرویس به فرمت JSON می باشد. یعنی در حالت POST و PUT ورودی ارسالی باید حتما به صورت JSON ارسال شود.

  • فرمت تمامی تاریخ ها به صورت ISO می باشد. به طور مثال :‌ 2018-08-26T16:18:18.163

احراز هویت

برای استفاده از سرویس تماس اینترنتی کاوه نگار باید یک اپلیکیشن بسازید. بعد از ساخت اپلیکیشن شما یک API-Token دریافت می کنید.

برای اجرای هر یک از متدهای وب سرویس باید API-Token را در Header درخواست به صورت زیر قرار دهید :

request.addHeader("Authorization", "Bearer " + apiToken);

خطاها

زمانی که Status Code خروجی درخواست مخالف ‍‍200 باشد. یعنی مشکلی در اجرای متد فوق وجود دارد و حاوی خطا می باشد.

قالب کلی خطاها به صورت زیر می باشد :

{
    "status": "bad_request",
    "reasons": [
        "invalid_input_parameter"
    ]
}

نکته

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