callback
callbackfmt
: Available with V‑Cloud 1.6+
Description: The
callbackfmt
parameter enables the selection of a specific callback format.
Values: multi (default), single, put
-
callbackfmt=multi
-
This is the default value. Setting
callbackfmt
to multi performs a multi-partPOST
to the callback with two parts specifying the request ID and the result file content. -
callbackfmt=single
-
Setting
callbackfmt
tosingle
performs a standardPOST
that only contains the result file content within thePOST
body.The request ID is retrievable through the
POST
's X-Request-ID header. -
callbackfmt=put
-
Identical to the
callbackfmt=single
except the callback is performed using an HTTPPUT
instead of aPOST
.Allows you to pass pre-signed AWS S3 URLs through the callback parameter to automatically upload the result to AWS S3.
The following command is a V‑Cloud API call using the
callbackfmt
parameter:
curl -F token=token \
-F file=@sample.wav \
-F callback=>http://sample.com:5555 \
-F callbackfmt=single\
https://vcloud.vocitec.com/transcribe
callbackerror
: Available with V‑Cloud 1.6+
Description: Use
callbackerror
to specify a callback URL to receive results of erroneous jobs. If
callbackerror
isn't specified, erroneous job results are sent to the URL defined in the
callback
parameter.
Values: URL
The following command is a V‑Cloud API call using the
callbackerror
parameter:
curl -F token=token \
-F file=@sample.wav \
-F callback=http://sample.com:5555 \
-F callbackerror=http://callbackerrorurl.com:5555 \
https://vcloud.vocitec.com/transcribe