چچ

دریافت پیام از سایر نرم افزارها

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

در این بخش می خواهیم، توابع و راهنمای استفاده از وب سرویس برای ارسال پیام توسط کوبات به داخل سرویس کولتفرم را تشریح کنیم. این وب سرویس با استفاده از استاندارد WSDL (Web Services Description Language) ارائه می شود. مشخصات و نحوه استفاده از این وب سرویس در ادامه تشریح شده است.

دسترسی به سرویس دهنده

برای فراخوانی توابع وب سرویس اولین گام دسترسی به آدرس سرویس دهنده می باشد.آدرس این وب سرویس به صورت زیر میباشد که باید TENANT_DOMAIN را با دامنه آدرس کولتفرم مقصد (آدرس اشتراک محیط کاری شما) جایگزین کنید:

مانند

نحوه استفاده از وب سرویس

تابع wsSendOnlineMessage
این وب سرویس شامل یک تابع با نام wsSendOnlineMessage است که شامل پارامتر های زیر می باشد. هدف از فراخوانی این تابع، ارسال پیام به یک کانال یا کاربر می باشد. شرح پارامتر ها در ادامه آمده است.
معرفی پارامترهای تابع wsSendOnlineMessage
نام پارامتر نوع پارامتر نادیده گرفتن توضیح
token string اجباری توکن محرمانه اتصال API
toUserName string null شناسه کاربر گیرنده پیام
toRoomId string null شناسه عددی کانال
message string اجباری متن پیام
replyToMessageId string null شناسه پیام (در صورتیکه پیام ارسالی، پاسخ یک پیام باشد)

نکته: دقت نمایید که فقط یکی از پارامترهای toUserName و toRoomId باید مقدار داشته باشد و یکی دیگر null ارسال شود.

ثبت پاسخ چند سطحی به پیام در کانال کولتفرم

توکن محرمانه اتصال API

این توکن مرمانه برای هر اشتراک کولتفرم به صورت انحصاری و منحصر به فرد ایجاد می شود. توکن از طریق منوی پیکربندی -> تنظیمات کولتفرم -> تنظیمات کوبات در دسترس کاربر مدیر اشتراک کولتفرم می باشد.

توجه: توکن را در اختیار افراد نامطمئن قرار ندهید. ولی اگر احساس کردید توکن در دسترس افراد ناشناس قرار گرفته است آن را مجدد تولید و ثبت کنید. توکن قبلی نامعتبر و بلا استفاده می شود.

توضیح: اگر خواستید می توانید آدرس IP استفاده کننده ها را تعریف و محدود کنید.

آدرس کوتاه شده:
فهرست طبقات