ایران لایو استریم

مستندات وب‌سرویس

ایران لایو استریم

مستندات وب‌سرویس

ایران لایو استریم

مستندات وب‌سرویس

وب سرویس پخش زنده

آخرین به روز رسانی: 12 خرداد 1403

متد Create

از این متد جهت ایجاد یک پخش زنده استفاده فرمایید

آدرس متد

Method Urlhttps://livestream.iranhls.com/api/v1/Live/Create

داده ها می بایست بصورت multipart/form-data به این متد Post شود

پارامتر های ورودی

نام پارامتر نوع پارامتر ضروری توضیحات
customerId String بله کد مشتری است که در دریافت توکن آنرا گرفته اید
title String بله عنوان پخش زنده
directPlayEnable Boolean بله فعال بودن/یا نبودن آدرس پخش مستقیم لایو
chatEnable Boolean بله فعال بودن/یا نبودن چت روی پخش زنده
chatUserCount Boolean بله نمایش/عدم نمایش تعداد نفرات چت روم
liveUserCount Boolean بله نمایش/عدم نمایش تعداد بینندگان پخش زنده
playerActive Boolean دلخواه وضعیت پخش کننده لایو می تواند فعال یا غیرفعال باشد
chatOnLive Boolean دلخواه چت روی لایو باشد یا خیر، بصورت پیشفرض چت کنار لایو می باشد
allowDomains String دلخواه دامنه یا دامنه های مجاز به پخش - با ویرگول لاتین از هم جدا شود
allowIPs String دلخواه نمایش برای IP های خاص - با ویرگول لاتین از هم جدا شود
description String دلخواه این توضیح در صورت غیر فعال بودن پخش کننده و عدم تعریف زمان بندی، نمایش داده خواهد شد
coverFile file دلخواه کاور پخش زنده - تصویر 1280X720
endMessage String دلخواه پیام پایان پخش زنده، این پیام با زدن دکمه اتمام پخش در پنل به بینندگان نمایش داده خواهد شد

مقدار بازگشتی

مقدار بازگشتی در response کد پخش زنده شما می باشد

                                            
    {
        "success" : true,
        "response" : "65256",
        "error": ""
    }

متد Update

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

آدرس متد

Method Urlhttps://livestream.iranhls.com/api/v1/Live/Update

داده ها می بایست بصورت multipart/form-data به این متد Post شود

پارامتر های ورودی

نام پارامتر نوع پارامتر ضروری توضیحات
liveId String بله کد پخش زنده
title String بله عنوان پخش زنده
directPlayEnable Boolean بله فعال بودن/یا نبودن آدرس پخش مستقیم لایو
chatEnable Boolean بله فعال بودن/یا نبودن چت روی پخش زنده
chatUserCount Boolean بله نمایش/عدم نمایش تعداد نفرات چت روم
liveUserCount Boolean بله نمایش/عدم نمایش تعداد بینندگان پخش زنده
playerActive Boolean دلخواه تغییر وضعیت پخش کننده - فعال یا غیرفعال
chatOnLive Boolean دلخواه چت روی لایو باشد یا خیر، بصورت پیشفرض چت کنار لایو می باشد
allowDomains String دلخواه دامنه یا دامنه های مجاز به پخش - با ویرگول لاتین از هم جدا شود
allowIPs String دلخواه نمایش برای IP های خاص - با ویرگول لاتین از هم جدا شود
description String دلخواه این توضیح در صورت غیر فعال بودن پخش کننده و عدم تعریف زمان بندی، نمایش داده خواهد شد
coverFile file دلخواه کاور پخش زنده - تصویر 1280X720
endMessage String دلخواه پیام پایان پخش زنده، این پیام با زدن دکمه اتمام پخش در پنل به بینندگان نمایش داده خواهد شد

مقدار بازگشتی

مقدار بازگشتی در response همان کد پخش زنده اصلاح شده می باشد

                                            
    {
        "success" : true,
        "response" : "65256",
        "error": ""
    }

متد ChangeStatus

