Request Parameter
These parameter act as filters. The response is based on the provided filter values.
Parameter Name | Data Type | Description | Required/ Optional |
|---|---|---|---|
startDate | Date | Fetch conversations from this date. Format: yyyy-MM-dd HH:mm:ss | Required |
endDate | Date | Fetch conversations until this date. Format: yyyy-MM-dd HH:mm:ss | Required |
agentId | Number | Fetch conversations for the given Agent Id. | Optional |
direction | String | Fetch conversations by direction. Example: Inbound or Outbound | Optional |
organizationNodeId | String | Fetch conversations for the given Organization name. | Optional |
language | String | Fetch conversations in the given language. | Optional |
processingStatus | Text | Fetch conversations by Processing Status. Example: Completed, Failed or In_Progress | Optional |
pagetoken | Boolean | Token used to fetch subsequent responses. Not required on the first request but needed for subsequent requests. If not passed in subsequent requests, the first 10 records are fetched. | Optional |
pageSize | Number | Number of records per page, allowed up to 500. If not specified, the default is 10. | Optional |