Webhooks

Call Received

Triggered when an incoming Voice or Video call is detected.

Best practices

  • Create a 'Missed Call' notification for your agents.

  • Detect if users are calling so your bot can tell them to send a text message instead.

Expected Responses

Explore all possible responses and outcomes from the server. We have documented each status code with data examples to make success and error handling easier.

Webhook Payload Example
application/json
string *
number *
string *
object *
string *
string *
object *
object *

Example

{
"id": "evt_01...",
"timestamp": 1634567890123,
"session": "default",
"metadata": {
  "user.id": "123",
  "user.email": "email@example.com"
  },
"engine": "WEBJS",
"event": "call.received",
"payload": {
  "id": "call_12345",
  "from": "11111111111@c.us",
  "isVideo": false
  },
"me": {
  "id": "11111111111@c.us",
  "lid": "123@lid",
  "pushName": "Instance"
  }
}
Previous TopicChat Archived/Unarchived
Next TopicCall Accepted

Command Palette

Search for a command to run...