از این متد جهت فعال یا غیرفعال کردن پخش کننده استفاده می شود

آدرس متد

Method Urlhttps://livestream.iranhls.com/api/v1/Live/ChangeStatus

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

پارامتر های ورودی

نام پارامتر نوع پارامتر ضروری توضیحات
liveId String بله کد پخش زنده
playerActive Boolean بله وضعیت پخش کننده - فعال یا غیرفعال

مقدار بازگشتی

مقدار بازگشتی در response همان کد پخش زنده اصلاح شده می باشد

                                            
    {
        "success" : true,
        "response" : "65256",
        "error": ""
    }

متد Delete

از این متد جهت حذف پخش زنده استفاده فرمایید

آدرس متد

Method Urlhttps://livestream.iranhls.com/api/v1/Live/Delete/{id}

پارامتر های ورودی

نام پارامتر نوع پارامتر ضروری توضیحات
id string بله کد پخش زنده

مقدار id را در انتهای url بفرستید

مثال: https://.../api/v1/Live/delete/65256

توجه: در صورتی که پخش زنده سابقه پخش و استریم داشته باشد حذف نخواهد شد

مقدار بازگشتی

                                            
    {
        "success" : true,
        "response" : "پخش زنده حذف شد",
        "error": ""
    }

متد List

از این متد جهت دریافت لیست پخش زنده یک مشتری استفاده فرمایید

آدرس متد

Method Urlhttps://livestream.iranhls.com/api/v1/Live/List/{customerId}

پارامتر های ورودی

نام پارامتر نوع پارامتر ضروری توضیحات
customerId long بله کد مشتری

مقدار customerId را در انتهای url بفرستید

مثال: https://.../api/v1/live/list/42231

مقدار بازگشتی

                                            
    [
        {
            "Live_ID": "1001",
            "Live_Title": "عنوان پخش زنده",
            "Live_Cover": "https://livestream.iranhls.com/Files/DSePUvB4EiawBgXAOLxA/thumbnail.jpg",
            "Live_Description": "",
            "Live_CreateDate": "2022-01-19T07:42:02.393",
            "Live_UpdateDate": "2022-01-29T17:58:37.113",
            "Live_AllowDomains": "*",
            "Live_AllowIPs": "*",
            "Live_DirectPlayURL": "https://livestream.iranhls.com/Live/Play/10083/vhznSUnPmk2v4YhkSjcBfg",
            "Live_DirectPlayEnable": true,
            "Live_EmbedScript": "<script id='DSePUvB4EiawBgXAOLxA' src='https://livestream.iranhls.com/Live/Embed/DSePUvB4EiawBgXAOLxA'></script>",
            "Live_Status" : 1,
            "Live_StatusName" : "فعال",
            "Live_ChatEnable" : true,
            "Live_ChatUserCount" : true,
            "Live_EndMessage" : "پخش زنده پایان یافت، سپاس از همراهی شما",
            "Live_LiveUserCount" : true,
            "Live_RTMP" : "rtmp://live.iranhls.com/live/",
            "Live_StreamKey" : "DSePUvB4EiawBgXAOLxA",
            "Live_ChatOnLive" : false
        },
        {
            "Live_ID": "1002",
            ....
        },
        {
            "Live_ID": "1003",
            ....
        }
    ]

شرح مقادیر بازگشتی

نام پارامتر نوع پارامتر توضیحات
Live_ID String کد پخش زنده.
Live_Title String عنوان پخش زنده
Live_Cover String آدرس فایل کاور پخش زنده
Live_Description String شرح پخش زنده
Live_CreateDate String تاریخ و ساعت ایجاد
Live_UpdateDate String تاریخ و ساعت ویرایش
Live_AllowDomains String دامنه های مجاز به پخش لایو
Live_AllowIPs String آی پی های مجاز به تماشای لایو
Live_Status Int وضعیت پخش کننده
0 = غیر فعال
1 = فعال
Live_StatusName String وضعیت پخش کننده لایو
Live_DirectPlayURL String آدرس اینترنتی پخش مستقیم لایو
Live_DirectPlayEnable Boolean پخش مستقیم فعال است یا خیر
Live_EmbedScript String اسکریپت قرارگیری لایو روی وب سایت و اپ
Live_ChatEnable Boolean چت فعال است یا خیر
Live_ChatUserCount Boolean نمایش تعداد کاربران در چت روم
Live_LiveUserCount Boolean نمایش تعداد بینندگان در چت لایو
Live_ChatOnLive Boolean چت روی لایو هست یا خیر (یا کنار لایو)
Live_RTMP String آدرس rtmp جهت ارسال لایو به سرور
Live_StreamKey String کلید پخش زنده جهت ارسال لایو به سرور

