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.

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.

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 timestamp of the request. Used to validate the authenticity of the webhook request in combination with `x-net2phone-signature` header.

x-net2phone-timestamp

AudioIdReference

AuthenticationError

Avatar is available only for `unite` accounts. It's always null for `4PSA` and `netsapiens` accounts.

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

CallQueue

CallQueueAgent

CallQueueAgentDetails

Announcement is an audio to be played for the caller in the call queue after some events happen.

Played first after delay when caller entered the call queue, delay is `primary_audio_delay_seconds`.

Played after the primary audio without delay.

CallQueueAnnouncementSettings

CallQueueAudioReference

CallQueueCallQueueFailoverDestination

CallQueueCommon

Use DownloadAudio endpoint to get the audio.

CallQueueCustomAudioReference

CallQueueDefaultAudio

CallQueueDefaultAudioReference

CallQueueDefaultAudioUsageKind

AudioType

WelcomeGreeting

OnHold

AnnouncementPrimary

AnnouncementSecondary

CallQueueFailoverAction

CallQueueFailoverDestination

Unique call queue id within a net2phone account.

CallQueueId

CallQueueIdReference

CallQueueRingStrategy

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

CampaignRegistryBrand

CampaignRegistryBrandCommon

CampaignRegistryBrandForbiddenError

CampaignRegistryBrandHasActiveCampaignsError

Unique brand id within Campaign Registry.

CampaignRegistryBrandId

CampaignRegistryBrandIdReference

TCR (The Campaign Registry) assessment of the brand identification status.

CampaignRegistryBrandIdentityStatus

TCR is unable to verify or identify the existence of the brand. An unverified brand is not permitted to run a 10DLC campaign.

Unverified

TCR is able to verify the information and identify the existence of the organization. A verified brand is permitted to run standard 10DLC campaigns across all MNO (Mobile Network Operator) networks.

Verified

CampaignRegistryBrandReference

CampaignRegistryBrandStockExchangeType

Daily message volume is restricted based on brand tier or brand qualification (T-Mobile specific).

CampaignRegistryBrandTier

CampaignRegistryBrandUnchangedError

CampaignRegistryBrandVerificationRejectionCategory

Data mismatch related to tax id and its associated properties.

Tax Id

Non public entity registered as a public for profit entity or the stock information mismatch.

Stock Symbol

Non government entity registered as a government entity. Must be a U.S. government entity.

Government entity

Non profit

Details of the data misrepresentation if any.

Other

Tax id does not match with the company name or business type.

CampaignRegistryBrandVerificationRejectionReason

Campaign sub use cases. Use "GET /campaign-registry-brand/{brand_id}/campaign-use-cases" operation to retrieve list of valid sub-use cases.

CampaignRegistryCampaign

Does message content controlled by affiliate marketing other than the brand?.

Direct lending or loan arrangement content in campaign.

Does message generated by the campaign include URL link in SMS?.

Does message generated by the campaign include phone number in SMS?.

Message sample. Some campaign tiers require 1 or more message samples.

Does campaign responds to help keyword(s)?.

Does campaign require subscriber to opt-in before SMS is sent to subscriber?.

Does campaign support subscriber opt-out keyword(s)?.

CampaignRegistryCampaignCommon

CampaignRegistryCampaignForbiddenError

The unique id of the campaign within Campaign Registry.

CampaignRegistryCampaignId

CampaignRegistryCampaignIdReference

CampaignRegistryCampaignNotActiveError

CampaignRegistryCampaignStatus

Campaign is active. It was successfully created in The Campaign Registry. The Campaign Registry is charging monthly fee for active campaigns.

Active

Campaign is being provisioned. It is in the process of registration in The Campaign Registry and messaging service provider. It is not allowed to use messaging for this campaign.

Pending

Campaign is expired. It is not allowed to use messaging for this campaign.