Innocalls - Elevate Your Customer Support with AI-Powered Solutions

List Single Call

Details

Description	The "List" endpoint provides details for individual calls within an order confirmation.
HTTP Method	`GET`
Endpoint URL	https://platform.innocalls.com/v1/api-gateway/order-confirmation/single-call/list
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	Default Values
limit	Limit of fetched rows	Query	Optional Max: 100	10
page	Page of rows to fetch	Query	Optional Min: 1	1
timezone	Timezone for date conversion	Header	Optional	Asia/Riyadh

Request Example


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

Success Response Example

{
  "data": {
    "rows": [
      {
        "id": "65f03f3a19efa9d638053753",
        "status": "Order Confirmed",
        "phone": "2012xxxxxxxx",
        "callerId": "2012xxxxxxxx",
        "orderConfirmationCallScenario": "order confirmation name",
        "createdAt": "12-03-2022 02:40 PM",
        "cdrs": [
          {
            "id": "65f03f4c19efa9d638053783",
            "callStatus": "Answered",
            "orderStatus": "Order Confirmed",
            "trial": 1,
            "duration": 0,
            "callDate": "12-03-2022 02:40 PM"
          }
        ]
      }
    ],
    "totalItems": 1,
    "totalPages": 1
  }
}

This JSON response confirms a successful retrieval of a list containing detailed information about each individual call within the order confirmation. It offers comprehensive insights into every aspect of the calls conducted.

totalItems: Total number of single calls.
totalPages: Total pages of single call details.
rows: An array containing details of each individual call.
- id: Unique identifier for the call.
- status: Final Status of the call.
- phone: Phone number dialed
- callerId: Caller ID used for the call.
- orderConfirmationCallScenario: Name of the order confirmation.
- createdAt: Represents the date and time when the call was created, formatted as "DD-MM-YYYY HH:MM AM/PM".
- cdrs: An array containing details of each call trial.
  - id:Unique identifier for the call detail record.
  - trial: Number of trial attempts for the call.
  - duration: Duration of the call in seconds.
  - callDate: Represents the date and time when the call occurred, formatted as "DD-MM-YYYY HH:MM AM/PM".
  - callStatus : Status of the trial call.
  - orderStatus: Status of the order for this trial.

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
400 BadRequest	This error occurs due to malformed or invalid request parameters

List Single Calls