Send a push notification to one user (user_id), a list (user_ids, up to 1,000), a topic, or everyone (all: true). Give exactly one target. A push to one user, sent now, answers with its result at once; others answer with status sending or scheduled. With a test key (sk_test_) only test devices receive it.
輸入參數allbodydatalinkimagetitletopicfieldssend_atuser_idtemplateuser_ids另有 3 個
One push by id: status, devices, sent and failed, per platform.
輸入參數id必填
Pushes, newest first. On the Free plan only pushes still to go are listed (no delivery logs).
輸入參數limitbefore
cancel_push
Cancel a scheduled push
Cancel a push that is scheduled and has not started sending.
輸入參數id必填
register_device
Register a device
Store a device's push token under your user id. Android and iOS tokens come from the Firebase or Apple SDK; for web, token is the PushSubscription as JSON.
輸入參數nametoken必填user_id必填platform必填
list_devices
List a user's devices
The devices registered for one user id, newest first, with platform and whether each is trusted for approvals.
輸入參數user_id必填
remove_device
Remove a device
Remove one device by id; it gets no more pushes.
輸入參數id必填
Topics with how many users each has.
無需輸入參數。
subscribe_topic
Subscribe a user to a topic
Add a user to a topic. The topic exists once it has a user.
輸入參數topic必填user_id必填
unsubscribe_topic
Unsubscribe a user from a topic
Take a user off a topic.
輸入參數topic必填user_id必填
list_templates
List templates
Saved push templates with their fields.
無需輸入參數。
get_template
Get a template
One template by name.
輸入參數name必填
save_template
Save a template
Create or replace a template. Put {{field}} where a value goes, or {{field|default}} for one with a fallback.
輸入參數bodydatalinkname必填imagetitle
delete_template
Delete a template
Delete a template by name. Pushes already made from it are not changed.
輸入參數name必填
create_approval
Ask a user to approve
Send an approval request to the user's trusted phone, with number matching. The user must have a phone enrolled through the SignOps SDK.
輸入參數context必填user_id必填
get_approval
Get an approval
An approval request's status: pending, approved, denied, expired or cancelled.
輸入參數id必填
cancel_approval
Cancel an approval
Cancel a pending approval request.
輸入參數id必填
list_passkeys
List a user's passkeys
The passkeys registered for one user id.
輸入參數user_id必填
get_authenticator
Get a user's authenticator
Whether a user has an authenticator app (TOTP) confirmed, when it was last used, backup codes left, and whether wrong codes have locked them.
輸入參數user_id必填
remove_authenticator
Remove a user's authenticator
Remove a user's authenticator app and backup codes, for a lost phone. They can enrol again.
輸入參數user_id必填
Clear the lock that five wrong codes in 15 minutes put on a user, and their count of wrong codes.
輸入參數user_id必填
export_user
Export a user's data
Everything SignOps holds on one user id as JSON: devices (tokens shortened), topics, passkeys, authenticator status, approvals of the last 90 days, consent history and pushes sent to them.
輸入參數user_id必填
get_consent
Get a user's consent
The latest consent answer per purpose for one user, like marketing_push, and the history.
輸入參數user_id必填
