Gather event

The gather event is sent after a <Gather> verb is executed. Its purpose is to report the gathered digits to the calling application.

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 gather.
accountId The user account associated with the call.
applicationId The id of the application associated with the call.
to The phone number that received the call, in E.164 format (e.g. +15555555555).
from The phone number that made the call, in E.164 format (e.g. +15555555555).
direction The direction of the call. Either inbound or outbound. The direction of a call never changes.
callId The call id associated with the event.
parentCallId (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, null.
callUrl The URL of the call associated with the event.
startTime Time the call was started, in ISO 8601 format.
tag (optional) The tag specified earlier in the call. If no tag was specified or it was previously cleared, null.
digits (optional) The digits collected from user. Null if a timeout occurred before any digits were pressed.
terminatingDigit (optional) The digit the user pressed to end the gather. Null if no terminating digit was pressed.
transferCallerId (optional) If the event is related to the B leg of a <Transfer>, the phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). Otherwise, null.
transferTo (optional) If the event is related to the B leg of a <Transfer>, the phone number used as the to field of the B-leg call in E.164 format (e.g. +15555555555). Otherwise, null.

Example: Gather event completed because the max-digits were reached

POST http://[External server URL]
{
    "eventType"        : "gather",
    "accountId"        : "55555555",
    "applicationId"    : "7fc9698a-b04a-468b-9e8f-91238c0d0086",
    "startTime"        : "2019-06-20T15:54:22.234Z",
    "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",
    "digits"           : "25",
    "terminatingDigit" : ""
}

Example: Gather event completed because the terminating digit was pressed

POST http://[External server URL]
{
    "eventType"        : "gather",
    "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-06-20T15:54:22.234Z",
    "digits"           : "123",
    "terminatingDigit" : "#"
}

results matching ""

    No results matching ""