Mixdesk API Reference

Retrieve conversations, contacts, and other data through the API.

Before you start

Go to Settings > API, obtain an Access Token, and enable it.

General requirements

• All APIs below require an Access Token. Resetting it invalidates the previous token. Request header:

Authorization: Bearer YOUR_ACCESS_TOKEN

• All request and response time fields use millisecond-level UTC ISO 8601 format. Example: 2024-01-01T00:00:00.000Z

Endpoints

1. Query conversations

Note: Only the most recent six months of data are available.

1.1 Conversation model

client_info fields:

messages fields:

source_client_info fields:

1.2 Get a conversation by ID

Endpoint:

GET https://api-gateway.mixdesk.com/mixdesk/hikari/open/api/v1/conversation/{conversation_id}

Request parameters:

Response parameters:

1.3 List conversations by end time

Endpoint:

GET https://api-gateway.mixdesk.com/mixdesk/hikari/open/api/v1/conversations

Request parameters:

Response parameters:

data fields:

2. Query contacts

Contact fields are returned only when enabled for display in the system.

2.1 Contact model

2.2 List contacts by creation time

Endpoint:

GET https://api-gateway.mixdesk.com/mixdesk/hikari/open/api/v1/contacts

Request parameters:

Response parameters:

data fields:

3. Send messages to Telegram

The Telegram bot ID is the numeric prefix of the token used when connecting the bot.

Find chat_user_id:

1. In the conversation’s right sidebar, use the value of the ID field in channel profile information.

2. Use the value returned by the API or webhook in source_client_info.user_id

3.1 Send-message model

3.2 Send text messages

Endpoint:

POST https://api-gateway.mixdesk.com/mixdesk/hikari/open/api/v1/telegram/send

Content-Type: application/json;

Request parameters:

Send-message model in JSON format

Response parameters:

data fields:

message_list fields:

Example

curl --location --request POST 'https://api-gateway.mixdesk.com/mixdesk/hikari/open/api/v1/telegram/send' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--data-raw '{
"tg_bot_id":"YOUR_BOT_ID",
"chat_user_id":"RECIPIENT_USER_ID",
"message_list":[
{
    "message_type":"text",
    "content":"Hello!"
}
]
}'

4. Team-member workload

Endpoint:

GET https://api-gateway.mixdesk.com/mixdesk/hikari/open/api/v1/agent_service

Request parameters:

Example response:

{
    "code": 1,
    "msg": "",
    "success": true,
    "data": [
        {
            "agent_id": 13,
            "agent_name": "Super Administrator",
            "group_id": 11,
            "group_name": "Default Group",
            "work_num": "",
            "conv_cnt": 0,
            "effective_conv_cnt": 0,
            "effective_conv_rate": 0,
            "missed_conv_cnt": 0,
            "missed_conv_rate": 0,
            "msg_cnt": 0,
            "duration_time": 0,
            "conv_first_response_wait_time": 0,
            "avg_response_wait_time": 0,
            "transfer_in_cnt": 0,
            "transfer_out_cnt": 0,
            "invited_eval_num": 0,
            "good_conv_cnt": 0,
            "medium_conv_cnt": 0,
            "bad_conv_cnt": 0,
            "eval_num": 0,
            "eval_rate": 0,
            "bad_evaluate_rate": 0,
            "medium_evaluate_rate": 0,
            "good_evaluate_rate": 0,
            "avg_evaluate_score": 0,
            "avg_human_duration_time": 0
        },
        {
            "agent_id": 486,
            "agent_name": "yyy",
            "group_id": 11,
            "group_name": "Default Group",
            "work_num": "002",
            "conv_cnt": 0,
            "effective_conv_cnt": 0,
            "effective_conv_rate": 0,
            "missed_conv_cnt": 0,
            "missed_conv_rate": 0,
            "msg_cnt": 0,
            "duration_time": 0,
            "conv_first_response_wait_time": 0,
            "avg_response_wait_time": 0,
            "transfer_in_cnt": 0,
            "transfer_out_cnt": 0,
            "invited_eval_num": 0,
            "good_conv_cnt": 0,
            "medium_conv_cnt": 0,
            "bad_conv_cnt": 0,
            "eval_num": 0,
            "eval_rate": 0,
            "bad_evaluate_rate": 0,
            "medium_evaluate_rate": 0,
            "good_evaluate_rate": 0,
            "avg_evaluate_score": 0,
            "avg_human_duration_time": 0
        }
    ]
}

