این بخش از کتابخانه برای ارسال پیام نوشته شده است. البته در دیگر بخش ها نیز امکان ارسال پیام وجود دارد. اما بیشتر متد ها و اصلی ترین انها در این قسمت نوشته شده اند.

$app->Messages->{...};

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

/**
 * send text to someone or somewhere
 *
 * @param string $guid object_guid
 * @param string $text message (can be with markworn metadatas)
 * @param int $reply_to_message_id if you have to reply
 * @return array API result
 */
public function sendMessage(string $guid, string $text, int $reply_to_message_id = 0): array

برای مشاهده نمونه خروجی بر روی تصویر زیر کلیک کنید:

توضیحات پارامتر ها:

/**
 * Edit Message Text
 *
 * @param string $guid object_guid
 * @param string $newText message
 * @param int $message_id
 * @return array API result
 */
public function EditMessage(string $guid, string $newText, int $message_id): array

برای مشاهده نمونه خروجی بر روی تصویر زیر کلیک کنید:

توضیحات پارامتر ها:

/**
 * delete message from chat
 *
 * @param string $object_guid
 * @param array|int $message_id
 * @param DeleteType $type local or global
 * @return array API result
 */
public function deleteMessages(string $object_guid, array|int $message_id, DeleteType $type = DeleteType::Local): array

توضیحات پارامتر ها:

نمونه خروجی: کلیک کنید

/**
 * send photo to chat
 *
 * @param string $guid
 * @param string $path image path
 * @param boolean $isLink is $path a link or not
 * @param string $caption
 * @param string $thumbnail base64 encoded picture
 * @param string $reply_to_message_id
 * @return array API result
 */
public function sendPhoto(
    string $guid,
    string $path,
    bool $isLink = false,
    string $caption = '',
    string $thumbnail = '',
    string $reply_to_message_id = '',
): array

برای مشاهده نمونه خروجی بر روی تصویر زیر کلیک کنید:

توضیحات پارامتر ها:

/**
 * send video to guid
 *
 * @param string $guid
 * @param string $path file path or url
 * @param boolean $isLink is $path a URL or not
 * @param string $caption
 * @param string $thumbnail base64 encoded thumbnail picture
 * @param string $reply_to_message_id
 * @return array API result
 */
public function sendVideo(
    string $guid,
    string $path,
    bool $isLink = false,
    string $caption = '',
    string $thumbnail = '',
    string $reply_to_message_id = '',
): array

برای مشاهده نمونه خروجی بر روی تصویر زیر کلیک کنید:

توضیحات پارامتر ها:

/**
 * send Document To Chat
 *
 * @param string $guid
 * @param string $path file path or link
 * @param boolean $isLink is $path a link or not
 * @param string $caption
 * @param string $reply_to_message_id
 * @return array API result
 */
public function sendDocument(
    string $guid,
    string $path,
    bool $isLink = false,
    string $caption = '',
    string $reply_to_message_id = '',
): array

برای مشاهده نمونه خروجی بر روی تصویر زیر کلیک کنید:

توضیحات پارامتر ها:

/**
 * send music to guid
 *
 * @param string $guid
 * @param string $path path or link
 * @param MusicFile|null $options
 * @param boolean $isLink if $path is a link
 * @param string $caption
 * @param string $thumbnail
 * @param string $reply_to_message_id
 * @return array API result
 */
public function sendMusic(
    string $guid,
    string $path,
    MusicFile|null $options = null,
    bool $isLink = false,
    string $caption = '',
    string $thumbnail = '',
    string $reply_to_message_id = '',
): array

برای مشاهده نمونه خروجی بر روی تصویر زیر کلیک کنید:

توضیحات پارامتر ها:

/**
 * send gif to guid
 *
 * @param string $guid
 * @param Gif $gif if you want to send an uploaded gif
 * @param string $path file path or url
 * @param boolean $isLink is $path a URL or not
 * @param string $caption
 * @param string $thumbnail base64 encoded thumbnail picture
 * @return array API result
 */
public function sendGif(
    string $guid,
    Gif|null $gif = null,
    string $path,
    bool $isLink = false,
    string $caption = '',
    string $thumbnail = '',
    string $reply_to_message_id = '',
): array

توجه کنید که یا فقط $path را پاس دهید یا $gif را. در غیر این صورت یک Failure دریافت دریافت میکنید.
لیست توضیحات پارامتر هارا نیز میبینید:

نمونه خروجی: کلیک کنید

/**
 * forward message text
 *
 * @param string $from_object_guid
 * @param array $message_ids
 * @param string $to_object_guid
 * @return array API result
 */
public function ForwardMessages(string $from_object_guid, array $message_ids, string $to_object_guid): array

برای مشاهده نمونه خروجی بر روی تصویر زیر کلیک کنید:

توضیحات پارامتر ها:

/**
 * send message re-action
 *
 * @param string $guid
 * @param string $message_id
 * @param ReactionsEmoji|ReactionsString $reaction
 * @return array API result
 */
public function addMessageReaction(string $guid, string $message_id, ReactionsEmoji!ReactionsString $reaction): array
   

برای مشاهده نمونه خروجی بر روی تصویر زیر کلیک کنید:

توضیحات پارامتر ها:

/**
 * remove message re-action
 *
 * @param string $guid
 * @param string $message_id
 * @return array API result
 */
public function removeMessageReaction(string $guid, string $message_id): array
   

توضیحات پارامتر ها:

نمونه خروجی: کلیک کنید

/**
 * send poll to chat
 *
 * @param string $guid
 * @param string $question
 * @param boolean $is_anonymous
 * @param array $options example: ['option1', 'options2', ...]
 * @param pollType $type Regular or Quiz
 * @param string $explanation if $type if Quiz (can be empty)
 * @param integer $correct_option_index if $type is Quiz (required)
 * @param boolean $allows_multiple_answers it can't be set if $type is Quiz
 * @param string $reply_to_message_id
 * @return array API result
 */
public function createPoll(
    string $guid,
    string $question,
    array $options,
    PollType $type,
    bool $is_anonymous = false,
    string $explanation = '',
    int $correct_option_index = 0,
    bool $allows_multiple_answers = false,
    string $reply_to_message_id = '',
): array

برای مشاهده نمونه خروجی بر روی تصویر زیر کلیک کنید:

توجه داشته باشید که نظرسنجی ارسال یا باید به صورت regular باشد و یا به صورت quiz. اما در هر حالت میتوانید نظرسنجی ناشناس را فعال کنید یا نکنید.
توضیحات پارامتر ها:

/**
 * seen chat
 *
 * @param string $guid
 * @param string $last_message_id
 * @return array API result
 */
public function seenChat(string $guid, string $last_message_id): array

توضیحات پارامتر ها:

نمونه خروجی: کلیک کنید