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

Gather DTMF from a channel call

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

Authorization

useraccessKey

Path parameters

workspaceId*string (uuid)

The ID of the workspace

callId*string (uuid)

The ID for a call

channelId*string (uuid)

The ID for a channel

Body

application/json

maxNumKeysinteger

endKeyKey (enum)

0123456789*#

timeoutinteger

retriesinteger

inputenum

dtmfspeechdtmf speech

speechLocaleenum

Example: "en-US"

de-DEen-AUen-GBen-USes-USit-ITja-JPko-KRpt-BRth-THzh-CN

playbackPlayback sound to Call

saySay text to Call

Response

202400404422

Call Command Gather was accepted for processing

Body

application/json

idId-2 (string (uuid))

callIdId-2 (string (uuid))

callFlowIdId-2 (string (uuid))

statusstring

commandstring

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/gather', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202400404422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "callId": "123e4567-e89b-12d3-a456-426614174000",
  "callFlowId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "text",
  "command": "text"
}

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