Send a videocall push

Sends a push notification to specified user IDs to alert them of an incoming video call. Generates a video calling code.

POST /send-videocall-push

Error

A valid request URL is required to generate request examples

200

{
  "status": "success",
  "code": "ABC123XYZ",
  "id": "a45f9c5d-c6a6-4c7b-b8f4-2d9d1e1f2a3b",
  "recipients": 2
}

Body

application/json

user_ids · integer[] · required

List of user IDs to send the video call push notification to.

Example:

[201, 202]

Response

200

application/json

Push notification sent successfully, including the generated video call code.

status · string

Example:

"success"

code · string

Generated video calling code.

Example:

"ABC123XYZ"

id · string

OneSignal notification ID.

Example:

"a45f9c5d-c6a6-4c7b-b8f4-2d9d1e1f2a3b"

recipients · integer

Number of recipients the notification was sent to.

Example:

2