GetStatus - TCN API

Returns an aggregate of the statuses of all channels

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "asm_session_sid": 0,
    "perform_keep_alive": true,
    "perform_get_queued_calls": true,
    "perform_get_message": true,
    "minimum_message_timestamp": 0,
    "skills": [
        "string"
    ],
    "events": [
        {
            "activated_conversation_event": {
                "conversation": {
                    "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"
                }
            }
        }
    ],
    "agent_pbx_extensions": [
        "string"
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/asm/asmapi/getstatus' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "asm_session_sid": 0,
    "perform_keep_alive": true,
    "perform_get_queued_calls": true,
    "perform_get_message": true,
    "minimum_message_timestamp": 0,
    "skills": [
        "string"
    ],
    "events": [
        {
            "activated_conversation_event": {
                "conversation": {
                    "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"
                }
            }
        }
    ],
    "agent_pbx_extensions": [
        "string"
    ]
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "voice_status": {
        "status": 0,
        "status_desc": "UNAVALIABLE",
        "paused": true,
        "queue": "string",
        "current_session_id": 0,
        "last_status_change": 0,
        "monitoring": true,
        "calls_count": 0,
        "last_sip_code": 0,
        "agent_peer_is_lost_call": true,
        "disabled": true,
        "keep_alive_succeeded": true,
        "message": "string",
        "message_timestamp": 0,
        "queued_calls": {
            "agent_queue_calls": [
                {
                    "call_sid": 0,
                    "phone_number": "string",
                    "caller_id": "string",
                    "call_type": "INBOUND",
                    "start_date": "1s",
                    "hold_date": "1s",
                    "skills": [
                        "string"
                    ],
                    "agent_specific": true,
                    "queued_notification_type": "QueuedNotificationType_GENERAL_INITIAL"
                }
            ],
            "on_hold_calls": [
                {
                    "call_sid": 0,
                    "phone_number": "string",
                    "caller_id": "string",
                    "call_type": "INBOUND",
                    "start_date": "1s",
                    "hold_date": "1s",
                    "skills": [
                        "string"
                    ],
                    "agent_specific": true,
                    "queued_notification_type": "QueuedNotificationType_GENERAL_INITIAL"
                }
            ],
            "hqm_calls": [
                {
                    "call_sid": 0,
                    "phone_number": "string",
                    "caller_id": "string",
                    "call_type": "INBOUND",
                    "start_date": "1s",
                    "hold_date": "1s",
                    "skills": [
                        "string"
                    ],
                    "agent_specific": true,
                    "queued_notification_type": "QueuedNotificationType_GENERAL_INITIAL"
                }
            ]
        },
        "caller_was_suspended": true,
        "transfer_members": [
            {
                "agent_session": {
                    "agent_sid": 0,
                    "tenant_sid": 0,
                    "session_sid": 0,
                    "asm_session_sid": 0,
                    "org_id": "string",
                    "region_id": "string",
                    "user_id": "string"
                }
            }
        ],
        "alert": {
            "backoffice_message": {
                "expire_duration": 0,
                "timestamp": "1s",
                "target_agent_session": {
                    "agent_sid": 0,
                    "tenant_sid": 0,
                    "session_sid": 0,
                    "asm_session_sid": 0,
                    "org_id": "string",
                    "region_id": "string",
                    "user_id": "string"
                },
                "message": "string",
                "id": "string"
            }
        },
        "agent_peer_is_direct_to_agent": true,
        "agent_is_muted": true
    }
}

🟢200Success