Créer un ticket
Les développeurs peuvent créer un ticket via l'API. Une fois le ticket créé, l'identifiant du ticket est renvoyé.
Méthode de requête
POST
Point de terminaison
https://livedesk-api.engagelab.com/api/v2/accounts/tickets
Authentification
Pour plus de détails, consultez les instructions 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/tickets' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \
-d '{
"title": "Printer paper jam, unable to print",
"description": "The customer reported that A4 paper is stuck at the paper outlet and requires urgent attention.",
"attachments": [
{
"file_url": "https://example.com/files/error.jpg"
}
],
"requester": {
"euid": "contact_12345",
"channel_contacts": {
"channel_id": "inbox_100",
"contact_id": "-1001234567890",
"sub_contact_id": "23232323",
"followers": [
{
"id": "7562646527",
"name": "Zhang San"
}
]
}
},
"submitter": {
"id": "u_12345"
},
"assignment_team": "IT Support",
"priority": "high",
"ticket_type": "incident",
"custom_fields": {
"device_sn": "PRN-2024-001",
"location": "Beijing Headquarters—3rd Floor Printer Room"
}
}'
curl -X POST 'https://livedesk-api.engagelab.com/api/v2/accounts/tickets' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \
-d '{
"title": "Printer paper jam, unable to print",
"description": "The customer reported that A4 paper is stuck at the paper outlet and requires urgent attention.",
"attachments": [
{
"file_url": "https://example.com/files/error.jpg"
}
],
"requester": {
"euid": "contact_12345",
"channel_contacts": {
"channel_id": "inbox_100",
"contact_id": "-1001234567890",
"sub_contact_id": "23232323",
"followers": [
{
"id": "7562646527",
"name": "Zhang San"
}
]
}
},
"submitter": {
"id": "u_12345"
},
"assignment_team": "IT Support",
"priority": "high",
"ticket_type": "incident",
"custom_fields": {
"device_sn": "PRN-2024-001",
"location": "Beijing Headquarters—3rd Floor Printer Room"
}
}'
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de requête
| Field | Type | Description |
|---|---|---|
| Authorization | string | Authentifiez-vous à l'aide de Authorization: Basic base64(API Key:API Secret). Accédez à la page API Keys pour obtenir la clé API et le secret API, reliez-les par deux-points, puis encodez-les en Base64. |
| Content-Type | application/json | Type de données. La valeur doit être application/json. |
Paramètres du corps de la requête
| Field | Type | Required | Description |
|---|---|---|---|
| title | String | Yes | Titre du ticket. |
| description | String | No | Description du ticket. Prend en charge le format Markdown. |
| attachments | Array | No | Tableau des pièces jointes. Téléversez d'abord les fichiers via /upload. |
| file_url | String | Yes | URL du fichier. |
| requester | Object | Yes | Informations sur le demandeur. |
| euid | String | No | Identifiant de contact unique. |
| channel_contacts | Object | No | Correspondance du contact du canal. Au moins l'un de euid ou ce champ doit être fourni. |
| channel_id | String | Yes | Identifiant du canal. |
| contact_id | String | Yes | Identifiant du contact du canal, tel que l'identifiant de discussion Telegram. |
| sub_contact_id | String | No | Identifiant du sous-contact du canal, tel que l'identifiant de sujet Telegram ou l'identifiant du fil d'e-mail. |
| followers | Array | No | Informations sur les identifiants des abonnés utilisées pour l'envoi dans le canal et les notifications, y compris les champs id et name.id : identifiant de l'abonné.name : nom de l'abonné. |
| submitter | Object | No | Informations sur le soumetteur, y compris le champ id.id : identifiant du soumetteur. |
| assignment_team | String | No | Nom de l'équipe d'attribution. L'équipe doit déjà exister. |
| priority | String | No | Priorité : high, medium ou low. La valeur par défaut est medium si elle est omise. |
| ticket_type | String | No | Type de ticket : problem, incident, question, task ou none. La valeur par défaut est none si elle est omise. |
| custom_fields | Object | No | Champs personnalisés, tels que les informations de source, au format clé-valeur. |
Réponse
Réponse réussie
{
"code": 0,
"message": "Success",
"data": {
"ticket_id": "tk_20251104_789abc",
"message": "Ticket created successfully"
}
}
{
"code": 0,
"message": "Success",
"data": {
"ticket_id": "tk_20251104_789abc",
"message": "Ticket created successfully"
}
}
Afficher ce bloc de code dans la fenêtre flottante
Paramètres de réponse
| Field | Type | Required | Description |
|---|---|---|---|
| ticket_id | String | No | Identifiant du ticket. |
| message | String | No | Contenu du message renvoyé. Par exemple : "Ticket created successfully". |
