No-code docs
Resources

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

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
maxNumKeysinteger
endKeystring · enum
Options: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, *, #
timeoutinteger
retriesinteger
playbackPlayback sound to Call
saySay text to Call
inputstring · enum
Options: dtmf, speech, dtmf speech
speechLocalestring · enum · default: en-US
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
Responses
curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/gather' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"endKey":"0","playback":{"media":[null]},"say":{"text":"text","locale":"en-US"},"input":"dtmf","speechLocale":"en-US"}'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "callId": "123e4567-e89b-12d3-a456-426614174000",
  "callFlowId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "text",
  "command": "text",
  "conditions": [
    {
      "value": "text",
      "variable": "keys",
      "operator": "eq"
    }
  ]
}

Call Command Gather was accepted for processing

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?