Conversations

Get conversations

Retrieve a paginated list of conversation sessions with optional filtering.

POST /api/v1/business/{businessId}/conversations

Path parameters

integer

required

The unique identifier for your business

Request body

integer

default:"10"

Number of conversations to return per page (1-100)

string

Cursor for the next page of results

string

Cursor for the previous page of results

object

Optional filters to narrow results

Show Filter properties

string

ISO 8601 timestamp - filter conversations started after this date

string

ISO 8601 timestamp - filter conversations started before this date

array

Array of session states to filter by (e.g., Active, Completed, Failed)

array

Array of initiation types (e.g., Outbound, Inbound, Web)

array

Array of end types to filter by

Response

boolean

Indicates whether the request was successful

object

Paginated conversation results

Show Pagination fields

array

Array of conversation objects

string

Cursor to fetch the next page (null if no more results)

string

Cursor to fetch the previous page (null if on first page)

integer

Total number of conversations matching the filter

Example request

curl -X POST https://api.iqra.ai/api/v1/business/12345/conversations \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "Limit": 20,
    "Filter": {
      "StartStartedDate": "2024-01-01T00:00:00Z",
      "EndStartedDate": "2024-01-31T23:59:59Z",
      "SessionStates": ["Completed"]
    }
  }'

const response = await fetch(
  'https://api.iqra.ai/api/v1/business/12345/conversations',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Token YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      Limit: 20,
      Filter: {
        StartStartedDate: '2024-01-01T00:00:00Z',
        EndStartedDate: '2024-01-31T23:59:59Z',
        SessionStates: ['Completed']
      }
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://api.iqra.ai/api/v1/business/12345/conversations',
    headers={
        'Authorization': 'Token YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'Limit': 20,
        'Filter': {
            'StartStartedDate': '2024-01-01T00:00:00Z',
            'EndStartedDate': '2024-01-31T23:59:59Z',
            'SessionStates': ['Completed']
        }
    }
)

data = response.json()

Get conversation

Retrieve a specific conversation with full transcript, messages, and metadata.

GET /api/v1/business/{businessId}/conversations/{sessionId}

Path parameters

integer

required

The unique identifier for your business

string

required

The unique session identifier for the conversation

Response

boolean

Indicates whether the request was successful

object

Conversation details

Show Conversation properties

string

Unique session identifier

string

Queue ID if this was an outbound call

string

Current conversation state (Active, Completed, Failed, etc.)

string

ISO 8601 timestamp when conversation started

string

ISO 8601 timestamp when conversation ended (null if active)

string

How the conversation ended (Normal, Hangup, Error, etc.)

array

Array of clients (callers) in the conversation

Show Client properties

string

Unique client identifier

string

Type of client (Phone, Web, etc.)

string

When the client joined

string

When the client left (null if still connected)

string

Reason for leaving

string

Pre-signed URL to client’s audio recording

array

Array of AI agents in the conversation

Show Agent properties

string

Agent identifier

string

Type of agent

string

When the agent joined

string

When the agent left (null if still active)

string

Reason for leaving

string

Pre-signed URL to agent’s audio recording

array

Complete conversation transcript

Show Message properties

string

ID of the sender (client or agent)

string

Sender role (User, Agent, System)

string

Message text content

string

When the message was sent

array

Conversation event logs

Show Log properties

string

Log level (Info, Warning, Error)

string

Log message

string

When the event occurred

Example request

curl https://api.iqra.ai/api/v1/business/12345/conversations/session_abc123 \
  -H "Authorization: Token YOUR_API_KEY"

const response = await fetch(
  'https://api.iqra.ai/api/v1/business/12345/conversations/session_abc123',
  {
    headers: {
      'Authorization': 'Token YOUR_API_KEY'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://api.iqra.ai/api/v1/business/12345/conversations/session_abc123',
    headers={'Authorization': 'Token YOUR_API_KEY'}
)

data = response.json()

Example response

{
  "Success": true,
  "Data": {
    "Id": "session_abc123",
    "QueueId": "queue_xyz789",
    "Status": "Completed",
    "StartTime": "2024-01-15T14:30:00Z",
    "EndTime": "2024-01-15T14:35:30Z",
    "EndType": "Normal",
    "Clients": [
      {
        "ClientId": "client_123",
        "ClientType": "Phone",
        "JoinedAt": "2024-01-15T14:30:00Z",
        "LeftAt": "2024-01-15T14:35:30Z",
        "LeaveReason": "Hangup",
        "AudioUrl": "https://s3.amazonaws.com/recordings/client_123.mp3"
      }
    ],
    "Agents": [
      {
        "AgentId": "agent_xyz",
        "AgentType": "AI",
        "JoinedAt": "2024-01-15T14:30:02Z",
        "LeftAt": "2024-01-15T14:35:30Z",
        "AudioUrl": "https://s3.amazonaws.com/recordings/agent_xyz.mp3"
      }
    ],
    "Messages": [
      {
        "SenderId": "agent_xyz",
        "Role": "Agent",
        "Content": "Hello! Thanks for calling. How can I help you today?",
        "Timestamp": "2024-01-15T14:30:02Z"
      },
      {
        "SenderId": "client_123",
        "Role": "User",
        "Content": "I'd like to know more about your pricing.",
        "Timestamp": "2024-01-15T14:30:05Z"
      }
    ],
    "Logs": [
      {
        "Level": "Info",
        "Message": "Call connected successfully",
        "Timestamp": "2024-01-15T14:30:00Z"
      }
    ]
  }
}

Get outbound queue

Retrieve outbound call queue metadata and status. See the full Queue Management documentation for comprehensive queue operations.

GET /api/v1/business/{businessId}/queues/outbound/{queueId}

For detailed information about queue operations, filtering, and pagination, refer to the Queues API reference.

Permissions required

These endpoints require:

Valid API key with access to the specified business
Conversations.ConversationPermissions module permission with Full or Retrieving access
User and business must not be disabled
Business must have editing enabled

Notes

Audio URLs are pre-signed and expire after a period of time
Conversations are retained according to your data retention policy
Message timestamps are in UTC
Active conversations may not have complete message history until they’re finished
Use pagination cursors for efficient data retrieval of large result sets

FlowApp System

API Reference

Advanced

Get conversations

Path parameters

Request body

Response

Example request

Get conversation

Path parameters

Response

Example request

Example response

Get outbound queue

Permissions required

Notes

​Get conversations

​Path parameters

​Request body

​Response

​Example request

​Get conversation

​Path parameters

​Response

​Example request

​Example response

​Get outbound queue

​Permissions required

​Notes

Get conversations

Path parameters

Request body

Response

Example request

Get conversation

Path parameters

Response

Example request

Example response

Get outbound queue

Permissions required

Notes