Fetch Gather Information

Get the gather DTMF parameters and results.

Request URL

GEThttps://api.catapult.inetwork.com/v1/users/{userId}/calls/{callId}/gather/{gatherId}

Properties

Property Description
state The state of the gather. Value can be started or completed.
digits The digits collected from user.
reason max-digits - The maximum number of digits specified for the gather com.
terminating-digit - The digit specified in the gather com was entered.
inter-digit-timeout - A timeout occurred indicating the maximum amount of time to wait between digits, or before the first digit was pressed.
hung-up - Call was hung up thus terminating the gather.
call The full url of the call (including the call id) associated with the event.
gatherId The gather event unique id.
createdTime Date/time of event. Timestamp follows the ISO8601 format (UTC).
completedTime Date/time of event. Timestamp follows the ISO8601 format (UTC).

Example 1 of 1: Fetch information for a single gather

curl -v -X GET https://api.catapult.inetwork.com/v1/users/{userId}/calls/{callId}/gather/{gatherId} -u {token}:{secret} -H "Content-type: application/json"
client.Call.getGather("{callId}", "{gatherId}")
.then(function (res) {
  console.log(res);
});
var gather = await client.Call.GetGatherAsync("{callId1}", "{gatherId1}");
Console.WriteLine(gather.Digits);
// 123
gather = call.get_gather("{gatherId1}")
digits = gather[:digits]

The above command returns JSON structured like this:

{
  "id": "{gatherId}",
  "state": "completed",
  "reason": "max-digits",
  "createdTime": "2014-02-12T19:33:56Z",
  "completedTime": "2014-02-12T19:33:59Z",
  "call": "https://api.catapult.inetwork.com/v1/users/{userId}/calls/{callId}",
  "digits": "123"
}

results matching ""

    No results matching ""