Parameter descriptions:

Response parameters:

5. Send messages to Facebook

After connecting the channel, find PageID in the Page ID column.

Find the conversation user ID:

1. In the conversation’s right sidebar, use the value of the ID field in channel profile information.

2. Use the value returned by the API or webhook in source_client_info.user_id

5.1 Send-message model

5.2 Send messages

Endpoint:

POST https://api-gateway.mixdesk.com/mixdesk/hikari/open/api/v1/messenger/send

Content-Type: application/json; charset=utf-8

Request parameters:

Send-message model in JSON format

Response parameters:

data fields:

message_list fields:

Example

curl --location --request POST 'https://api-gateway.mixdesk.com/mixdesk/hikari/open/api/v1/messenger/send' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "page_id": "page_id",
    "chat_user_id": "chat_user_id",
    "tag": "",
    "message_list": [
        {
            "message_type": "text",
            "content": "123"
        },
        {
            "message_type": "photo",
            "photo": {
                "url": "url"
            }
        },
        {
            "message_type": "video",
            "video": {
                "url": "url",
                "file_name": "hello",
                "size":100
            }
        },
        {
            "message_type": "audio",
            "audio": {
                "url": "url"
            }
        },
        {
            "message_type": "file",
            "file": {
                "url": "url",
                "file_name": "image",
                "size": 100
            }
        }
    ]
}'

6. Send messages to WhatsApp App

After connecting the channel, find phone_number in the Phone Number column. Do not include the + sign.

Find the conversation user ID

1. Use a known user or group ID. User IDs use phone-number@c.us, for example 8618888888888@c.us. Group IDs use digits@g.us, for example 1201111111111111111111@g.us.
2. Use the value returned by the API or webhook in source_client_info.user_id

6.1 Send-message model

6.2 Send messages

Endpoint: POST https://api-gateway.mixdesk.com/mixdesk/hikari/open/api/v1/pwa/send

Content-Type: application/json; charset=utf-8

Request parameters:

Send-message model in JSON format

Response parameters:

data fields:

message_list fields:

Example

curl --location --request POST 'https://api-gateway.mixdesk.com/mixdesk/hikari/open/api/v1/pwa/send' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "phone_number": "phone_number",
    "chat_user_id": "chat_user_id",
    "message_list": [
        {
            "message_type": "text",
            "content": "123"
        },
        {
            "message_type": "photo",
            "photo": {
                "url": "url"
            }
        },
        {
            "message_type": "video",
            "video": {
                "url": "url",
                "file_name": "hello",
                "size":100
            }
        },
        {
            "message_type": "audio",
            "audio": {
                "url": "url"
            }
        },
        {
            "message_type": "file",
            "file": {
                "url": "url",
                "file_name": "image",
                "size": 100
            }
        }
    ]
}'

7. Send messages to the Web channel

A Web visitor must have created a conversation before a track_id is available.

1. In conversation details, find the Visit Identifier value in the contact information on the right.

7.1 Send-message model

7.2 Send text messages

Endpoint: POST https://api-gateway.mixdesk.com/mixdesk/hikari/open/api/v1/web/send

Content-Type: application/json; charset=utf-8

Request parameters:

Send-message model in JSON format

Response parameters:

data fields:

message_list fields:

Example

curl --location --request POST 'https://api-gateway.mixdesk.com/mixdesk/hikari/open/api/v1/web/send' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "track_id": "track_id",
    "message_list": [
        {
            "message_type": "text",
            "content": "123"
        },
        {
            "message_type": "photo",
            "photo": {
                "url": "url"
            }
        },
        {
            "message_type": "video",
            "video": {
                "url": "url",
                "file_name": "hello",
                "size":100
            }
        },
        {
            "message_type": "audio",
            "audio": {
                "url": "url"
            }
        },
        {
            "message_type": "file",
            "file": {
                "url": "url",
                "file_name": "image",
                "size": 100
            }
        }
    ]
}'

Status code