Contact Center AI Platform (CCAI) oferece o endpoint de tempo de espera para receber os tempos de espera atuais das filas de diferentes tipos de canais.
Tempo de espera
| Parâmetro | Obrigatório | Tipo de dados | Definição |
|---|---|---|---|
| lang | TRUE | String | Código do idioma da fila. Por exemplo, "en". |
| menu_id | FALSE | Número inteiro | A resposta vai filtrar todos os menus na subárvore desse menu, incluindo o próprio menu. |
| menu_type | FALSE | String | Retorna menus de tipos específicos. Valores possíveis: ivr_menu, mobile_menu, web_menu. |
| channel_type | FALSE | String | Retorna menus de um canal específico. Valores possíveis: voice_call, chat. |
| wait[from] | FALSE | Número inteiro | Retorna registros se eles tiverem um tempo de espera maior que o valor. |
| wait[to] | FALSE | Número inteiro | Retorna registros se eles tiverem um tempo de espera menor que o valor. |
Endpoint:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/apps/api/v1/wait_times
Cabeçalhos:
| Chave | Valor | Descrição |
|---|---|---|
| Content-Type | aplicativo/json |
Exemplo de solicitação e respostas
As seções a seguir fornecem exemplos de solicitações ao endpoint.
Tempos de espera para filas de dispositivos móveis
Este exemplo demonstra como recuperar os tempos de espera das filas de dispositivos móveis.
Solicitação
Cabeçalhos:
| Chave | Valor | Descrição |
|---|---|---|
| Content-Type | aplicativo/json |
Query:
| Chave | Valor | Descrição |
|---|---|---|
| lang | en | |
| menu_type | mobile_menu |
Corpo: Nenhum
Resposta: tempos de espera para filas de dispositivos móveis
[
{
"menu_id": 29,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Laptop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 42,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Desktop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 43,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Smart Phone",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
}
]
Código de status: 200
Tempos de espera entre wait[from] e wait[to]
Este exemplo demonstra como recuperar as chamadas que têm tempos de espera entre os valores de wait from e wait to.
Solicitação
Cabeçalhos:
| Chave | Valor | Descrição |
|---|---|---|
| Content-Type | aplicativo/json |
Query:
| Chave | Valor | Descrição |
|---|---|---|
| lang | en | |
| wait[from] | 5 | |
| wait[to] | 15 |
Corpo: Nenhum
Resposta: tempos de espera entre wait[from] e wait[to]
[
{
"menu_id": 3,
"menu_type": "web_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Web App",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 29,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Laptop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 42,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Desktop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 44,
"menu_type": "web_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Mobile App",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 43,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Smart Phone",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
}
]
Código de status: 200
Tempos de espera da ligação para filas de dispositivos móveis maiores que 5 segundos
Este exemplo demonstra como recuperar as chamadas de voz para dispositivos móveis que têm um tempo de espera maior que 5 segundos.
Solicitação
Cabeçalhos:
| Chave | Valor | Descrição |
|---|---|---|
| Content-Type | aplicativo/json |
Query:
| Chave | Valor | Descrição |
|---|---|---|
| lang | en | |
| menu_type | mobile_menu | |
| channel_type | voice_call | |
| wait[from] | 5 |
Corpo: Nenhum
Resposta: tempos de espera da ligação para filas de dispositivos móveis maiores que 5 segundos
[
{
"menu_id": 29,
"menu_type": "mobile_menu",
"voice_call": 10,
"materialized_path": "Laptop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 42,
"menu_type": "mobile_menu",
"voice_call": 10,
"materialized_path": "Desktop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 43,
"menu_type": "mobile_menu",
"voice_call": 10,
"materialized_path": "Smart Phone",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
}
]
Código de status: 200
Tempos de espera para um menu específico
Este exemplo demonstra como recuperar os tempos de espera de um ID de menu específico.
Solicitação
Cabeçalhos:
| Chave | Valor | Descrição |
|---|---|---|
| Content-Type | aplicativo/json |
Query:
| Chave | Valor | Descrição |
|---|---|---|
| lang | en | |
| menu_id | 9 |
Corpo: Nenhum
Resposta: tempos de espera para um menu específico
[
{
"menu_id": 9,
"menu_type": "ivr_menu",
"voice_call": 10,
"materialized_path": "Death Star",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
}
]
Código de status: 200
Tempos de espera para todas as chamadas de voz
Este exemplo demonstra como recuperar os tempos de espera de todas as chamadas de voz atuais.
Solicitação
Cabeçalhos:
| Chave | Valor | Descrição |
|---|---|---|
| Content-Type | aplicativo/json |
Query:
| Chave | Valor | Descrição |
|---|---|---|
| lang | en | |
| channel_type | voice_call |
Corpo: Nenhum
Resposta: tempos de espera para todas as chamadas de voz
[
{
"menu_id": 3,
"menu_type": "web_menu",
"voice_call": 10,
"materialized_path": "Web App",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 9,
"menu_type": "ivr_menu",
"voice_call": 10,
"materialized_path": "Death Star",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 29,
"menu_type": "mobile_menu",
"voice_call": 10,
"materialized_path": "Laptop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 41,
"menu_type": "ivr_menu",
"voice_call": 10,
"materialized_path": "Lock Star",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 42,
"menu_type": "mobile_menu",
"voice_call": 10,
"materialized_path": "Desktop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 44,
"menu_type": "web_menu",
"voice_call": 10,
"materialized_path": "Mobile App",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 43,
"menu_type": "mobile_menu",
"voice_call": 10,
"materialized_path": "Smart Phone",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
}
]
Código de status: 200
Tempos de espera para filas em inglês
Este exemplo demonstra como recuperar todos os tempos de espera das filas que têm o idioma inglês.
Solicitação
Cabeçalhos:
| Chave | Valor | Descrição |
|---|---|---|
| Content-Type | aplicativo/json |
Query:
| Chave | Valor | Descrição |
|---|---|---|
| lang | en |
Corpo: Nenhum
Resposta: tempos de espera para filas em inglês
[
{
"menu_id": 3,
"menu_type": "web_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Web App",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 9,
"menu_type": "ivr_menu",
"voice_call": 10,
"materialized_path": "Death Star",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 29,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Laptop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 41,
"menu_type": "ivr_menu",
"voice_call": 10,
"materialized_path": "Lock Star",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 42,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Desktop",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 44,
"menu_type": "web_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Mobile App",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
},
{
"menu_id": 43,
"menu_type": "mobile_menu",
"chat": 10,
"voice_call": 10,
"materialized_path": "Smart Phone",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
}
]
Código de status: 200