This event is triggered when a call is answered.

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

This event is triggered when a call is completed.

This event is triggered when a call is ringing.

This is an example of a call with auto attendant. Note`:` the id is an extension instead of a phone number.

Example of a call placed to a E164 Phone Number without the from parameter (as it is optional).

Example of a call placed to a E164 Phone Number and from the authenticated user.

Example of a call placed to a E164 Phone Number and from the authenticated user extension.

Example of a call placed to an extension and from the authenticated user extension.

Example of a call placed to a SIP user address without the from parameter (as it is optional), and with auto_answer.

Example of a call placed from a SIP user address.

Example of a call placed from a E164 Phone Number.

John Doe

Example User

The cursor/index from which to continue a previous request from.

cursor

Get calls which ended after this time. In UTC if timezone not specified. If no start date is provided results for calls after this end date will be returned.

end_date

subscriptionId

The number of returned items.

Supported in the following net2phone account generations: Gen P, Gen X, Gen U

limit

Filter CDRs by maximum duration.

Supported in the following net2phone account generations: Gen V

max_duration

Filter CDRs by minimum duration.

Supported in the following net2phone account generations: Gen V

min_duration

Number of returned items.

Supported in the following net2phone account generations: Gen V

page_size

Filter CDRs by phone number used

Supported in the following net2phone account generations: Gen V

phone_number

Filter CDRs to only include ones with recordings.

Supported in the following net2phone account generations: Gen V

recording_available

Get calls which started after this time. In UTC if timezone not specified.

start_date

The type of phone call which took place.

Supported in the following net2phone account generations: Gen V, Gen X, Gen U

type

The user/extension to retrieve the call records for. Append multiple times to filter by multiple users.

user

userId

Your permission level was insufficient to access the requested resource and/or perform the given action.

An invalid version number was provided in the `Accept` request header.

Requests to this endpoint are limited to a certain rate. If you have exceeded this rate check the endpoints limit and try again after a cool down period.

Details about the user's account number and generation

Account number for the user.

Supported in the following net2phone account generations: Gen V

Domain is the unique identifier of the account.

Supported in the following net2phone account generations: Gen P, Gen X, Gen U, Gen V

Generation of the account. Represents the underlying system used for the API implementation. Depending on it some fields in API resources may be available or not.

Supported in the following net2phone account generations: Gen V, Gen P, Gen X, Gen U

Type of plan (tier) that a net2phone Canada client pays for to get services.

Supported in the following net2phone account generations: Gen V

Account generation

Should this caller side be auto answered. (Note. It may not be supported by the answering device.)

Supported in the following net2phone account generations: Gen V

For Gen P and Gen V accounts the `from` parameter is the authenticated user id where this call originates from. For Gen U and Gen X accounts the `from` parameter can be the user phone number or the user extension. Exceptions: For Gen V you can also use the SIP user.

Supported in the following net2phone account generations: Gen P, Gen X, Gen U, Gen V

The destination for this call. All Generations accounts allow the use of E.164 phone number and extensions. Exception: Gen V accounts also allow the use of SIP user.

Supported in the following net2phone account generations: Gen P, Gen X, Gen U, Gen V

Create Call

Date and time the call was answered (in UTC).

Supported in the following net2phone account generations: Gen V

The by side of the call.

Supported in the following net2phone account generations: Gen V

The extension of the user associated with this call leg.

The user@domain for the user associated with a call leg.

The sip address or e164 number associated with a call leg.

The type of call.

Supported in the following net2phone account generations: Gen V, Gen X, Gen U

Domain associated with this call.

Supported in the following net2phone account generations: Gen V

Date and time the call was ended (in UTC).

The unique identifier for one side of the call.

Has the recording been processed.

Supported in the following net2phone account generations: Gen V

A collection of recordings associated with a call leg.

Supported in the following net2phone account generations: Gen V

The connected origination/termination device or number in full sip uri format.

Supported in the following net2phone account generations: Gen V

The user@domain for the user associated with a call leg.

Supported in the following net2phone account generations: Gen V

The e164 phone number associated with a call leg.

Has cdr been processed for transcription and/or redaction.

Supported in the following net2phone account generations: Gen V

Date and time the call was started (in UTC).

True if there is more data available. If True use the cursor to request the next batch of data.

A Page of CDRs

Available endpoints

The HTTP(S) endpoint which is notified when an event occurs.

User Details

A call subscription will result in Post request to your subscribed endpoint on call state changes for the subscribed user and company. The ringing event will show one side as `ringing` and the other as `progressing`.
* `progressing` - call is waiting for the other side
* `ringing` - endpoint is ringing
* `active` - call is up
* `ended` - call terminated

An intermediary call id. Used in when the call is transferred from one party to another.

If call was between net2phone sip devices.

When the end user picked up the call. `null` for ringing event.

Call Webhook

The number of seconds until the webhook subscription expires

One or more users to subscribe to. Omit to subscribe to all users webhooks.
Append multiple times to subscribe to multiple users.

Add your net2phone credentials below in order to get a token and test the API.
Please choose `Request Body` in the dropbox before clicking the `Get Token` button.


The net2phone API is an HTTP web service that provides programmatic access to selected features of your net2phone account. It empowers you with the ability to create your integrations using our communication data resources, for example, call data records that contain details about phone calls.

net2phone API

Get the details about the account used by the current user.

Place a call from the provided user/device to a given destination. Destination can be sip address or any valid phone number. E164 format is recommended.

Get list of all CDRs on the account for the current user

Creates a webhook subscription for the requested events.
When an event occurs to which you are subscribed a POST request will be set to your post_uri with a JSON body indicating what occurred.

The webhook subscription was deleted successfully.

Delete a webhook subscription with the given id. Updates will no longer be sent the subscription endpoint.
Note: Users can only delete subscriptions that they created.

Get the webhook subscription details for the given id. Can be used to verify subscribed events as well the subscription expiry date/time.
Note: Users can only read subscriptions that they created.

This operation returns a list with all users in the account for Gen V customers.  For Gen P, Gen U and Gen X customers, the list with a current user only is returned, for backwards compatibility. Consider switching the usage to the "Get Current User" endpoint instead if you have Gen P, Gen U or Gen X account.

Supported in the following net2phone account generations: Gen V

Get details list of all users of an account

Get the user details for the authenticated user.

Get the user details. If provided the id will be used to get a specific user. If not specified the authenticated user details will be returned. If you wish to retrieve all users across your domain use the "all" argument.

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

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

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

message_event_id

page_index

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.