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

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

callIdstring · uuidRequired

The ID for a call

channelIdstring · uuidRequired

The ID for a channel

Body

application/json

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

idstring · uuidOptional

callIdstring · uuidOptional

callFlowIdstring · uuid · nullableOptional

statusstringOptional

commandstringOptional

400

An error

application/json

404

An error

application/json

422

The request contains invalid parameters or body fields.

application/json

post/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/gather

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: 237

{
  "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": "arb",
    "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

Response