This API will soon be deprecated. Please use another API.

    Add a Message Callback

    Specifies the client's message receiving server. Only HTTPS is accepted for the server, and if the callback URL is set to an empty string, it will not send a callback.

    You can also specify the callbackEventList parameter to selectively receive events you want.

    You can specify the following message types to receive a callback.

    Message type Description Client version
    text Text Available in all versions.
    location Location information Available in the client v2.2 or later.
    sticker Sticker Available in the client v2.3 or later. (new)
    image Image Available in the client v2.3 or later. (new)

    Note

    • Self-signed certificates are not allowed.
    • To see the list of allowed certificate authorities, refer to CA List.

    API Type

    Server API

    Request URL

    https://apis.worksmobile.com/{API ID}/message/setCallback/v2

    HTTP Method

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

    Request

    Parameter Type Required Description
    botNo number Y Message bot number for which you want to add a callback
    callbackUrl string Y Client's message receiving server (HTTPS only)
    callbackEventList array<string> Y Event type to receive. More event types will be added later.
    ● "text": Plain text
    ● "location": Location information
    ● "sticker": Sticker
    ● "image": Image

    Request Example

    {
        "botNo": 123,
        "callbackUrl": "https://xxx",
        "callbackEventList": ["text", "location", "sticker", "image"]
    }
    

    Response

    It returns code 200 when the API call is successful.

    {"code": 200, "message": "OK"}