A POST request with the following fields will be sent to the actionUrl provided in your GetDigits command.
| Request Parameter | Type | Description |
|---|---|---|
| requestType | string | Context or reason why this request is being made. Will be getDigits - The GetDigits command has completed and its actionUrl is being invoked. |
| callId | string | Unique identifier for this Call, generated by FreeClimb. |
| accountId | string | Account ID associated with your account. |
| from | string | Phone number of the party that initiated the Call (in E.164 format). |
| to | string | Phone number provisioned to the customer and to which this Call is directed (in E.164 format). |
| callStatus | string | Descriptive status for the Call. Valid values are: • ringing - Call is currently ringing.• inProgress - Call was answered and is currently in progress (not queued, not in conference).• completed - Call ended normally.• busy - Caller received a busy signal.• failed - Call could not be completed as dialed (most likely because the phone number was non-existent).• noAnswer - Call ended without being answered.• canceled - Call was canceled via the REST API while queued or ringing. |
| direction | string | String describing the direction of the Call – inbound for inbound calls, outbound for calls initiated via the REST API, or outboundDial for calls initiated by the PerCL OutDial command. |
| conferenceId | string | This is only populated if request pertains to a conference. Otherwise, it is set to null. |
| queueId | string | This is only populated if the request pertains to a queue. Otherwise, it is set to null. |
| digits | string | String of digits entered by the Caller, excluding the terminating digit (if used). The string of digits will be replaced by "xxxxx" when privacyMode is set to true. This field will be empty if digits collection failed because of timeout, hangup, or minDigits not reached. When the digits field is populated, it signifies a successful collection of digits, and the reason can be: timeout, finishKey, or maxDigits. Also, if the finishKey was received before minDigits was reached, the field will still be empty and the reason will be finishKey. |
| `reason | string | This field explains how the GetDigits action ended. The value is one of the below:• finishKey - The finish key as specified had been pressed by the caller. Digit string has all keys up to, but not including, the finish key.• timeout - The timeout limit was reached prior to any other criteria being met. If any digits were collected, they will be included.• maxDigits - The maximum number of digits was reached and digit collection ended.• tone - Answering machine or fax tone detection occurred, interrupting digit collection. Any digits received up to this point are included in this webhook. |
| parentCallId | string | ID of the Call that created this leg (child call). |
