VBScript Lua
This GSE action creates a new private message.
An example call routing script can be found in A.6 - Example: CreateMessage.
Configure action parameters
By double clicking a parameter in the list, you can edit it.
Domain Required
This is the URL of your IPS community page, for example: https://www.swyxforum.com
APIKey Required
This is the REST API Key to authenticate against your IPS community. You created it under 1 - Preparations.
Please make sure that you have configured the endpoint permissions correctly.
From Required
This is id of the IPS community user you want to use as sender of the message. You can obtain the id from the address line of your browser when opening that users' profile page:
To Required
This is id of the IPS community user you want to use asreceiver of the message. You can obtain the id from the address line of your browser when opening that users' profile page:
It is possible to send the message to multiple receivers simultaneously. In this case you need to give all receiver ids in a comma separated list, e.g. 1,2,3
Please note that this will only be supported by this GSE action from SwyxWare 14.10 (or newer) on.
Title Required
This is the title of the new message.
Body Required
This is the body/text of the new message
Configure action exits
Exit 0 (Default)
This exit will be reached when everyhting worked fine and the message was created. It is recommmended to name this exit "ok" or "created".
Exit 1
This exit will be reached when there was any kind of problem and no message has been created. It is recommended to name this exit "failed".
If you reach this exit you can refer to 3.7 - Trouble Shooting to figure what went wrong.
By Tom Wellige
