Send an E2EE test notification to mobile device(s)
POST https://infinispan.zulipchat.com/api/v1/mobile_push/e2ee/test_notification
Trigger sending an end-to-end encrypted (E2EE) test push notification
to the user's selected mobile device or all of their mobile devices.
Changes: New in Zulip 11.0 (feature level 420).
Usage examples
curl -sSX POST https://infinispan.zulipchat.com/api/v1/mobile_push/e2ee/test_notification \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY \
--data-urlencode push_account_id=111222
Parameters
push_account_id integer optional
Example: 111222
The push account ID for the device to which to send the test notification.
If this parameter is not submitted, the E2EE test notification will
be sent to all of the user's devices registered on the server.
A mobile client should pass this parameter, to avoid triggering a test
notification for other clients.
See POST /mobile_push/register
for details on push account IDs.
Response
Example response(s)
Changes: As of Zulip 7.0 (feature level 167), if any
parameters sent in the request are not supported by this
endpoint, a successful JSON response will include an
ignored_parameters_unsupported array.
A typical successful JSON response may look like:
{
"msg": "",
"result": "success"
}
No active push device
A typical failed JSON response for when no registered device is available
for the user (and push_account_id) to receive a push notification.
{
"code": "NO_ACTIVE_PUSH_DEVICE",
"msg": "No active registered push device",
"result": "error"
}
Admin action required
A typical failed JSON response for when there is a push notification
configuration issue on the server, such as invalid credentials,
an expired plan, or an unregistered organization. Admin action is required.
{
"code": "ADMIN_ACTION_REQUIRED",
"msg": "Push notification configuration issue on server, contact the server administrator or retry later.",
"result": "error"
}
Failed to connect bouncer
A typical failed JSON response for when a network error occurs
while the server attempts to connect to the bouncer server.
{
"code": "FAILED_TO_CONNECT_BOUNCER",
"msg": "Network error while connecting to Zulip push notification service.",
"result": "error"
}
Internal bouncer server error
A typical failed JSON response for when a 5xx error occurs on the bouncer server.
{
"code": "INTERNAL_SERVER_ERROR_ON_BOUNCER",
"msg": "Internal server error on Zulip push notification service, retry later.",
"result": "error"
}