Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The outgoing messages and files from users will be sent as an HTTP request to your web server address in the format specified in the JSON file, namely API.SendMessage and API.SendFile methods, for example:

Code Block
languagejson
"API": {
    "SendMessage": {
        "request_method": "POST",
        "request_url": "https://api.example.com/webhook",
        "request_content_type": "application/json",
        "request_parameters": {
            "from": "$from$",
            "to": "$to$",
            "extension": "$extension$",
            "domain": "$domain$",
            "content": "$content$"
        },
        "response_map": {
            "data": {
                "id": "$messageid$"
            }
        }
    },
    "SendFile": {
        "request_method": "POST",
        "request_url": "https://api.example.com/webhook",
        "request_content_type": "application/json",
        "request_parameters": {
            "from": "$from$",
            "to": "$to$",
            "extension": "$extension$",
            "domain": "$domain$",
            "media_url": "$content$"
        },
        "response_map": {
            "data": {
                "id": "$messageid$"
            }
        }
    }
},

On the other hand, the Webhook object (section) describes the requests and parameters that your messaging server should send to the Ringotel server. You can send those requests in any format, but if you want to match the existing format of the Ringotel Messaging API, you can try something like this:

...