Gli endpoint dell'agente forniscono un mezzo per ottenere gli oggetti agente. Ogni oggetto agente rappresenta un singolo agente all'interno di Contact Center AI Platform (CCAI Platform). Esamina il seguente modello per vedere quali campi potrebbero contenere informazioni che consentono l'identificazione personale (PII).
[
{
"id": 0,
"email": "string",
"created_at": "2018-05-30T20:46:31.333Z",
"last_login_time": "2018-05-30T20:46:31.333Z",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"avatar_url": "string",
"agent_number": "string",
"status": {
"id": 0,
"wfm_id": 0,
"name": "string",
"color": "string"
},
"status_updated_at": "2018-05-30T20:46:31.333Z",
"crm_authenticated": true,
"online": true,
"wrap_up": true,
"call_count": 0,
"chat_count": 0,
"location": "string",
"roles": [
"agent"
],
"teams": [
{
"id": 0,
"name": "string",
"parent_id": 0,
"position": 0,
"deleted": true,
"agents_count": 0
}
],
"channels": [
{
"channel_type": "chat",
"menu": {
"id": 0,
"name": "string",
"parent_id": 0,
"position": 0,
"deleted": true,
"hidden": "string",
"menu_type": "ivr_menu",
"output_msg": "string"
}
}
]
}
]
Agenti
| Parametro | Obbligatorio | Tipo di dati | Definizione |
|---|---|---|---|
| pagina | FALSE | Stringa | Coppie con per per indicare la pagina dei record. Ad esempio, se per è impostato su 200 e page è 2, la risposta conterrà i record da 201 a 400, poiché la pagina 1 conterrà i record da 1 a 200. |
| per | FALSE | Stringa | Coppie con la pagina per annotare quanti record verranno inclusi in una pagina di record. Ad esempio, se per è impostato su 200 e page è 2, la risposta conterrà i record da 201 a 400, poiché la pagina 1 conterrà i record da 1 a 200. |
| id[] | FALSE | Array[Stringa] | Array[Strings]. ID dei record da cercare e restituire |
| agent_number[] | FALSE | Array[Stringa] | Numeri degli agenti assegnati dall'amministratore al momento della creazione di un agente |
| status_id[] | FALSE | Array[Stringa] | Filtra per stato dell'agente |
| online[] | FALSE | Booleano | Filtra in base alla presenza o meno degli agenti online |
| wrap_up[] | FALSE | Booleano | Filtra in base allo stato di chiusura degli agenti |
| location[] | FALSE | Array[Stringa] | Filtra per posizione dell'agente |
| last_login_time[from] | FALSE | Ora in UTC | crea un limite inferiore del campo dell'ora dell'ultimo accesso. Tutti i record restituiti saranno successivi al valore inserito. |
| last_login_time[to] | FALSE | Ora in UTC | crea un limite superiore del campo dell'ora dell'ultimo accesso. Tutti i record restituiti saranno precedenti al valore inserito. |
| status_updated_at[from] | FALSE | Ora in UTC | crea un limite inferiore del campo Stato aggiornato il giorno. Tutti i record restituiti saranno successivi al valore inserito. |
| status_updated_at[to] | FALSE | Ora in UTC | crea un limite superiore del campo Stato aggiornato il. Tutti i record restituiti saranno precedenti al valore inserito. |
Endpoint:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/agents
Altri esempi di richieste/risposte:
Esempio di richiesta: esempio di agenti
Body: None
Esempio di risposta: esempio di agenti
[
{
"id": 45,
"email": "craigT@nelson.com",
"roles": [
"agent"
],
"first_name": "Craig T",
"middle_name": null,
"last_name": "Nelson",
"avatar_url": "https://subdomain.somedomain.com/default-profile.png",
"agent_number": null,
"crm_authenticated": false,
"status": {
"id": -6,
"name": "Wrap-up",
"color": "purple",
"wfm_id": 33
},
"online": false,
"wrap_up": false,
"call_count": 0,
"chat_count": 0,
"location": null,
"created_at": "2016-11-10T00:15:04.000Z",
"last_login_time": "2016-11-10T00:17:57.000Z",
"status_updated_at": null,
"teams": [
{
"id": 163,
"name": "team CTN",
"parent_id": null,
"position": 11,
"agents_count": 12,
"deleted": false
}
],
"channels": [
{
"channel_type": "voice_call",
"menu": {
"id": 2029,
"name": "Mobile Queue",
"parent_id": null,
"position": 0,
"deleted": false,
"menu_type": "mobile_menu",
"output_msg": null,
"hidden": false
}
}
]
},
{
"id": 60,
"email": "notanakinskywalker@empire.com",
"roles": [
"agent"
],
"first_name": "Darth",
"middle_name": null,
"last_name": "Vader",
"avatar_url": "https://subdomain.somedomain.com/default-profile.png",
"agent_number": null,
"crm_authenticated": false,
"status": {
"id": -7,
"name": "In-call",
"color": "light_blue",
"wfm_id": 34
},
"online": false,
"wrap_up": false,
"call_count": 0,
"chat_count": 0,
"location": null,
"created_at": "2017-02-03T19:44:14.000Z",
"last_login_time": "2017-02-03T20:05:31.000Z",
"status_updated_at": "2017-02-04T12:36:11.000Z",
"teams": [],
"channels": [
{
"channel_type": "voice_call",
"menu": {
"id": 1693,
"name": "Premium Support",
"parent_id": null,
"position": 0,
"deleted": false,
"menu_type": "ivr_menu",
"output_msg": "You selected premium support",
"hidden": false
}
}
]
},
{
"id": 81,
"email": "email@email.com",
"roles": [
"agent"
],
"first_name": "Barry",
"middle_name": null,
"last_name": "Allen",
"avatar_url": "https://subdomain.somedomain.com/default-profile.png",
"agent_number": null,
"crm_authenticated": false,
"status": {
"id": -10,
"name": "Offline",
"color": "grey",
"wfm_id": 36
},
"online": false,
"wrap_up": false,
"call_count": 0,
"chat_count": 0,
"location": null,
"created_at": "2017-03-13T23:47:39.000Z",
"last_login_time": "2017-03-13T23:48:17.000Z",
"status_updated_at": "2017-03-13T23:56:04.000Z",
"teams": [],
"channels": [
{
"channel_type": "voice_call",
"menu": {
"id": 2028,
"name": "Speed Issues",
"parent_id": 2027,
"position": 0,
"deleted": false,
"menu_type": "mobile_menu",
"output_msg": null,
"hidden": false
}
}
]
}
]
Codice di stato: 200
Stato attuale degli agenti
Stato attuale degli agenti restituisce tutti gli agenti che hanno eseguito l'accesso e il loro stato attuale, il tempo trascorso in questo stato e informazioni aggiuntive per indicare se l'agente è in attesa e per quanto tempo.
Endpoint:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/agents/current_status
Altri esempi di richieste/risposte:
Richiesta di esempio: stato attuale degli agenti
Body: None
Esempio di risposta: stato attuale degli agenti
[
{
"id": 1,
"status": "Available",
"status_id": 0,
"status_updated_at": "2021-05-10T17:45:01.000Z",
"on_hold": false,
"on_hold_duration": 0
}
]
Codice di stato: 0
Aspettati chiavi JSON non riconosciute nelle risposte API
Tutti gli aggiornamenti delle API sono compatibili con le versioni precedenti. Ci riserviamo il diritto di introdurre nuove chiavi JSON nelle risposte API esistenti in qualsiasi momento. Ti consigliamo di gestire le risposte in modo difensivo ignorando le chiavi non riconosciute per mantenere la funzionalità continua.