Send Messages

    Makes a message bot send messages to a specific user.

    Specify an account, which can be an email address or a group name, in accountId to send messages.

    Carousel and Image Carousel are available in the client software version 2.6 or later, and Flexible Template is available in the client software version 3.0 or later, helping you send a variety of information to users. In addition, you can add “quick reply,” a common message property, to each message type to send additional information to users.

    Using each template or the quick reply button, you can allow the server to receive a postback message as a callback. For the postback type, refer to Receive Messages - Callback Type.

    Caution

    • There are quotas on API requests based on the number of users.
      • When the number of users does not exceed 100: up to 20,000 requests per day
      • When the number of users is over 100: up to 20,000 requests per day + 100 requests per extra user
      • The number of API requests will be reset at midnight based on GMT +9.
      • When the number of API requests reaches 80%, 90%, and 100% of the quota, a notification message on this will be sent to the Admin.

    The structures of each template and quick reply are shown below.

    [Figure 1 button template]

    [Figure 2 list template]

    [Figure 3 Carousel template]

    [Figure 4 Image carousel template]

    [Figure 5 Flexible template]

    [Figure 6 quick reply]

    API Type

    Server API

    Request URL

    https://apis.worksmobile.com/r/{API ID}/message/v1/bot/{botNo}/message/push

    HTTP Method

    POST(Content-Type: application/json; charset=UTF-8)

    Common Path Parameters

    Parameter Required Description
    botNo Y Message bot number used to send a message.

    Common Request Information

    Parameter Type Required Description
    accountId string N User account to which you want to send a message.
    Either roomId or accountId must be specified (required).
    roomId string N Room ID to which you want to send a message.
    Either roomId or accountId must be specified (required).
    content object Y Message content
    ○ type "text": See "Request Content" in "Send Messages (Text)."
    ○ type "image": See "Request Content" in "Send Messages (Image)."
    ○ type "link": See "Request Content" in "Send Messages (Link)."
    ○ type "sticker": See "Request Content" in "Send Messages (Sticker)."
    ○ type "buttonTemplate": See "Request Content" in "Send Messages (Button Template)."
    ○ type "listTemplate": See "Request Content" in "Send Messages (List Template)."
    ○ type "carousel": See "Request Content" in "Send Messages (Carousel)." (New)
    ○ type "image carousel": See "Request Content" in "Send Messages (Image Carousel)." (New)
    ○ type "file": See "Request Content" in "Send Messages (File)." (New)
    ○ type "flex": See "Request Content" in "Send Messages (Flexible Template > API)." (New)