Créer une conversation

Les développeurs peuvent créer des conversations via l'API.

Méthode de requête

POST

URL de requête

https://livedesk-api.engagelab.com/api/v2/accounts/conversations

Authentification

Pour plus de détails, consultez la description de la méthode d'authentification dans la Présentation de l'API.

Requête

Exemple de requête

curl -X POST https://livedesk-api.engagelab.com/api/v2/accounts/conversations \ -H 'Content-Type: application/json' \ -H 'Authorization: Basic base64(api_key:api_secret)' \ { "inbox_id": 407, // Obligatoire "contact_id": 2219256, // Renseignez contact_id ou source_id afin de garantir que l'expéditeur peut être correctement identifié "source_id": "123456789" }

              
              curl -X POST https://livedesk-api.engagelab.com/api/v2/accounts/conversations \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \
{
  "inbox_id": 407,              // Obligatoire
  "contact_id": 2219256,        // Renseignez contact_id ou source_id afin de garantir que l'expéditeur peut être correctement identifié
  "source_id": "123456789"
}

Afficher ce bloc de code dans la fenêtre flottante

Paramètres d'en-tête de la requête

Champ	Type	Description
Authorization	string	Utilisez `Authorization: Basic base64(API Key:API Secret)` pour l'authentification. Accédez à la page API Key pour obtenir l'API Key et l'API Secret, reliez-les avec un deux-points, puis encodez le résultat en Base64.
Content-Type	application/json	Il s'agit du format de données de la requête. Utilisez `application/json`.

Paramètres du corps de la requête

Champ	Type	Obligatoire	Description
inbox_id	String	Oui	ID du canal. Il doit correspondre à l'ID utilisé dans l'interface de création de contact.
contact_id	String	Non	ID du contact. Il s'agit de la valeur `id` renvoyée dans la réponse de l'interface de création de contact.
source_id	String	Non	ID de source.

Réponse

Exemple de réponse

{ "meta": { "sender": { "additional_attributes": {}, "availability_status": "offline", "email": null, "id": 2219256, "name": "wjTest", "phone_number": null, "blocked": false, "identifier": null, "thumbnail": "", "custom_attributes": {}, "created_at": 1766571624 }, "channel": "Channel::Api", "hmac_verified": false }, "id": 40, "messages": [], "account_id": 17623000010928, "uuid": "660ce36f-46bb-4153-948c-8a26e6dab634", "inbox_id": 407, "additional_attributes": {}, "agent_last_seen_at": 0, "assignee_last_seen_at": 0, "can_reply": true, "contact_last_seen_at": 0, "custom_attributes": {}, "labels": [], "muted": false, "snoozed_until": null, "status": "open", "priority": null, "conversation_category": "chat", "chat_mode": "private_chat", "is_forum": false, "created_at": 1766572062, "updated_at": 1766572062.5803902, "timestamp": 1766572062, "first_reply_created_at": 0, "unread_count": 0, "last_non_activity_message": null, "last_activity_at": 1766572062, "waiting_since": 1766572062, "sla_policy_id": null, "ticket_id": null, "over_limit": false, "content_preview": { "content": null, "message_type": null, "created_at": null }, "platform": { "channel_type": "Channel::Api", "inbox_name": "JennyApi", "inbox_id": 407 }, "account_info": { "contact_name": "wjTest", "contact_email": null, "contact_phone": null, "contact_id": 2219256, "contact_avatar": "" }, "assignment": { "assignee_id": null, "assignee_name": null, "assignee_email": null, "team_id": null, "team_name": null } }

              
              {
    "meta": {
        "sender": {
            "additional_attributes": {},
            "availability_status": "offline",
            "email": null,
            "id": 2219256,
            "name": "wjTest",
            "phone_number": null,
            "blocked": false,
            "identifier": null,
            "thumbnail": "",
            "custom_attributes": {},
            "created_at": 1766571624
        },
        "channel": "Channel::Api",
        "hmac_verified": false
    },
    "id": 40,
    "messages": [],
    "account_id": 17623000010928,
    "uuid": "660ce36f-46bb-4153-948c-8a26e6dab634",
    "inbox_id": 407,
    "additional_attributes": {},
    "agent_last_seen_at": 0,
    "assignee_last_seen_at": 0,
    "can_reply": true,
    "contact_last_seen_at": 0,
    "custom_attributes": {},
    "labels": [],
    "muted": false,
    "snoozed_until": null,
    "status": "open",
    "priority": null,
    "conversation_category": "chat",
    "chat_mode": "private_chat",
    "is_forum": false,
    "created_at": 1766572062,
    "updated_at": 1766572062.5803902,
    "timestamp": 1766572062,
    "first_reply_created_at": 0,
    "unread_count": 0,
    "last_non_activity_message": null,
    "last_activity_at": 1766572062,
    "waiting_since": 1766572062,
    "sla_policy_id": null,
    "ticket_id": null,
    "over_limit": false,
    "content_preview": {
        "content": null,
        "message_type": null,
        "created_at": null
    },
    "platform": {
        "channel_type": "Channel::Api",
        "inbox_name": "JennyApi",
        "inbox_id": 407
    },
    "account_info": {
        "contact_name": "wjTest",
        "contact_email": null,
        "contact_phone": null,
        "contact_id": 2219256,
        "contact_avatar": ""
    },
    "assignment": {
        "assignee_id": null,
        "assignee_name": null,
        "assignee_email": null,
        "team_id": null,
        "team_name": null
    }
}

