List Order Confirmation

Details

Request Parameters

Request Example

curl 'https://platform.innocalls.com/api/v1/api-gateway/order-confirmation/list?page=1&limit=10' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <base64-encoded string  apiId:apiSecret>'

Success Response Example

{
  "data": {
    "rows": [
      {
        "id": "6586b1c1ec82330a1439d9a7",
        "name": "name",
        "description": "description",
        "requiredVariables": [
          {
            "variableName": "test",
            "type": "money"
          }
        ],
        "trialsCount": 1,
        "minutesToWaitBeforeFirstTrial": 0,
        "delayMinutesBetweenTrials": 5,
        "resultConfiguration": {
          "noAnswer": "No answer",
          "answeredNoProvidedAnswer": "Not provided answered",
          "answeredClickedOne": "Confirmed",
          "answeredClickedTwo": "Cancelled"
        }
      }
    ],
    "totalItems": 1,
    "totalPages": 1
  }
}

Description

This JSON response confirms a successful retrieval of a list containing detailed information about each order confirmatio

• totalItems: Total number of order confirmations.
• totalPages: Total pages of order confirmations.
• rows: An array containing details of each order confirmation
  • id: Unique identifier for the order confirmation.
  • name: Name of the order confirmation.
  • description: Description of the order confirmation.
  • trialsCount: Number of trials count of the order confirmation.
  • minutesToWaitBeforeFirstTrial: Minutes to wait before first trial.
  • delayMinutesBetweenTrials: Delay minutes between each trial.
  • requiredVariables: The required variables of the order confirmation. It can be empty or an array of objects depending on order confirmation required variables.
    • variableName: Variable name.
    • type: Variable type.
  • resultConfiguration: An object containing configuration for the final status of the call that should appear in the file statistics.
    • noAnswer: Status that should appear when there is no answer.
    • answeredNoProvidedAnswer: Status that should appear when an answer is provided but no valid option is clicked.
    • answeredClickedOne: Status that should appear when an answer is provided and one valid option is clicked.
    • answeredClickedTwo: Status that should appear when an answer is provided and another valid option is clicked.

Possible Errors