ListConversations

Lists the conversations for an assigned agent

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "asm_session_sid": 0,
    "authenticated_user": {
        "claims": {
            "auth0_user_id": "string",
            "org_user_id": "string",
            "org_id": "string",
            "api_key": "string",
            "region_id": "string",
            "name": "string",
            "impersonate": "string",
            "client_sid": 0,
            "agent_sid": 0,
            "login_sid": 0,
            "active_org_id": "string"
        }
    },
    "user_id": "string",
    "statuses": [
        "CONVERSATION_STATUS_NEW"
    ],
    "field_mask": "string",
    "channel_types": [
        "CHANNEL_TYPE_EMAIL"
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Example

{
    "conversations": [
        {
            "conversation_sid": 0,
            "channel_type": "CHANNEL_TYPE_EMAIL",
            "skills": {
                "skills": {
                    "property1": true,
                    "property2": true
                }
            },
            "date_created": "1s",
            "date_modified": "1s",
            "status": "CONVERSATION_STATUS_NEW",
            "customer_email_address": "string",
            "customer_phone_number": "string",
            "customer_name": "string",
            "campaign_sid": 0,
            "reference_id": "string",
            "last_message_time": "1s",
            "conversation_collected_data": {
                "items": [
                    {
                        "conversation_collected_data_sid": 0,
                        "conversation_sid": 0,
                        "data_name": "string",
                        "data_value": "string",
                        "collection_time": "1s",
                        "user_id": "string"
                    }
                ]
            },
            "sla_timeouts": {
                "t1": 0,
                "t2": 0,
                "t3": 0,
                "t10": 0,
                "t11": 0,
                "t12": 0
            },
            "conversation_assignments": [
                {
                    "conversation_assignment_sid": 0,
                    "conversation_sid": 0,
                    "is_active": true,
                    "assignment_type": "PRIMARY_AGENT",
                    "date_created": "1s",
                    "date_modified": "1s",
                    "user_id": "string",
                    "metadata": {
                        "user_name": "string"
                    },
                    "asm_session_sid": 0
                }
            ],
            "metadata": {
                "campaign_name": "string",
                "support_email": "string",
                "campaign_shorten_url": true,
                "payment_portal_ids": [
                    "string"
                ]
            },
            "end_time": "1s",
            "campaign_module_sid": 0,
            "last_message_group_time": "1s",
            "last_message_group_type": "OMNI_SENDER_TYPE_AGENT",
            "result": "NONE",
            "last_state_changed_time": "1s",
            "task_sid": "string"
        }
    ],
    "next_page_token": "string"
}

🟢200Success