net2phone Webhook API Specification

Webhooks give you the ability to receive a structured payload of data at the URL of your choice when certain events occur. To get started, set up a URL to receive events, then register it in net2phone.

A call is ringing. Triggers when an incoming call is ringing on any phone number in your net2phone account, or when an outgoing call is ringing its destination.

inbound & outbound

Payload

Example

{
  "id": "c998e523-3750-4ff4-9eac-76af1dc360b1",
  "event": "call_ringing",
  "timestamp": "2019-09-15T12:44:22Z",
  "direction": "inbound",
  "originating_number": "+15551112222",
  "dialed_number": "+17778885555",
  "user_name": "John Doe"
}

A call is answered. Triggers when an incoming call is answered on any phone number in your net2phone account, or when an outgoing call is answered by its destination.

inbound & outbound

Payload

Example

{
  "id": "c998e523-2750-4ff4-9eac-76af1dc360b2",
  "event": "call_answered",
  "timestamp": "2019-07-18T12:44:25Z",
  "direction": "inbound",
  "originating_number": "+15551112222",
  "dialed_number": "+17778885555",
  "user_name": "John Doe"
}

A call is answered and completed successfully. Triggers when an incoming call is completed on any phone number in your net2phone account, or when an outgoing call is completed.

inbound & outbound

Payload

Example

{
  "id": "c998e523-2750-4ff4-9eac-76af1dc360b3",
  "event": "call_completed",
  "timestamp": "2019-09-15T12:45:25Z",
  "direction": "inbound",
  "duration": 60,
  "recorded": "true",
  "originating_number": "+15551112222",
  "dialed_number": "+17778885555",
  "user_name": "John Doe"
}

A call is not answered by the recipient. Triggers when an incoming call is not answered by any phone in your net2phone account.

inbound only

Payload

Example

{
  "id": "c998e523-2750-4ff4-9eac-76af1dc360b3",
  "event": "call_missed",
  "timestamp": "2019-09-15T12:45:25Z",
  "direction": "inbound",
  "originating_number": "+15551112222",
  "dialed_number": "+17778885555",
  "user_name": "John Doe"
}

A voicemail was left for a net2phone user. Triggers when an incoming call is not answered by any phone in your net2phone account and a voicemail is recorded.

inbound only

Payload

Example

{
  "id": "c998e523-2750-4ff4-9eac-76af1dc360b3",
  "event": "voicemail_received",
  "timestamp": "2019-09-15T12:45:25Z",
  "direction": "inbound",
  "originating_number": "+15551112222",
  "dialed_number": "+17778885555",
  "user_name": "John Doe"
}

Glossary

Conventions

• Client — The client application.
• All responses are in JSON format.
• All request parameters are mandatory unless explicitly marked as [optional].
• Parameter value types are shown as [10|<any number>] — the | symbol means OR. Default values for optional parameters are shown in bold.

HTTP Status Codes