rubika-bot 1.0.7

Rubika Bot Library

Rubika has created APIs for you that you can use to build your own "bot".

Requirements

• python3.8 +

Steps of use

• First you have to create a bot for yourself with Bot Father.
• Hold the token it gives you and use it in the rest of the steps.
• Using your desired method and token, create your URL in the following format and request POST.

https://messengerg2b1.iranlms.ir/v3/{token}/{method}

• If you use the python language, you can also use the rubika-bot package.

Description

After you have built your bot in Bot Father and defined your endpoint, the system will send any event or message sent to your bot to your Endpoint in one of the following two ways.

• Endpoint/receiveUpdate
• Endpoint/receiveInlineMessage

receiveUpdate

Whenever a user sends a message or taps on a keypad , you will receive this type of request.

sample body :

{
    "inline_message": {
        "sender_id": "u0QFtn01dd26d72abc5c77b8e116cd79",
        "text": "custom text",
        "location": null,
        "aux_data": {
            "start_id": null,
            "button_id": "61f674bd0abcd57b5b816a7c"
        },
        "message_id": "204216801381244279",
        "chat_id": "b0QFtabc1I02214b529f1d60c9ce5b08"
    }
}

• sender_id: Unique identifier assigned to the user.
• text: The text of the sent button.
• button_id: The ID you set for the button.
• message_id: The unique identifier assigned to the message.
• chat_id: Unique identifier for the conversation between the user and the bot (you must continue to use this identifier.)

receiveInlineMessage

Whenever the user taps on the inline keypad, you receive this type of request.

sample body :

{
  "update": {
      "type": "NewMessage",
      "chat_id": "b0QFtn0C1I022abcd29f1d60c9ce5b08",
      "new_message": {
          "message_id": 204215121115944300,
          "text": "custom text",
          "time": "1643122902",
          "is_edited": false,
          "sender_type": "User",
          "sender_id": "u0QFtn0abcded727585c77b8e116cd79",
          "aux_data": {
              "start_id": null,
              "button_id": "61f674bd0abcd57b5b816a7c"
          }
      }
  }
}

• type: can be NewMessage , StartedBot , StoppedBot and ....
• text: The text of the sent button.
• button_id: is the identifier you set for the button.
• message_id: The unique identifier assigned to the message.
• chat_id: Unique identifier for the conversation between the user and the bot (you must continue to use this identifier.)