Send Speech with callback URL (path filters)

get

https://api.commpeak.com/pbx/{sub_domain}/api/speech-recognition/{filters}

Same as the endpoint without the trailing {filters}, with filters, ordering, pagination and field selection encoded as path segments. See Core API Concepts.

Example (on GET /calls): GET /api/calls/start_at/2020-09-01T00:00:00/limit/50;0

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

filters

string

required

Path-encoded filters: <field>/<value> pairs (a value may be value;operator), plus limit/<limit;offset>, order/<field;direction> and fields/<a;b;c>.

sub_domain

string

required

PBX Name (subdomain)

Query Params

callback_url

string

The URL where the callback will be sent.

callback_method

string

enum

The HTTP method for the callback request. One of: POST, PUT.

Allowed:

callback_data

string

The data of the callback response action, JSON with placeholders.

token

string

Speech recognition token.

min_duration

Minimum recording duration in seconds. Default 1.

max_duration

Maximum recording duration in seconds.

call_status

The status of the campaign lead at the end of the call. For example: No Answer.

from

Minimum call creation date.

till

Maximum call creation date.

language

Speech recognition language.

phrase

Phrase (text) that the speech recognition must include.

summary

Text that the speech recognition summary must include.

rank_description

Text that the speech recognition rank description must include.

rank_min

0 to 100

Minimum call rank. Minimum 0, Maximum 100.

rank_max

0 to 100

Maximum call rank. Minimum 0, Maximum 100.

limit

≤ 50

Max amount of speech recognitions to return in the callback. Maximum 50. Default 50.

offset

Specify which row to start retrieving from. Default 0.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error