وب سرویس چت آنلاین | NirTalk
راهنمای استفاده از وب سرویس وب سرویس چت آنلاین | NirTalk
نکته : برای دریافت token لطفا در تلگرام با آی دی @Ahmady_nirweb در ارتباط باشید.
توضیحات : برای استفاده از این سیستم 2 درخواست باید ارسال شود:
درخواست اول برای ایجاد گفتگو
مشخصات گفتگو و کاربران آن (2 نفر تا بینهایت) ارسال میشود تا گفتگو آن ایجاد شود
درخواست دوم برای ایجاد لینک ورود هر کاربر
برای ورود هر کاربر باید یک لینک ایجاد شود که یکبار مصرف بوده و کاربر فقط یکبار میتواند از آن استفاده کند.
آدرس پایه (Base URL)
https://n8n.nirweb.ir/webhook
1 – درخواست ساخت گفتگو
متد (Method)
POST
آدرس (URL)
{base url}/conversations
هدرها (Headers)
| کلید (Key) | مقدار (Value) |
|---|---|
Content-Type |
application/json |
| Authorization | Bearer <token> |
بدنه (Body)
| پارامتر (Parameter) | نوع (Type) | الزامی (Required) | توضیحات (Description) |
|---|---|---|---|
|
name
|
string |
بله | نام گفتگو |
|
start_at
|
time (ISO 8601) |
خیر | تاریخ شروع گفتگو |
|
end_at
|
time (ISO 8601) |
خیر | تاریخ پایان گفتگو |
|
first_message
|
string |
خیر | ارسال پیام پیش فرض در گفتگو |
|
members
|
array |
بله | آرایه از مشخصات کاربران گفتگو |
لیست کاربران (members)
هر کاربری که داخل لیست members است باید آرایه ای به صورت زیر داشته باشد
| پارامتر (Parameter) | نوع (Type) | الزامی (Required) | توضیحات (Description) |
|---|---|---|---|
|
external_user_id
|
string |
بله | شناسه یونیک کاربر که میتواند id کاربر در سیستم خودتان باشد |
|
display_name
|
string |
بله | نام نمایشی کاربر |
|
source_system
|
string |
بله | نام سیستم ایجاد کننده (مثال : paziresh24 ) |
|
username
|
string |
خیر | نام کاربری کاربر که میتواند همان شناسه کاربر باشد (برای سیستم ورود جداگانه در صورت نیاز) |
|
phone
|
string |
خیر | شماره موبایل کاربر |
|
email
|
string |
خیر | ایمیل کاربر |
|
role
|
string |
بله | نقش کاربر به انگلیسی (قابلیت هایی مانند پیام آماده بر اساس نقش اعمال میشود) |
نمونه درخواست (Example Request)
curl --location 'https://n8n.nirweb.ir/webhook/conversations' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token> ' \
--data-raw '{
"name": "گفتگو تست ",
"start_at": "2025-08-22T10:00:00Z",
"end_at": "2025-08-27T12:00:00Z",
"first_message":"یک متن تستی برای پیام پیش فرض گفتگو",
"members": [
{
"external_user_id":
"3694",
"display_name":
"رضا محمدی",
"source_system":
"paziresh24",
"username":
"reza",
"phone":
"09136642211",
"email":
"reza@gmail.com",
"role":
"doctor"
},
{
"external_user_id":
"8964",
"display_name":
"حسن میرجلیلی",
"source_system":
"paziresh24",
"username":
"hasan",
"phone":
"09138854466",
"email":
"hasan@gmail.com",
"role":
"doctor"
},
{
"external_user_id":
"442104",
"display_name":
"علی احمدی",
"source_system":
"paziresh24",
"username":
"ahmady",
"phone":
"09132241199",
"email":
"ahmady@gmail.com",
"role":
"user"
}
]
}'
بدنه پاسخ (Response Body)
در صورت موفقیت، HTTP status code 200 و پاسخ به شکل زیر خواهد بود:
{
"success": true,
"message": "گفتگو با موفقیت ایجاد شد",
"data": {
"conversation_id": "3694_8964_442104",
"conversation_title": "گفتگو 2 "
}
}
1 – درخواست ساخت لینک ورود
متد (Method)
POST
آدرس پایه (Base URL)
{base url}/token-links
هدرها (Headers)
| کلید (Key) | مقدار (Value) |
|---|---|
Content-Type |
application/json |
| Authorization | Bearer <token> |
بدنه (Body)
| پارامتر (Parameter) | نوع (Type) | الزامی (Required) | توضیحات (Description) |
|---|---|---|---|
|
external_user_id
|
string |
بله | شناسه کاربری که میخواهد وارد شود |
|
members
|
array |
خیر | یک لیست از آرایه external_user_id کاربران گفتگو برای ورود خودکار به گفتگو (مانند آرایه ساخت گفتگو ولی فقط به external_user_id نیاز است) |
نمونه درخواست (Example Request)
curl --location 'https://n8n.nirweb.ir/webhook/token-links' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{
"external_user_id": "8964",
"members": [
{
"external_user_id":
"442104"
},
{
"external_user_id":
"8964"
},
{
"external_user_id":
"3694"
}
]
}'
بدنه پاسخ (Response Body)
در صورت موفقیت، HTTP status code 200 و پاسخ به شکل زیر خواهد بود:
{
"success": true,
"message": "لینک اختصاصی کاربر ایجاد شد",
"data": {
"user_link": "https://chat.nirweb.ir/?code=rAeaJVR9EfEbaVvdnicJ8QuKBnr6vAQnjIgSYGKX2tZGIUgQbt3694NfTI7UsUvqgnZ5MP5qnllUCnXaiV6tQLjAVrQkukNSQmmxFOqc"
}
}
| توضیح | کد وضعیت |
|---|---|
| عملیات موفقیت آمیز | 200 |
| وقوع خطای منطقی | 400 |
| وجود خطا در فرآیند احراز هویت | 403 |
| تعداد درخواست غیر مجاز | 429 |
| خطای غیر منتظره | 500 |