Створити повідомлення

Публікуйте повідомлення в будь-якому чаті від імені клієнта або оператора
Написано Микола
Оновлено 2 місяці тому

Ви можете публікувати повідомлення в будь-якому чаті від імені клієнта або оператор.

➡️ Запит

URL https://api.helpcrunch.com/v1/messages
Метод POST
Headers Authorization: Bearer <your_api_key>

ID чату та атрибути повідомлення мають бути розміщені в тілі запиту POST. Перегляньте приклад нижче.

{
    "chat": 5215261,
    "text": "Can you can a can as a canner can can a can?",
    "markdownText": "Can you can a **can** as a canner can can a **can**",
    "agent": 4188,
    "type": "message"
}

chat, text, agent і type обов'язкові під час створення повідомлення від оператора. Для повідомлення від клієнта просто пропустіть параметр agent.

Якщо ви хочете створити повідомлення з розміткою (жирний, курсив, підкреслення тощо),  додатково вкажіть атрибут markdownText.

Зверніть увагу, що у відповіді немає параметра markdownText. Текст із розміткою буде розміщено в полі text.

✅ Відповідь на успішний запит

Якщо ваш запит пройшов успішно, ви отримаєте код успішного статусу 200 OK разом із наведеним нижче тілом відповіді.

{
    "id": 9577656,
    "agent": {
        "id": 4188,
        "name": "Sam"
    },
    "type": "message",
    "text": null,
    "read": false,
    "createdAt": "1601557390.769",
    "updatedAt": null,
    "edited": false,
    "broadcastType": null,
    "chat": 5215261,
    "from": "agent"
}

🛑 Відповіді з помилками

Ви можете отримати один із наведених нижче кодів статусу помилки та відповіді.

400 Bad Request

{
    "errors": [
        {
            "code": "invalid_chat_value",
            "message": "Invalid chat ID"
        }
    ]
}

401 Unauthorized

{
    "errors": [
        {
            "code": "invalid_token",
            "message": "Invalid token"
        }
    ]
}

404 Not Found

{
    "errors": [
        {
            "code": "chat_not_found",
            "message": "Chat is missing"
        }
        {
            "code": "entity_not_found",
            "message": "Agent not found"
        }
    ]
}

429 Too Many Requests

{
    "errors": [
        {
            "code": "too_many_requests",
            "message": "You have exceeded your requests limit"
        }
    ]
}
Чи була наша стаття корисною?