/register
to get a user id (save this), then DM the bot /client <client id>
to allow your client to DM you./pingu register <clientid>
to get a server ID (save this) & allow the client to message it. This is a channel-by-channel basis, so if you want the client to be able to message more than one channel, run the command in each channel you want to message.All endpoints are secured and require authentication. You must set the Authorization
header to the client's secret key.
Rest endpoint is throttled to 1 request every 200 milliseconds. (You really don't need to send 5 messages a second, let alone more than that)
Visit https://pingu.meta1203.com/lookup to view all users and servers associated with a client. Click on the resultant data to get the IDs you can use on the endpoint.
https://pingu.meta1203.com/{clientId}/send/{to}
Path parameters
{clientId}
- the ID of the client (required)
{to}
- the ID of the recipient, either a server or a user (required)
Request parameters (?param=value&...)
message
- the message to send. recommended to send this as the body, as this one has to be URL encoded.
channel
- a channel of the server to send the message to. ommit to send the message to all allowed channels.
Body
a message to send. you can either use the body (recommended) or the request parameter to set a message, but at least one has to be set.
Returns a boolean value representing whether or not the message was sent.
cURL example:
curl -H "Authorization: <secret>" -X POST -d "<message>" \
https://pingu.meta1203.com/<clientId>/send/<recipient id>