Gather DTMF from a call

Use this request to gather DTMF - digits entered by user. Gather command can be nested with a playback or a say.

Gather DTMFs from call

post

Gather DTMF from a channel call

Authorizations

Path parameters

workspaceIdstring · uuidRequired

The ID of the workspace

callIdstring · uuidRequired

The ID for a call

channelIdstring · uuidRequired

The ID for a channel

Body

maxNumKeysintegerOptional

endKeystring · enumOptionalPossible values:

timeoutintegerOptional

retriesintegerOptional

inputstring · enumOptionalPossible values:

speechLocalestring · enumOptionalDefault: en-USExample: en-USPossible values:

Responses

202

Call Command Gather was accepted for processing

application/json

400

The request did not pass validation

application/json

404

The request did not pass validation

application/json

422

The request did not pass validation

application/json

post

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/gather HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 239

{
  "maxNumKeys": 1,
  "endKey": "0",
  "timeout": 1,
  "retries": 1,
  "input": "dtmf",
  "speechLocale": "en-US",
  "playback": {
    "media": [
      "text"
    ],
    "loop": 1,
    "timeout": 1,
    "pauseMilliseconds": 1
  },
  "say": {
    "text": "text",
    "locale": "en-US",
    "voice": "text",
    "loop": 1,
    "timeout": 1
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "callId": "123e4567-e89b-12d3-a456-426614174000",
  "callFlowId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "text",
  "command": "text",
  "conditions": [
    {
      "variable": "keys",
      "operator": "eq",
      "value": "text"
    }
  ]
}

Request Headers

curl -X POST "https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/gather" \
     -H "Authorization: AccessKey YOUR_SECRET_TOKEN"

Request Body

{​
  "maxNumKeys": 0,​
  "endKey": "0",​
  "timeout": 0,​
  "retries": 0,​
  "input": "dtmf",​
  "playback": {​
    "media": [​
      "string"​
    ],​
    "loop": 0,​
    "timeout": 0​
  },​
  "say": {​
    "text": "string",​
    "locale": [​
      "en-US"​
    ],​
    "voice": "male",​
    "loop": 0,​
    "timeout": 0​
  }​
​}

Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "callId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "callFlowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "string",
  "command": "string"
}