Machine Detection Complete Event

This event is sent to the url informed when requesting a machine detection operation. This event isn't sent when sync answering machine detection mode is chosen. It contains the machine detection operation result, which can be:

  • human: a human was detected; the speechThreshold and speechEndThreshold parameters can be used to tweak the speech detection operation.
  • answering-machine: an answering-machine was detected; the speechThreshold and speechEndThreshold parameters can be used to tweak the speech detection operation.
  • silence: no speech was detected; the silenceTimeout parameter can be used to control the period.
  • timeout: no result was determined; the detectionTimeout parameter can be used to control the period.
  • error: an error ocurred during the machine detection operation.

Expected response

HTTP/1.1 200
Content-Type: application/xml; charset=utf-8

<Response>
    <!-- BXML verbs to process in the call -->
</Response>

Properties

Property Description
eventType The event type, value is machineDetectionComplete.
eventTime The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be the exact time of event execution.
accountId The user account associated with the call.
applicationId The id of the application associated with the call.
from The provided identifier string of the caller used in the from field of the original call.
to The phone number user in the to field of the original call, in E.164 format (e.g. +15555555555).
direction The direction of the call. Always outbound for this event. The direction of a call never changes.
callId The call id associated with the event.
callUrl The URL of the call associated with the event.
startTime Time the call was started, in ISO 8601 format.
answerTime Time the call was answered, in ISO 8601 format.
tag The tag specified earlier in the call. If no tag was specified or it was previously cleared, this field will not be present.
machineDetectionResult The result of machine detection operation. See above for possible values.

Example: Machine detection operation with a human result

POST http://[External server URL]
{
    "eventType"             : "transferComplete",
    "eventTime"             : "2019-07-31T13:20:39.810Z",
    "accountId"             : "55555555",
    "applicationId"         : "7fc9698a-b04a-468b-9e8f-91238c0d0086",
    "from"                  : "+15551112222",
    "to"                    : "+15553334444",
    "direction"             : "outbound",
    "callId"                : "c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d",
    "callUrl"               : "https://voice.bandwidth.com/api/v2/accounts/55555555/calls/c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d",
    "startTime"             : "2019-07-31T13:13:34.859Z",
    "answerTime"            : "2019-07-31T13:13:40.644Z",
  "machineDetectionResult": "human"
}

results matching ""

    No results matching ""