INinfobip
channels
voice
number-masking
number-masking-events

Number Masking status API

After a call to the Number Masking number has finished, the Infobip platform generates a request to your statusUrl set up in the Number Masking configuration. This request contains report details of the call. We also provide the correlationID and nmCorrelationID to be used as identifiers for this call request.

In return from your platform, the Infobip platform expects a confirmation that the request has been received successfully.

postWebhookreceive-masked-call-report

Headers

Authorizationstring

For more details check Secure your communication.

Payload

actionstring

Requested action (dial, audio, captureDtmf).

fromstring

Caller phone number.

tostring

Called phone number.

transferTostring

Called party phone number that the call is transferred to.

durationinteger

Duration of the outbound call shown in seconds

statusstring

Call status which can be: answered, busy, no answer, failed or congestion

nmCorrelationIdstring

Unique identifier for correlation with inbound call, available in Callback and Status requests.

fileIDstring

Identifier of the file played to the caller.

fileUrlstring

The URL of the file played to the caller.

ringingTimestring

Date and time when ringing started.

answeredTimestring

Date and time when the call was answered.

correlationIdstring

Unique identifier of the call record, available for both Callback and Status requests.

inboundDurationinteger

Duration of the inbound call shown in seconds.

calculatedDurationinteger

The duration of the outbound part of the number masking session, where the voice billing model (1/1, 15/15,...) has been applied to the calculatedDuration.

pricePerSecondnumber double

This is the price per second for the outbound part of the number masking session, with the price being expressed in cents per second.

currencystring

The currency in which the price is expressed.

recordingFileIdstring

ID of a recording file of a call.

recordCalleeAnnouncementboolean

Flag that indicates if callee announcement is included in recording file.

recordingStatus'HOSTED' | 'SFTP' | 'FAILED'

Recording status provided if recording was attempted.

machineDetectionResult'HUMAN' | 'MACHINE'

Result of Answering Machine Detection. Possible values are HUMAN and MACHINE.

clientReferenceIdstring

Client-defined ID of a valid file name. Used to correlate a call with this reference. If recording is enabled and files are stored in the SFTP server, that ID will be used as a file name instead.

Response

A successful response is represented by an HTTP status code 200 OK from the Client’s platform.

287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8StatusResponse required

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.