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 answered 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 recording 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 ringing 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

Calls from or to specific number (partial match).

Calls from or to a specific number (starts with).

Calls with available call recording audio.

Calls with non-deleted call recordings from a specific user.

Calls with non-deleted voicemails for a specific user.

Calls with voicemails to a selected user or department inboxes.

Set call forwarding settings with `sequential` ring strategy.

Set call forwarding settings with `simultaneous` ring strategy.

Calls from or to specific number (partial match)

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

The unique id of the `Blocked Caller` resource.

blocked_caller_id

A string phrase to apply on the search. The API will return the records that contains the specified `search_query` in `phone_number_pattern` or `comment` fields.

Returns the records matching `UAE` in `phone_number_pattern` or `comment` fields.

Returns the records matching `97348` in `phone_number_pattern` or `comment` fields.

search_query

The unique id of the call recording within the account.

call_recording_id

A text query to filter out the paginated list of contacts.
The case-insensitive search is performed using `extension`, `phone_numbers` and other fields specific to the contact 'type'.
For example, for users `first_name`, `last_name` and `email` are searched.
For departments, the `display_name` will be included in search.
Non-alphanumeric characters are ignored.
Whitespace characters between digits are ignored to ensure formatted phone numbers can be passed.

For example:
* `(213) 373-4253` is equivalent to `2133734253`.
* `John   Doe` is equivalent to `john doe` and will search for case-insensitive inclusion of `john` or `doe` in contact fields.
* `john +1 (23) 7534432 doe` will search for `john` or `1237534432` or `doe`.
* `John75` will match a user with email `john75@example.org`.

Filter by `john` or `doe` values in contact fields.

Filter by formatted phone number. For example, it matches `+12133734253` E.164 phone number.

Filter by phone number or extension digits.

conversation_id

event_id

extension

The presence status of the extension to filter on.

presence_status

limit

message_event_id

page_index

page_size

assignment_status

The unique identifier of the Phone Number.

phone_number_id

The presence owner id to filter on. Use `@me` to reference the currently authenticated user.

presence_owner_id

registration_status

Unique identifier of the SIP trunk account.

sip_trunk_account_id

The unique id of the user within the net2phone account.  Use `@me` to reference the currently authenticated user.

user_id

The unique id of the voicemail within the account.

voicemail_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. Concatenate two parts using the `:` character. The resulting string should look 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 current user doesn't have access or the phone number maximum limits reached.

The request payload has a conflict with existing data.

The requested resource is in conflict state and can't be processed.

The feature is not available for your account or might require additional licenses. When a feature is activated, you might need to get a new access token to avoid this error response.

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 Phone Number can't be assigned/unassigned or deleted, because every user in the account needs to have a phone number assigned.

The current phone number assignment is required, or it is used as caller id.

The request quota for your net2phone account was exhausted.

Actor

ActorAuditFields

ActorOptional

AndComposite

Describes if incoming calls from anonymous calls are blocked for all users under account or for the current user making the API request. Set to `null` if anonymous calls are allowed.

AnonymousCallersBlockLevel

Block anonymous callers for all users in the net2phone account.

Account

Block anonymous callers for the current user making this API request.

User

AnonymousCallersBlockingSettings

AreaCode

AssignPhoneNumberCommand

AuthenticationError

AvailablePhoneNumber

The E164 Phone Number used as unique identifier of the Available Phone Number resource.

AvailablePhoneNumberId

The type of search you would like to perform. When set to `shuffled` the result set will not strictly look for consecutive numbers. When set to `consecutive`, a minimum `quantity` of 2 will be enforced and the result set will have consecutive numbers.

AvailablePhoneNumberLookupType

Tells the search should return random available phone numbers.

Shuffled

Tells the search should return consecutive phone numbers.

Consecutive

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

BatchCreatePhoneNumbersCommand

BatchCreatePhoneNumbersForbiddenError

BatchDeleteCallRecordingsCommand

BatchSetCallRecordingsViewStatusCommand

BlockedCaller

Describes if a caller is blocked at `account` level or `user` level.

BlockedCallerBlockedAtLevel

BlockedNumberBlockedAtLevel

BlockedCallerId

BlockedPhoneNumberPatternAlreadyExistError

CallActivityItemId

The timezone, for which the `period` is calculated. Typically matches the user profile's timezone.

CallActivityItemPeriodIanaTimezoneId

CallActivityItemReference

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

If you are an admin or callee of this call, you will be able to see the callee side of the recording here. Otherwise set to `null`.

If you are an admin or the caller of this call detail record, you will be able to see the caller side of the recording here. Otherwise set to `null`.

Total duration of the call in seconds. If the call was picked-up, duration should be greater than zero. Note that the pick-up might happen automatically to play the voicemail or "user is unavailable" prompt. For calls with voicemails, this will include the duration of the voicemail.

End time of the call formatted as [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. If the call resulted into a voicemail, this would be the time when the caller recorded it and disconnected the call.

Start time of the call formatted as [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.

CallDetailRecord

Unique CDR (Call Detail Record) identifier.

CallDetailRecordId

CallDirection

The call is classified as `inbound` in one of the following cases:
* The call is initiated by an external (non net2phone) user.
* For API responses (not in webhook payloads), the call is targeting the current user or his/her assigned
departments. The current user is referenced by the API access token.


Inbound

The call is classified as `outbound` if all of the conditions are true:
* The call is initiated by the net2phone user.
* For API responses (not in webhook payloads), the call is not classified as `inbound` based on the current user
making the API request. E.g. all calls made between net2phone users, but not related to the current user are
`outbound`. The current user is referenced by the API access token.


Outbound

CallEndpoint

A E.164 phone number or an extension. Set to `null` if the phone number is hidden.

CallEndpointOptional

The number to which the call has been forwarded to.

The user whose call has been transferred.