This event is triggered when a user answers an incoming call or when an outgoing call is answered by the dialed number.

The response of the webhook endpoint is discarded, webhook requests are never retried.

This event is triggered when a user transfer a call to another user/department/ring group via blind transfer (default) option.

This event is triggered when you receive a call from a blocked (either at user level or account level) number.

The event is triggered when an outbound call receives a 4xx or 5xx error response to the INVITE indicating the call failed for some reason.

This event is triggered when a call (inbound/outbound) is completed. Doesn't matter if the call is answered/failed.

This event is triggered when a user transfers a call via consultative transfer (also referred as warm transfer).

This event is triggered when an incoming call is forwarded to the number specified in the call forwarding options of a user.

This event is triggered when a user (caller or callee) puts the call on hold.

This event is triggered when an incoming call isn’t answered by a user in your net2phone account.

This event is triggered when a user parks a call in a parking slot by pressing `#2` from the dial-pad while he is on a call.

This event is triggered when a user uses `pickup` feature (by dialing *97{other-user-extension}) to answer call ringing on another user extension.

This event is triggered when an inbound/outbound call has been successfully recorded.

This event is triggered when a call failed to record.

This event is triggered when a user (caller or callee) resumes the call from `hold` state.

This event is triggered when a call in a ring group completes by either being answered in a tier or the caller hangs up.

This event is triggered when a call enters a ring group with call queue enabled.

This event is triggered when a call waiting in a ring group with call queue enabled enters a tier which results in calls being sent to a user in that tier.

This event is triggered when a call is ringing. This event will trigger for both inbound and outbound calls and is typically followed by by a `call_answered` or `call_missed` event.

This event is triggered when a user retrieves a call from a parking slot.

This event is triggered when the click-to-call flow is completed, both for successful and failure cases. 
Please note that the `call_completed` event is also triggered for all click-to-call flows. One event can 
be expected per one click-to-call call. Direction field is always inbound.

This event is triggered when a call is placed to an emergency service.

This event is triggered when a Team Member, Department or Account receives a message. Currently only works for messages coming from external phone numbers which are not bound to the net2phone account.

This event is triggered when an incoming call is sent to a user's voicemail but the caller doesn't leave a voicemail. A common scenario for this would be the case where the callers hangs up before leaving a voicemail (before the beep sound).

This event is triggered when a user reaches the voice mail service (by dialing *95) to listen/manage their unread voice mails.

This event is triggered when an incoming call is not answered by a user who has enabled voice mail recording, and the caller successfully records a voice mail.

Blind transfer a call (triggered via click to cal API) to another user/department/ring group/welcome menu.

Jane Doe

Click to call completed for an answewred call by user

Call consultative transfer by a user for a click to call

Forward a click to call to an external number

Hold a call received via Click to Call API

Click to call missed by a user who is not logged in to the app

Park a call received via Click To Call API

Pickup a Click to Call ringing on another user

John Doe

Call recodging failed for a click to call

A click to call in a ring group is completed

A click to call entered in a ring group calls queue

A click to call in a ring group sent to a user in it's tier

Voicemail missed by a user from a click to call

A voicemail has been received for a department from a click to call

Summary of a call triggered by the click-to-call flow

MMS from external phone number to a phone number assigned to a User.

Look at the picture!; https://s3.amazonaws.com/iqntmms02/bh2IwkLwAGWXzzA9Brgt.jpeg

Blind transfer a normal call to another user

Normal call completed for an unanswered call by a user

Call consultative transfer by a user for a normal call

Pickup a call rining on another user device

Call recoding failed for an incoming call

A normal call entered in a ring group calls queue

Normal call sent to a user in a ring group tier

A voicemail has been missed for a user for an incoming call

SMS from external phone number to a phone number assigned to a Department.

Webhook for CRM integration for a specific user.

The type of the response schema in the body. It can be useful to distinguish between different response types before parsing the body.

