Event webhook.

POSTRequest

import { RecranetApiClient } from "@recranet/sdk";

const client = new RecranetApiClient({ apiKey: process.env.RECRANET_API_KEY! });

const result = await client.voip.webhook({
  reference: "<reference>",
});

Responses

200400

Response 200

Successful response

application/json

Example responseGenerated from schema

{
  "id": 0,
  "reference": "reference",
  "status": "status",
  "source": "source",
  "destination": "destination",
  "direction": "direction",
  "beginDate": "beginDate",
  "endDate": "endDate",
  "answerDate": "answerDate",
  "answered": false,
  "duration": 0,
  "notes": "notes",
  "reservation": {
    "id": 1000
  },
  "guest": {
    "id": 1000
  },
  "user": {
    "id": 1000
  }
}

Response 400

Bad request

application/json

Example 1

{
  "statusCode": 400,
  "description": "Bad request",
  "errors": [
    "Bad request"
  ]
}

Request body

Required

No

Content type

• application/json

• eventstringoptional
  Allowed values: call, reservation-change-note

  Event type - defaults to “call” if not specified

• referencestringrequired

  Unique reference for this webhook event

• sourcestringoptional

  Source phone number (required for call events)

• destinationstringoptional

  Destination phone number (required for call events)

• statusstringoptional
  Allowed values: queued, starting, ringing, ongoing, busy, hangup, no-answer

  Call status (required for call events)

• directionstringoptional
  Allowed values: in, out

  Call direction (required for call events)

• beginDatestringoptional

  Call begin date in UTC (required for call events)

• endDatestringoptional

  Call end date in UTC (required for call events)

• answerDatestringoptional

  Call answer date in UTC (required for call events)

• answeredbooleanoptional

  Whether call was answered (required for call events)

• durationnumberoptional

  Call duration in seconds (required for call events)

• notesstringoptional

  Notes content (optional - triggers reservation-change-note creation when combined with reservation.id)

• reservationobjectoptional

  Reservation association (optional)

  Show 1 property

  • idnumberrequired

    Reservation ID

• userobjectoptional

  User association (optional)

  Show 1 property

  • idnumberrequired

    User ID

Returns

Schema shown for 200 · application/json

• idnumber
• referencestring
• sourcestringoptional
• destinationstringoptional
• statusstring
• directionstringoptional
• beginDatestringoptional
• endDatestringoptional
• answerDatestringoptional
• answeredbooleanoptional
  Default: false
• durationnumberoptional
  Default: 0
• notesstringoptional
• reservationobjectoptional
  Show 1 property

  • idnumberoptional
• guestobjectoptional
  Show 1 property

  • idnumberoptional
• userobjectoptional
  Show 1 property

  • idnumberoptional