Smart Routings — CTI

Une CTI est une table de correspondance qui associe une origine (généralement le numéro de l'appelant) à une destination. Consultez Smart Routings pour les notions communes à tous les endpoints Smart Routings.

Tous les endpoints de cette section sont propres à l'espace de travail et nécessitent le scope OAuth client, sauf mention contraire. L'endpoint de recherche accepte aussi le scope cfd.

En-têtes : Authorization: Bearer {workspace-token}

Paramètre de requête obligatoire : customer_account — le compte client concerné. Voir Choix du compte client.

#CTI

#L'objet CTI

Toute personne qui connaît le token d'une CTI peut lire ses destinations sans authentification. Traitez-le comme un secret et régénérez-le en cas de fuite.

#GET /api/smart-routings/ctis

Renvoie la liste paginée des CTI du client, de la plus récemment modifiée à la plus ancienne. Chaque CTI inclut un champ destinations_count.

Paramètres de requête

Réponse 200 — réponse paginée

{
  "data": [
    {
      "id": 4,
      "customer_id": 12,
      "name": "VIP callers",
      "token": "q8Zb3kV0yR1mN7tXwP2sL5cH9dF4gJ6aE0uI3oK8vB1nM5zQ7xC2yT4rW6eS9pD0hG3jL8fA1kU5iO7mN2b",
      "created_at": "2024-03-04T10:12:00.000000Z",
      "updated_at": "2024-06-18T08:45:00.000000Z",
      "destinations_count": 42,
      "token_lookup_url": "https://acme.cx-engine.app/api/smart-routings/ctis/t/q8Zb3kV0yR1m.../%CallerNumber%"
    }
  ],
  "current_page": 1,
  "last_page": 1,
  "per_page": 20,
  "total": 1
}

#GET /api/smart-routings/ctis/{cti}

Renvoie une CTI avec son customer et ses destinations.

Réponse 200

{
  "id": 4,
  "customer_id": 12,
  "name": "VIP callers",
  "token": "q8Zb3kV0yR1m...",
  "created_at": "2024-03-04T10:12:00.000000Z",
  "updated_at": "2024-06-18T08:45:00.000000Z",
  "token_lookup_url": "https://acme.cx-engine.app/api/smart-routings/ctis/t/q8Zb3kV0yR1m.../%CallerNumber%",
  "customer": { ... },
  "destinations": [
    {
      "id": 101,
      "cti_id": 4,
      "origin": "+33612345678",
      "destination": "201",
      "created_at": "2024-03-04T10:15:00.000000Z",
      "updated_at": "2024-03-04T10:15:00.000000Z"
    }
  ]
}

Réponse 403 — la CTI appartient à un autre client ou la permission est manquante

#POST /api/smart-routings/ctis

Crée une CTI. Son token est généré automatiquement.

Corps de la requête

Réponse 201 — l'objet CTI créé

#PUT /api/smart-routings/ctis/{cti}

Modifie une CTI. PATCH est également accepté. Le token ne peut pas être modifié ici : utilisez l'endpoint de régénération ci-dessous.

Corps de la requête

Réponse 201 — l'objet CTI modifié

#POST /api/smart-routings/ctis/{cti}/regenerate-token

Remplace le jeton de la CTI par un nouveau jeton aléatoire de 80 caractères. L'ancien jeton et son URL de recherche cessent de fonctionner immédiatement.

Réponse 200 — l'objet CTI modifié, avec le nouveau token et la nouvelle token_lookup_url

#DELETE /api/smart-routings/ctis/{cti}

Supprime une CTI et toutes ses destinations.

Réponse 200

{ "response": "element deleted" }

#Destinations

Une destination associe une origin à une destination au sein d'une CTI.

#GET /api/smart-routings/ctis/{cti}/destinations

Renvoie toutes les destinations de la CTI. Cette liste n'est pas paginée.

Réponse 200

[
  {
    "id": 101,
    "cti_id": 4,
    "origin": "+33612345678",
    "destination": "201",
    "created_at": "2024-03-04T10:15:00.000000Z",
    "updated_at": "2024-03-04T10:15:00.000000Z"
  }
]

#GET /api/smart-routings/ctis/{cti}/destinations/{destination}

Renvoie une destination.

Réponse 200 — objet destination

Réponse 404 — la destination n'appartient pas à cette CTI

#POST /api/smart-routings/ctis/{cti}/destinations

Ajoute une destination à la CTI.

Corps de la requête

Réponse 201 — l'objet destination créé

#PUT /api/smart-routings/ctis/{cti}/destinations/{destination}

Modifie une destination. PATCH est également accepté.

Corps de la requête

Réponse 201 — l'objet destination modifié

#DELETE /api/smart-routings/ctis/{cti}/destinations/{destination}

Supprime une destination.

Réponse 200

{ "response": "element deleted" }

#Opérations en masse

#GET /api/smart-routings/ctis/export

Télécharge les destinations CTI du client sous forme de fichier Excel (cti_destinations.xlsx).

Paramètres de requête

Le fichier contient les colonnes id, cti_id, origin et destination.

#POST /api/smart-routings/ctis/import

Importe des destinations CTI depuis un tableur. Envoyez la requête en multipart/form-data.

Corps de la requête

La ligne d'en-tête reprend les colonnes de l'export : id, cti_id, origin, destination.

• Une ligne avec un id existant met à jour cette destination ; une ligne sans id en crée une nouvelle.
• Les lignes dont la CTI appartient à un autre client, ou dont l'origin ou la destination est vide, sont ignorées.

Réponse 200

{ "response": "Import successful." }

#DELETE /api/smart-routings/ctis/bulk

Supprime des destinations CTI en masse. Les CTI elles-mêmes sont conservées.

Paramètres de requête

Sans cti_id, les destinations de toutes les CTI du client sont supprimées.

Réponse 200

{ "response": "elements deleted" }

#Recherche

#GET /api/smart-routings/ctis/lookup

Renvoie la destination correspondant à une origine dans une CTI. Accepte le scope OAuth client ou cfd. Nécessite la permission cti.lookup.

Paramètres de requête

*L'un des paramètres customer_account ou customer_id est obligatoire.
**L'un des paramètres cti_id, cti_name ou cti_token est obligatoire. Si plusieurs sont envoyés, cti_id est prioritaire, puis cti_token, puis cti_name.

Réponse 200 — objet destination

{
  "id": 101,
  "cti_id": 4,
  "origin": "+33612345678",
  "destination": "201",
  "created_at": "2024-03-04T10:15:00.000000Z",
  "updated_at": "2024-03-04T10:15:00.000000Z"
}

Réponse 404 — aucun client, aucune CTI ou aucune destination ne correspond aux paramètres

{ "message": "No destination found matching given parameters." }

#GET /api/smart-routings/ctis/t/{token}/{origin}

Recherche par jeton, conçue pour les PBX ou outils CTI qui ne savent appeler qu'une URL simple. Aucun en-tête Authorization n'est requis : le token de la CTI authentifie la requête et identifie le client, customer_account est donc inutile. Utilisez la token_lookup_url de la CTI en remplaçant %CallerNumber% par le numéro de l'appelant.

GET /api/smart-routings/ctis/t/q8Zb3kV0yR1m.../+33612345678

Réponse 200

{
  "id": 101,
  "origin": "+33612345678",
  "destination": "201"
}

Réponse 404 — jeton inconnu, ou aucune destination pour cette origine