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
post
POST /workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/gather HTTP/1.1
Host: 
Authorization: Bearer jwt
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"
    }
  ]
}
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}'

Last updated

Was this helpful?