Créer un ticket avec l'API Freshdesk
Crée un ticket. Identifiez le demandeur avec requester_id, email, phone ou unique_external_id ; un email ou phone absent de Freshdesk crée le contact.
- Identifiant
- freshdesk_create_ticket
L'appel
POST https://connect.reportei.com/api/tools/freshdesk_create_ticket/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"requester_id": 1
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| requester_id | integer | Non | Id of an existing contact as the requester, from List contacts. |
| string | Non | Email address of the requester. A new address creates the contact. | |
| phone | string | Non | Phone number of the requester. A new number creates the contact, and without email the name becomes mandatory. |
| unique_external_id | string | Non | External id of the requester, the id in your own system. A new id creates the contact. |
| name | string | Non | Name of the requester. |
| subject | string | Non | Subject of the ticket. |
| description | string | Non | Content of the ticket, as HTML or plain text. |
| status | integer | Non | 2 Open (the default), 3 Pending, 4 Resolved or 5 Closed. Custom statuses of the helpdesk are the choices of the status field in List ticket fields. |
| priority | integer | Non | 1 Low (the default), 2 Medium, 3 High or 4 Urgent.Valeurs : 1, 2, 3, 4 |
| source | integer | Non | Channel of the ticket: 1 Email, 2 Portal (the default), 3 Phone, 7 Chat, 9 Feedback widget or 10 Outbound email.Valeurs : 1, 2, 3, 7, 9, 10 |
| type | string | Non | Ticket type, one of the choices of the ticket_type field in List ticket fields, such as Question or Incident. |
| responder_id | integer | Non | Id of the agent to assign the ticket to, from the choices of the agent field in List ticket fields. |
| group_id | integer | Non | Id of the group to assign the ticket to, from the choices of the group field in List ticket fields. |
| product_id | integer | Non | Id of the product of the ticket, from the choices of the product field in List ticket fields. |
| company_id | integer | Non | Id of the company of the requester, from Search companies. Only with the Multiple Companies feature. |
| tags | array | Non | Tags of the ticket. |
| cc_emails | array | Non | Email addresses copied on the ticket. |
| due_by | string | Non | When the ticket is due to be resolved. Without it, the SLA policy of the helpdesk sets it. |
| fr_due_by | string | Non | When the first response is due. Without it, the SLA policy of the helpdesk sets it. |
| custom_fields | object | Non | Custom field values keyed by the name of each custom field in List ticket fields, for example cf_order_number. Dates go as YYYY-MM-DD. |
Connexions possibles
Votre client connecte son compte Freshdesk une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Identifiant et mot de passe
Votre client saisit les identifiants de l'app sur un écran de Connect, ou votre système les envoie avec POST /api/customer-toolkits, sans écran.
À la connexion, votre client indique aussi {domain} : l'adresse de son compte sur l'API de l'app.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/freshdesk_create_ticket. Il devient la définition de tool de votre agent sans conversion.
Autres tools Freshdesk
- Lister les ticketsGETListe les tickets, les plus récents d'abord par défaut. Sans updated_since seuls les tickets créés dans les 30 derniers jours reviennent, et spam ou supprimés ne viennent qu'avec un filtre.
- Rechercher des ticketsGETRecherche des tickets avec une query de filtre, par exemple par statut, priorité, agent, groupe, tag ou champ personnalisé. Renvoie total et results, 30 tickets par page.
- Obtenir un ticketGETRenvoie un ticket avec status, priority, requester_id, responder_id, group_id, tags, custom_fields et description.
- Mettre à jour un ticketPUTMet à jour un ticket : envoyez uniquement les champs à changer, et tags comme la liste complète que le ticket doit garder. Status 4 le résout et 5 le ferme.
- Lister les conversations d'un ticketGETListe les réponses et notes d'un ticket, avec body (HTML), body_text, private, incoming, user_id et source (0 réponse, 2 note). Les pages sont numérotées à partir de 1.
- Créer une réponse de ticketPOSTRépond au demandeur d'un ticket. Freshdesk envoie la réponse par e-mail au demandeur, elle est donc visible du client.
- Créer une note de ticketPOSTAjoute une note à un ticket. Les notes sont privées par défaut, visibles des agents seulement ; avec private à false le demandeur la voit aussi.
- Lister les champs de ticketGETListe les champs de ticket du helpdesk avec leurs choix : ids d'agents dans le champ agent, ids de groupes dans le champ groupe, ids de produits et valeurs de statut.
Toolkits de la même catégorie
Voir les 100 toolkitsVoyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
