# ایجاد تماس POST

اولین مرحله در هر تماس ایجاد تماس در سرور کاوه نگار می باشد. با این متد می توانید یک تماس ایجاد کنید. تماس بین caller ( تماس گیرنده) و receptor (گیرنده تماس) صورت می گیرد.

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

# URL

https://api.kavenegar.io/user/v1/calls

# پارامترهای POST

نام نوع توضیحات وضعیت
caller.username String شناسه منصر به فرد تماس گیرنده Required
caller.displayName String نام نمایشی تماس گیرنده Optional
caller.platform String پلتفرم تماس گیرنده که می تواند ios یا android باشد. Optional
receptor.username String شناسه منحصر به فرد گیرنده تماس Required
receptor.displayName String نام نمایشی گیرنده تماس Optional
receptor.platform String پلتفرم گیرنده تماس که می تواند ios یا android باشد. Optional
maxDuration Integer حداکثر زمان مکالمه بر حسب ثانیه Optional

# مثال

# درخواست

{
    "caller" : {
        "username" : "mohsen_k", 
        "displayName" : "mohsen karimi",
        "platform" : "android"
    },
    "receptor" : {
        "username" : "mohammad_r",
        "displayName" : "mohammad razipour",
        "platform" : "ios"
    },
    "maxDuration" : 100
}

# خروجی

{
    "id": "eead251d-7895-4954-9292-cee624e400b4",
    "createdAt": "2018-08-26T16:18:18.163",
    "status": "new",
    "caller": {
        "id": 153,
        "username": "mohsen_k",
        "displayName": "mohsen karimi",
        "accessToken": "a5064978-542a-4dc9-883d-fc33c6aa2345",
        "events": []
    },
    "receptor": {
        "id": 154,
        "username": "mohammad_r",
        "displayName": "mohammad razipour",
        "accessToken": "9c161bd8-0f73-46b5-970b-c2866a45ec51",
        "events": []
    }
}

نکته ها

  • فیلد ‍‍ ‍username باید یک شناسه منحصر بفرد باشد. و می تواند شماره همرا و یا ایمیل کاربر باشد. و حداکثر می توانید ۵۰ کاراکتر باشد.

  • در صورتی که displayName را ارسال نکنید از مقدار قبلی ذخیره شده استفاده می شود.

  • در صورتی که کاربری با ‍username ارسال شده وجود نداشته باشد قبل کاربر به صورت خودکار ایجاد می شود.

  • زمانی که فیلد maxDuration را مقدار دهی می کنید (در صورتی که در تنظیمات برنامه حداکثر تماس بر روی نامحدود قرار گرفته باشد در غیر اینطورت مقدار حداکثر زمان تعیین شده در برنامه از اولویت بیشتری برخوردار است ) تماس بعد از مدت زمان تعیین شده به صورت خودکار قطع می شود.