Initialize File Order Confirmation
Upload CSV file to initiate bulk order confirmations
Init File Call
Details
| Description | The "Init" endpoint initializes a file call. |
|---|---|
| HTTP Method | POST |
| Endpoint URL | https://platform.innocalls.com/v1/api-gateway/order-confirmation/:id/file-call/init |
| Authorization | To access the API endpoints, you need to authenticate using API keys and API secrets. The API supports Basic Authentication for authorization. You need to include your API ID as the username and your API secret as the password in the HTTP header when making requests. Replace API_ID with your API ID and API_SECRET with your API secret, separated by a colon (:). The value after Basic is the Base64 encoding of your API key and API secret concatenated with a colon. |
| Rate Limit | 3 requests per second |
Request Parameters
| Parameter | Description | Location | Constrains |
|---|---|---|---|
| id | The ID of the order confirmation that the call belongs to | Path | Required |
| file | The file to be used in the process | Body | Required |
| useDefaultFlowOptions | Determines whether to use default flow options or custom options | Body | Required |
| minutesToWaitBeforeFirstTrial | The number of minutes to wait before the first trial | Body | Required if useDefaultFlowOptions false Min: 0 |
| delayMinutesBetweenTrials | The delay in minutes between each trial. | Body | Required if useDefaultFlowOptions false Min: 5 |
| trialsCount | The number of trials to be conducted. | Body | Required if useDefaultFlowOptions false Min: 1 Max: 10 |
| useDateOption | If you want to make the trials at specific date. | Body | Optional |
| callsDates | An array that contains the date for each call trial. | Body | Required if Elements count should be equivalent to trials count Should be in ascending order |
| timezone | Timezone that should dates convert to. | Header | Optional |
Request Example
Example 1
curl 'https://platform.innocalls.com/api/v1/api-gateway/order-confirmation/:id/file-call/init' \
--header 'Authorization: Basic <base64-encoded string apiId:apiSecret>' \
--form 'file=@"/path/to/file"' \
--form 'useDefaultFlowOptions="true"'Description
When you want to use the same order confirmation flow options.
Example 2
curl 'https://platform.innocalls.com/api/v1/api-gateway/order-confirmation/:id/file-call/init' \
--header 'Authorization: Basic <base64-encoded string apiId:apiSecret>' \
--form 'file=@"/path/to/file"' \
--form 'useDefaultFlowOptions="false"' \
--form 'trialsCount="2"' \
--form 'minutesToWaitBeforeFirstTrial="0"' \
--form 'delayMinutesBetweenTrials="5"'Description
When you want to customize options for trialsCount, minutesToWaitBeforeFirstTrial, and delayMinutesBetweenTrials, instead of using the same order confirmation flow options.
Example 3
curl 'https://platform.innocalls.com/api/v1/api-gateway/order-confirmation/:id/file-call/init' \
--header 'Authorization: Basic <base64-encoded string apiId:apiSecret>' \
--header 'timezone: Africa/Cairo' \
--form 'file=@"/path/to/file"' \
--form 'useDefaultFlowOptions="false"' \
--form 'useDateOption="true"' \
--form 'callsDates="[\"2023-03-14 14:17\",\"2023-03-14 14:20\"]"'Description
This example demonstrates the initiation of a file call request with customized dates for each call. The useDefaultFlowOptions parameter is set to false, indicating the use of custom options. Additionally, useDateOption is set to true, specifying that specific dates for each call will be provided. The callsDates parameter contains an array of dates in the format "YYYY-MM-DD HH:mm" for each call trial.
Success Response Example
A successful response is indicated by the HTTP status code 204.
Possible Errors
| Error Code | Description |
|---|---|
| 401 Unauthorized | Invalid Credential |
| 403 Forbidden | Not Enough Permissions to access the resource |
| 429 Too Many Requests | This occurs when requests exceed the rate limit |
| 404 Not Found | This occurs when the requested order confirmation is not found |
| 400 BadRequest | This error occurs due to malformed or invalid request parameters |
