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

useraccessKey

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 · enumoptional

Options: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, *, #

timeoutintegeroptional

retriesintegeroptional

inputstring · enumoptional

Options: dtmf, speech, dtmf speech

speechLocalestring · enum · default: "en-US"optional

Example: en-US

Options: de-DE, en-AU, en-GB, en-US, es-US, it-IT, ja-JP, ko-KR, pt-BR, th-TH, zh-CN

playbackobjectoptional

sayobjectoptional

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/gather' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "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
    }
  }'

202

400

404

422

202

{
  "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"
    }
  ]
}

Call Command Gather was accepted for processing

Request Headers

curl -X POST "https://nest.messagebird.one/workspaces/8bc02f53-87ac-48d2-b4fd-c2cf856a305f/channels/880d8171-cbab-47bb-81b6-b1a0902da136/calls/4fc2edf7-68f5-437a-89eb-3ce0095409d6
/gather" \
     -H 'Authorization: Bearer {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"
}