انواع پیام‌هایی که از طرف آیگپ به آدرس webhook ربات شما ارسال میشود، به شرح ذیل است:
پروتو ChatSendMessage#
پارامتر های پروتو ChatSendMessage:
| پارامتر | نوع | توضیحات |
|---|
| room_id | String | شناسه منحصربفرد کاربر عضو شده در ربات، که برای ارتباط ربات با آن کاربر از آن استفاده میشود |
| room_message | any | یک proto است که شامل محتوای پیام کاربر است . در ادامه برای هر نوع پیام جداگانه توضیح داده میشود |
1. دریافت پیام متنی#
| پارامتر | نوع | توضیحات |
|---|
| message | string | محتوای متن ارسالی کاربر |
| message_type | string | نوع داده ارسالی کاربر را مشخص می‌کند که در این نوع پیام مقدار TEXT است. |
| message_id | string | شناسه منحصربفرد پیام ارسال شده از طرف کاربر است |
| extra_type | string | نمایش میدهد که پیام از سمت کاربر ، گروه و یا کانال آمده است |
| author | any | یک آرایه از نوع json است که برای دسترسی به مشخصات مبدا پیام استفاده می شود |
2. دریافت تصویر#
| پارامتر | نوع | توضیحات |
|---|
| Attachment | any | محتوای عکس ارسالی کاربر است که شامل توکن عکس ، حجم عکس ، اسم عکس و .... |
| message_type | string | نوع داده ارسالی کاربر را مشخص می‌کند که در این نوع پیام مقدار IMAGE است. |
| message_id | string | شناسه منحصربفرد پیام ارسال شده از طرف کاربر است |
| extra_type | string | نمایش میدهد که پیام از سمت کاربر ، گروه و یا کانال آمده است |
| author | any | یک آرایه از نوع json است که برای دسترسی به مشخصات مبدا پیام استفاده می شود |
3. دریافت متن و تصویر#
| پارامتر | نوع | توضیحات |
|---|
| message | string | محتوای متن ارسالی کاربر |
| Attachment | any | محتوای عکس ارسالی کاربر است که شامل توکن عکس ، حجم عکس ، اسم عکس و .... |
| message_type | string | نوع داده ارسالی کاربر را مشخص می‌کند که در این نوع پیام مقدار IMAGE_TEXT است. |
| message_id | string | شناسه منحصربفرد پیام ارسال شده از طرف کاربر است |
| extra_type | string | نمایش میدهد که پیام از سمت کاربر ، گروه و یا کانال آمده است |
| author | any | یک آرایه از نوع json است که برای دسترسی به مشخصات مبدا پیام استفاده می شود |
4. دریافت فیلم#
| پارامتر | نوع | توضیحات |
|---|
| Attachment | any | محتوای فیلم ارسالی کاربر است که شامل توکن فیلم ، حجم فیلم ، اسم فیلم و .... |
| message_type | string | نوع داده ارسالی کاربر را مشخص می‌کند که در این نوع پیام مقدار VIDEO است. |
| message_id | string | شناسه منحصربفرد پیام ارسال شده از طرف کاربر است |
| extra_type | string | نمایش میدهد که پیام از سمت کاربر ، گروه و یا کانال آمده است |
| author | any | یک آرایه از نوع json است که برای دسترسی به مشخصات مبدا پیام استفاده می شود |
5. دریافت فیلم و متن#
| پارامتر | نوع | توضیحات |
|---|
| message | string | محتوای متن ارسالی کاربر |
| Attachment | any | محتوای فیلم ارسالی کاربر است که شامل توکن فیلم ، حجم فیلم ، اسم فیلم و .... |
| message_type | string | نوع داده ارسالی کاربر را مشخص می‌کند که در این نوع پیام مقدار VIDEO_TEXT است. |
| message_id | string | شناسه منحصربفرد پیام ارسال شده از طرف کاربر است |
| extra_type | string | نمایش میدهد که پیام از سمت کاربر ، گروه و یا کانال آمده است |
| author | any | یک آرایه از نوع json است که برای دسترسی به مشخصات مبدا پیام استفاده می شود |
6. دریافت موزیک#
| پارامتر | نوع | توضیحات |
|---|
| Attachment | any | محتوای موزیک ارسالی کاربر است که شامل توکن موزیک ، حجم موزیک ، اسم موزیک و .... |
| message_type | string | نوع داده ارسالی کاربر را مشخص می‌کند که در این نوع پیام مقدار AUDIO است. |
| message_id | string | شناسه منحصربفرد پیام ارسال شده از طرف کاربر است |
| extra_type | string | نمایش میدهد که پیام از سمت کاربر ، گروه و یا کانال آمده است |
| author | any | یک آرایه از نوع json است که برای دسترسی به مشخصات مبدا پیام استفاده می شود |
7. دریافت موزیک و تصویر#
| پارامتر | نوع | توضیحات |
|---|
| message | string | محتوای متن ارسالی کاربر |
| Attachment | any | محتوای موزیک ارسالی کاربر است که شامل توکن موزیک ، حجم موزیک ، اسم موزیک و .... |
| message_type | string | نوع داده ارسالی کاربر را مشخص می‌کند که در این نوع پیام مقدار AUDIO_TEXT است. |
| message_id | string | شناسه منحصربفرد پیام ارسال شده از طرف کاربر است |
| extra_type | string | نمایش میدهد که پیام از سمت کاربر ، گروه و یا کانال آمده است |
| author | any | یک آرایه از نوع json است که برای دسترسی به مشخصات مبدا پیام استفاده می شود |
8. دریافت صوت#
| پارامتر | نوع | توضیحات |
|---|
| Attachment | any | محتوای صوت ارسالی کاربر است که شامل توکن صوت ، حجم صوت ، اسم صوت و .... |
| message_type | string | نوع داده ارسالی کاربر را مشخص می‌کند که در این نوع پیام مقدار VOICE است. |
| message_id | string | شناسه منحصربفرد پیام ارسال شده از طرف کاربر است |
| extra_type | string | نمایش میدهد که پیام از سمت کاربر ، گروه و یا کانال آمده است |
| author | any | یک آرایه از نوع json است که برای دسترسی به مشخصات مبدا پیام استفاده می شود |
9. دریافت فایل#
| پارامتر | نوع | توضیحات |
|---|
| Attachment | any | محتوای فایل ارسالی کاربر است که شامل توکن فایل ، حجم فایل ، اسم فایل و .... |
| message_type | string | نوع داده ارسالی کاربر را مشخص می‌کند که در این نوع پیام مقدار FILE است. |
| message_id | string | شناسه منحصربفرد پیام ارسال شده از طرف کاربر است |
| extra_type | string | نمایش میدهد که پیام از سمت کاربر ، گروه و یا کانال آمده است |
| author | any | یک آرایه از نوع json است که برای دسترسی به مشخصات مبدا پیام استفاده می شود |
10. دریافت فایل و متن#
| پارامتر | نوع | توضیحات |
|---|
| message | string | محتوای متن ارسالی کاربر |
| Attachment | any | محتوای فایل ارسالی کاربر است که شامل توکن فایل ، حجم فایل ، اسم فایل و .... |
| message_type | string | نوع داده ارسالی کاربر را مشخص می‌کند که در این نوع پیام مقدار FILE_TEXT است. |
| message_id | string | شناسه منحصربفرد پیام ارسال شده از طرف کاربر است |
| extra_type | string | نمایش میدهد که پیام از سمت کاربر ، گروه و یا کانال آمده است |
| author | any | یک آرایه از نوع json است که برای دسترسی به مشخصات مبدا پیام استفاده می شود |
11. دریافت مکان#
| پارامتر | نوع | توضیحات |
|---|
| location | any | محتوای مکان ارسالی کاربر است که شامل طول و عرض جغرافیایی است |
| message_type | string | نوع داده ارسالی کاربر را مشخص می‌کند که در این نوع پیام مقدار LOCATION است. |
| message_id | string | شناسه منحصربفرد پیام ارسال شده از طرف کاربر است |
| extra_type | string | نمایش میدهد که پیام از سمت کاربر ، گروه و یا کانال آمده است |
| author | any | یک آرایه از نوع json است که برای دسترسی به مشخصات مبدا پیام استفاده می شود |
12. دریافت مخاطبین#
| پارامتر | نوع | توضیحات |
|---|
| contact | any | محتوای مخاطب ارسالی کاربر است که شامل نام ،نام خانوادگی ، شماره تماس و .... می باشد |
| message_type | string | نوع داده ارسالی کاربر را مشخص می‌کند که در این نوع پیام مقدار CONTACT است. |
| message_id | string | شناسه منحصربفرد پیام ارسال شده از طرف کاربر است |
| extra_type | string | نمایش میدهد که پیام از سمت کاربر ، گروه و یا کانال آمده است |
| author | any | یک آرایه از نوع json است که برای دسترسی به مشخصات مبدا پیام استفاده می شود |
13. دریافت استیکر#
| پارامتر | نوع | توضیحات |
|---|
| Attachment | any | محتوای ستیکر ارسالی کاربر است که شامل توکن صوت ، حجم صوت ، اسم صوت و .... |
| message_type | string | نوع داده ارسالی کاربر را مشخص می‌کند که در این نوع پیام مقدار STICKER است. |
| message_id | string | شناسه منحصربفرد پیام ارسال شده از طرف کاربر است |
| extra_type | string | نمایش میدهد که پیام از سمت کاربر ، گروه و یا کانال آمده است |
| author | any | یک آرایه از نوع json است که برای دسترسی به مشخصات مبدا پیام استفاده می شود |
| Additional_type | number | عدد ۴ می باشد |