Terms of servicePricing

Conversation

Start conversation

POST https://app.blinger.io/api/conversations/start

This endpoint allows you to start the conversation.

Headers

Name
Type
Description

Authentication

string

Authentication token

Request Body

Name
Type
Description

conversation_id

integer

operator_id

integer

Default - Admin

disable_webhook

integer

Default - 0

{
    "status": 200,
    "data": {
        "id": 2,
        "user_id": 1,
        "operator_user_id": 1,
        "from_blinger_user_id": 5,
        "to_blinger_user_id": 4,
        "from_user_name": "LiveChat client #5",
        "to_user_name": "[email protected]",
        "application": "livechat",
        "last_message": "124124",
        "unread_count": 0,
        "status": "inbox",
        "date_created": 1559737532,
        "date_updated": 1560107366,
        "from_user_avatar": null,
        "is_outgoing": false,
        "token": "A0N_JeEemP_2TItFDcw-RrvuIrJ4ZWcdQixrkYB1PBJP7c5ZKLN0Mm200XCr8ABU",
        "is_new_conversation": false,
        "waiting_operator_response": false,
        "group_id": 1,
        "is_inner_message": null,
        "is_operator_last_message": true,
        "is_group_closed": false,
        "close_group": null,
        "type": "message",
        "comment_post_id": null,
        "comment_post_url": null,
        "comment_post_title": null,
        "comment_post_img": null,
        "unassigned_date": 1559807929,
        "last_message_date": 1559826168,
        "from_user_custom_name": null,
        "toBlingerUser": {
            "id": 4,
            "service_blinger_id": 1,
            "blinger_user_id": 4,
            "is_active": true,
            "date_updated": 1559737517,
            "date_created": 1559737517,
            "tags": null,
            "name": null,
            "role": "customer",
            "avatar": null,
            "application": "livechat",
            "service_user_id": null,
            "status": "enabled",
            "group_id": null,
            "is_comments": null,
            "page_url": null,
            "page_title": null,
            "extra_fields": null,
            "extra_field_secret_key": "g9k0jUSfIBdr12zgMJWLVKoi-WdhSyaf",
            "custom_name": null
        }
    }
}

Close conversation

POST https://app.blinger.io/api/conversations/close

This endpoint allows you to close the conversation.

Headers

Name
Type
Description

Authentication

string

Authentication token

Request Body

Name
Type
Description

conversation_id

integer

operator_id

integer

Default - Admin

disable_webhook

integer

Default - 0

Unassign conversation

POST https://app.blinger.io/api/conversations/unassign

Path Parameters

Name
Type
Description

Authentication

string

Authentication token

Request Body

Name
Type
Description

conversation_id

integer

operator_id

integer

Default - Admin

disable_webhook

integer

Default - 0

Assign operator

POST https://app.blinger.io/api/conversations/assign-operator

This endpoint allows you to assign the operator to the conversations

Headers

Name
Type
Description

Authentication

string

Authentication token

Request Body

Name
Type
Description

conversation_id

integer

operator_id

integer

disable_webhook

integer

Default - 0

Assign group

POST https://app.blinger.io/api/conversations/assign-group

This endpoint allows you to assign the group to the conversation

Headers

Name
Type
Description

Authentication

string

Authentication token

Request Body

Name
Type
Description

conversation_id

integer

group_id

integer

Send message

POST https://app.blinger.io/api/conversations/send-message

Headers

Name
Type
Description

Authentication

string

Authentication token

Request Body

Name
Type
Description

conversation_id

integer

text

string

operator_id

integer

Default - Admin

disable_webhook

integer

Default - 0

Send file message

POST https://app.blinger.io/api/conversations/send-file-message

Path Parameters

Name
Type
Description

Authentication

string

Authentication token

Request Body

Name
Type
Description

conversation_id

integer

file_url

string

operator_id

integer

Default - Admin

disable_webhook

integer

Default - 0

Send note

POST https://app.blinger.io/api/conversations/send-note

Path Parameters

Name
Type
Description

Authentication

string

Authentication token

Request Body

Name
Type
Description

operator_id

integer

Default - Admin

text

string

conversation_id

integer

Get unassigned conversations

GET https://app.blinger.io/api/conversations/unassigned

This endpoint allows you to get unassigned conversations. Conversations are sorted by date updated in descending order (limit 1000).

Path Parameters

Name
Type
Description

group_id

integer

Get unread conversations

GET https://app.blinger.io/api/conversations/unread

This endpoint allows you to get unread conversations with status "inbox" for a specific operator. Conversations are sorted by date updated in descending order (limit 1000).

Path Parameters

Name
Type
Description

operator_id

integer

group_id

integer

Get not answered conversations

GET https://app.blinger.io/api/conversations/not-answered

This endpoint allows you to get not answered conversations with status "inbox" for a specific operator. Conversations are sorted by date updated in descending order (limit 1000).

Path Parameters

Name
Type
Description

operator_id

integer

group_id

integer

Get conversation by ID

GET https://app.blinger.io/api/conversations/get

This endpoint allows you to get conversation info by ID

Query Parameters

Name
Type
Description

conversation_id*

integer

PreviousAPI TokenNextOperator

Last updated

Was this helpful?