Indicates the request quota associated to the net2phone account in the current time window. The format of the header value is based on [RateLimit Header Fields for HTTP](https://datatracker.ietf.org/doc/html/draft-polli-ratelimit-headers-05#section-3.1) IETF standard.

Indicates the remaining quota units for the current net2phone account.

Indicates the number of seconds until the request quota resets.

The opaque cursor to paginate forwards. Cannot be used together with `before`.

after

The opaque cursor to paginate backwards. Cannot be used together with `after`.

before

conversation_id

event_id

limit

message_event_id

Used to make sure the webhook request is authentic and comes from net2phone. To validate the signature:
1. Retrieve the raw body of the webhook request.
2. Concatentate two parts using the `:` character. The resulting string should looke like `{signature}:{raw_body}`.
3. Compute the HMAC-SHA256 hash from the given string. Use the `x-net2phone-timestamp` header as the key. All "string to bytes" conversions should be performed using UTF-8 encoding.
4. Convert the resulting HMAC-SHA256 hash bytes back to a string using HEX encoding (without `-` characters).
5. Compare the resulting string with the value present in the `x-net2phone-signature` header. If they are equal, the request is authentic.

See [support article](https://support.net2phone.com/s/article/Securing-net2phone-webhook-requests-to-your-application) for more information.

x-net2phone-signature

The unique id of the webhook subscription within the account.

webhook_subscription_id

The timestamp of the request. Used to validate the authenticity of the webhook request in combination with `x-net2phone-signature` header.

x-net2phone-timestamp

The authentication token is missing, expired or invalid.

The request is malformed (e.g. includes invalid JSON).

The operation is blocked due to insufficient access rights.

The provided request is semantically invalid or not supported on this account.

The operation is not supported with the current net2phone account type.

The request quota for your net2phone account was exhausted.

AuthenticationError

Avatar

The size of the image in pixels (for a resized image). Both width and height will be same for a resized image. It only holds value if the avatar image is resized.

AvatarImage

Describes if the avatar image is original uploaded or resized.

AvatarImageKind

BadRequestError

CallAnsweredEvent

The user who initiated the blind tranfer of the call.

CallBlindTransferEvent

The entity which is relevant to this webhook event. If the number is blocked at account level this will contain `WebhookTargetAccount` schema. Otherwise `WebhookEventUserSchema`.

CallBlockedEvent

The user whose call received a busy signal.

CallBusyEvent

Value `true` indicates this call has a voicemail recorded. And you should also have received `voicemail_received` event (if subscribed) for that when this is set to `true`.

CallCompletedEvent

The user who initiated the consultative transfer (also referred as warm transfer).

CallConsultativeTransferEvent

CallConsultativeTransferReason

Tells the transfer has been initiated by the caller.

Transferrer

Tells the transfer has been initiated by the callee.

Transferee

CallDirection

Tells the call related to this webhook event is an incoming call.

Inbound

Tells the call related this webhook event is an outgoing call.

Outbound

The number to which the call has been forwarded to.

The user whose call has been transferred.

CallForwardEvent

The user who performs the call hold operation.

CallHoldEvent

CallHoldReason

Tells the hold has been initiated by the caller.

Holder

Tells the hold has been initiated by the callee.

Holdee

CallMissedEvent

CallMissedReason

User Did Not Answer

User Rejected Call

Call Pickup

Call has been forwarded to another number.

Call Forward Only

User Not Logged In

User's extension is not registered in the call server.

User Not Registered

The call has been failed with an unexpected cause.

Call Failed

The slot number of the parked call. You should use this slot number to retrieve (unpark) the call later.

CallParkEvent

CallPickupEvent

Describes the user details of whose call has been picked up.

Lazy user

CallPickupUser

CallRecordedEvent

The reason for recording failure. The most common reason is `maxCallRecordings` (Maximum recordings has been hit).

CallRecordingFailedEvent

The number of seconds the call was on `hold` state from the last `call_hold` event.

The user who resumed the call from a `hold` state.

CallResumeEvent

CallResumeReason

Tells the call has been resumed by the caller.

Resumer

Tells the call has been resumed by the callee.

Resumee

CallRgQueueCompletedEvent

CallRgQueueEnteredEvent

CallRgQueueTierEvent

CallRingingEvent

CallSource

Indicates the call related to this webhook event is from webapp/phone device.

Normal

Indicates the call related to this webhook event is trigger from `Click to Call` API.

Click To Call

The slot number (received from `call_park` event) from which the call has been unparked.

The user who unparked a call from a parking slot.

CallUnparkEvent

Describes the number that started the call.

Is provided for backwards compatibility with previous versions of webhooks only. **It’s strongly suggested that you avoid using this field.**.

CallWebhookEvent

The ID of the audio message for a call recording or voicemail.

Url to download the audio file of a call recording or voicemail. The URL needs authentication like any other API resource.

CallWebhookEventAudioFields

This is present in a webhook event, if the call is initiated via `Click to Call` API.

The unique id the `Click to Call` API request.

The client id from which the `Click to Call` is triggered.

ClickToCallInfo

Describes a user starting the click-to-call flow.

ClickToCallInitiator

The user who initiated the click-to-call.

ClickToCallResultEvent

ClickToCallResultOutcome

Answered

Unanswered

CollectionOfWebhookEventType

ConnectionMode

Conversation

ConversationEvent

ConversationEventBase

ConversationEventId

ConversationId

CreateConversationFromMessageCommand

CreateMessageCommand

The HTTP/HTTPS URL of the endpoint to receive the POST callback once an event happens.

A flag to enable or disable the webhook subscription.

CreateWebhookSubscriptionCommand

CreatedAtTime

The opaque cursor pointing to the last record of the page. Set to `null` if the resulting collection is empty.

The opaque cursor pointing to the first record of the page. Set to `null` if the resulting collection is empty.