متد Get

از این متد جهت دریافت اطلاعات یک پخش زنده استفاده فرمایید

آدرس متد

Method Urlhttps://livestream.iranhls.com/api/v1/Live/Get/{id}

پارامتر های ورودی

نام پارامتر نوع پارامتر ضروری توضیحات
id String بله کد پخش زنده

مقدار id را در انتهای url بفرستید

مثال: https://.../api/v1/live/get/1001

مقدار بازگشتی

                                            
    {
        "Live_ID": "1001",
        "Live_Title": "عنوان پخش زنده",
        "Live_Cover": "https://livestream.iranhls.com/Files/DSePUvB4EiawBgXAOLxA/thumbnail.jpg",
        "Live_Description": "",
        "Live_CreateDate": "2022-01-19T07:42:02.393",
        "Live_UpdateDate": "2022-01-29T17:58:37.113",
        "Live_AllowDomains": "*",
        "Live_AllowIPs": "*",
        "Live_DirectPlayURL": "https://livestream.iranhls.com/Live/Play/10083/vhznSUnPmk2v4YhkSjcBfg",
        "Live_DirectPlayEnable": true,
        "Live_EmbedScript": "<script id='DSePUvB4EiawBgXAOLxA' src='https://livestream.iranhls.com/Live/Embed/DSePUvB4EiawBgXAOLxA'></script>",
        "Live_Status" : 1,
        "Live_StatusName" : "فعال",
        "Live_ChatEnable" : true,
        "Live_ChatUserCount" : true,
        "Live_EndMessage" : "پخش زنده پایان یافت، سپاس از همراهی شما",
        "Live_LiveUserCount" : true,
        "Live_RTMP" : "rtmp://live.iranhls.com/live/",
        "Live_StreamKey" : "DSePUvB4EiawBgXAOLxA",
        "Live_ChatOnLive" : false
    }

شرح مقادیر بازگشتی

مانند جدول مقادیر بازگشتی متد List

متد ShowCTA

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

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

آدرس متد

Method Urlhttps://livestream.iranhls.com/api/v1/Live/ShowCTA

داده های ورودی

                                                
    {
        "LiveID": 1000,
        "Active": true,
        "Title": "This is a sample title",
        "Url": "http://example.com",
        "Bottom": 50
    }

شرح پارامترهای Json

نام پارامتر نوع پارامتر ضروری توضیحات
LiveID Long بله کد پخش زنده
Active Boolean بله وضعیت لینک - فعال یا غیرفعال
Title String بله عنوان نمایشی لینک
Url String بله آدرس لینک
Bottom String بله فاصله نمایش از پایین پخش کننده به پیکسل

داده های ورود بصورت Json به این متد بصورت POST ارسال شود

مقدار بازگشتی

                                            
    {
        "success": true,
        "response": "لینک ارسال شد",
        "error": ""
    }

متد HideCTA

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

آدرس متد

Method Urlhttps://livestream.iranhls.com/api/v1/Live/HideCTA

پارامتر ورودی

نام پارامتر نوع پارامتر ضروری توضیحات
liveId long بله کد پخش زنده

مقدار liveId را می توانید بصورت QueryString در انتهای url بصورت POST بفرستید

مثال: https://.../api/v1/live/HideCTA?liveId=1000

مقدار بازگشتی

                                                
    {
        "success": true,
        "response": "لینک برداشته شد",
        "error": ""
    }