Afficher ce bloc de code dans la fenêtre flottante

Paramètres de réponse

Champ	Type	Obligatoire	Description
meta	Object	Non	Objet de métadonnées.
sender	Object	Non	Informations sur l'expéditeur.
additional_attributes	Object	Non	Attributs supplémentaires.
availability_status	String	Non	Statut de disponibilité.
email	Null	Non	E-mail.
id	Number	Non	ID du contact.
name	String	Non	Nom de l'expéditeur.
phone_number	Null	Non	Numéro de téléphone.
blocked	Boolean	Non	Indique si l'utilisateur est bloqué.
identifier	Null	Non	Identifiant d'attribut utilisateur.
thumbnail	String	Non	Miniature.
custom_attributes	Object	Non	Attributs personnalisés.
created_at	Number	Non	Horodatage de création de la conversation.
channel	String	Non	Type de canal.
hmac_verified	Boolean	Non	Statut de vérification HMAC.
id	Number	Non	ID de la conversation.
messages	Array	Non	Tableau de messages.
account_id	Number	Non	ID du projet.
uuid	String	Non	Identifiant unique.
inbox_id	Number	Non	ID du canal.
additional_attributes	Object	Non	Attributs supplémentaires.
agent_last_seen_at	Number	Non	Dernière activité de l'agent.
assignee_last_seen_at	Number	Non	Dernière activité de l'assigné.
can_reply	Boolean	Non	Indique si une réponse est possible.
contact_last_seen_at	Number	Non	Dernière activité du contact.
custom_attributes	Object	Non	Attributs personnalisés.
labels	Array	Non	Tableau d'étiquettes.
muted	Boolean	Non	Indique si la conversation est en sourdine.
snoozed_until	Null	Non	Date jusqu'à laquelle la conversation est mise en veille.
status	String	Non	Statut.
priority	Null	Non	Priorité.
conversation_category	String	Non	Catégorie de conversation.
chat_mode	String	Non	Mode de chat.
is_forum	Boolean	Non	Indique s'il s'agit d'un forum.
created_at	Number	Non	Horodatage de création.
updated_at	Number	Non	Horodatage de mise à jour.
timestamp	Number	Non	Horodatage.
first_reply_created_at	Number	Non	Date de création de la première réponse.
unread_count	Number	Non	Nombre de messages non lus.
last_non_activity_message	Null	Non	Dernier message non lié à une activité.
last_activity_at	Number	Non	Heure de la dernière activité.
waiting_since	Number	Non	Heure de début d'attente.
sla_policy_id	Null	Non	ID de la politique SLA.
ticket_id	Null	Non	ID du ticket.
over_limit	Boolean	Non	Indique si la limite est dépassée.
content_preview	Object	Non	Aperçu du contenu.
content_preview.content	Null	Non	Contenu de l'aperçu.
content_preview.message_type	Null	Non	Type de message.
content_preview.created_at	Null	Non	Date de création.
platform	Object	Non	Informations sur la plateforme.
channel_type	String	Non	Type de canal.
inbox_name	String	Non	Nom de la boîte de réception.
inbox_id	Number	Non	ID de la boîte de réception.
account_info	Object	Non	Informations sur le compte.
contact_name	String	Non	Nom du contact.
contact_email	Null	Non	E-mail du contact.
contact_phone	Null	Non	Téléphone du contact.
contact_id	Number	Non	ID du contact.
contact_avatar	String	Non	Avatar du contact.
assignment	Object	Non	Informations d'affectation.
assignee_id	Null	Non	ID de l'assigné.
assignee_name	Null	Non	Nom de l'assigné.
assignee_email	Null	Non	E-mail de l'assigné.
team_id	Null	Non	ID de l'équipe.
team_name	Null	Non	Nom de l'équipe.