Endpoints de menu

Os menus representam uma fila a que um agente pode ser atribuído e opções que um usuário final pode selecionar ao entrar em contato com um agente. Cada objeto representa um único menu.

Há sete endpoints de menu:

  • /menu: extrai uma lista de menus.

  • /menu/tree: extrai menus em uma estrutura de árvore, que imita o caminho que um usuário final usaria para entrar em contato com um agente.

  • /menu/{:id}: extrai um único recurso de menu.

  • /menu/current_status: retorna o status atual da fila para menus com consumidores aguardando na fila.

  • /menu/sla: retorna um SLA para todos os caminhos de menu desde agora até o número de minutos especificado anteriormente.

  • /menu/sla_by_queue_group: retorna um SLA para todos os grupos de filas a partir de agora até o número de minutos especificado anteriormente.

  • /menus/operation_hours: retorna o horário de funcionamento do menu.

Consulte o modelo a seguir para determinar quais campos podem conter PII:

   {
    "id": 0,
    "name": "string",
    "parent_id": 0,
    "position": 0,
    "deleted": true,
    "hidden": "string",
    "menu_type": "ivr_menu",
    "output_msg": "string",
    "agent_assignments": [
      {
        "lang": "en",
        "queue_level": "primary",
        "channel_type": "chat",
        "assignee": {
          "id": 0,
          "name": "string", // This may be considered PII
          "last_name": "string", // This may be considered PII
          "first_name": "string", // This may be considered PII
          "agent_number": "string",
          "avatar_url": "string"
        }
      }
    ],
    "team_assignments": [
      {
        "lang": "en",
        "queue_level": "primary",
        "channel_type": "chat",
        "team": {
          "id": 0,
          "name": "string",
          "parent_id": 0,
          "position": 0,
          "deleted": true,
          "agents_count": 0,
          "assignees": {
            "id": 0,
            "name": "string", // This may be considered PII
            "last_name": "string", // This may be considered PII
            "first_name": "string", // This may be considered PII
            "agent_number": "string",
            "avatar_url": "string"
          }
        }
      }
    ]
  }
Parâmetro Obrigatório Tipo de dados Definição
sort_column FALSO String Classifica a resposta com base em qualquer campo no objeto de resposta.
sort_direction FALSO ASC ou DESC Indica a direção da classificação, crescente ou decrescente.
página FALSO String Faz par com "per" para indicar qual página de registros. Por exemplo, se "per" for 200 e "page" for 2, a resposta vai conter os registros de 201 a 400, já que a página 1 teria de 1 a 200.
por FALSO String Faz par com "page" para indicar quantos registros seriam incluídos em uma página de registros. Por exemplo, se "per" for 200 e "page" for 2, a resposta vai conter os registros de 201 a 400, já que a página 1 teria de 1 a 200.
id[] FALSO Array[String] Array[Strings]. ID dos registros a serem pesquisados e retornados
name[] FALSO Array[String] Retorna registros com base no nome do recurso.
parent_id[] FALSO Array[String] Retorna registros com base no ID principal dos registros especificados.
position[] FALSO Array[String] Retorna registros com base na posição de um menu.
menu_type[] FALSO Array[String] Retorna registros com base no tipo de menu. Valores possíveis: ivr_menu, mobile_menu, web_menu
hidden[] FALSO Booleano Retorna registros que foram ocultados (True) ou não, incluindo registros que foram ocultados (False).
with_deleted FALSO Booleano Retorna registros que foram excluídos (True) ou não, incluindo registros que foram excluídos (False).

Endpoint

Method: GET
Type: 
URL: https://{​{subdomain}​}.{​{domain}​}/manager/api/v1/menus

Mais exemplos de solicitações/respostas:

Exemplo de solicitação: lista de menus

Corpo: nenhum

Exemplo de resposta: lista de menus

[
    {
        "id": 1693,
        "name": "Death Star",
        "parent_id": null,
        "position": 0,
        "deleted": false,
        "menu_type": "ivr_menu",
        "output_msg": "You have reached the Death Star",
        "hidden": false,
        "agent_assignments": [
            {
                "lang": "en",
                "queue_level": "primary",
                "channel_type": "voice_call",
                "assignee": {
                    "id": 97,
                    "agent_number": 97,
                    "name": "Darth Vader",
                    "last_name": "Darth",
                    "first_name": "Vader"
                }
            },
            {
                "lang": "it",
                "queue_level": "primary",
                "channel_type": "voice_call",
                "assignee": {
                    "id": 1407,
                    "agent_number": 123,
                    "name": "Moff Tarkin",
                    "last_name": "Moff",
                    "first_name": "Tarkin"
                }
            }
        ],
        "team_assignments": [
            {
                "lang": "en",
                "queue_level": "primary",
                "channel_type": "voice_call",
                "team": {
                    "id": 10,
                    "name": "Storm Troopers",
                    "parent_id": null,
                    "position": 1,
                    "agents_count": 48,
                    "deleted": false,
                    "assignees": [
                        {
                            "id": 1,
                            "agent_number": null,
                            "name": "Storm Troooper 1",
                            "last_name": "Storm ",
                            "first_name": "Admin1",
                            "avatar_url": "https://subdomain.somedomain.com/data_uri_upload20171201-21853-1ijzccm.png"
                        },
{
                            "id": 2,
                            "agent_number": null,
                            "name": "Storm Troooper 2",
                            "last_name": "Storm ",
                            "first_name": "Admin1",
                            "avatar_url": "https://subdomain.somedomain.com/data_uri_upload20171201-21853-1ijzccm.png"
                        },
{
                            "id": 3,
                            "agent_number": null,
                            "name": "Storm Troooper 3",
                            "last_name": "Storm ",
                            "first_name": "Admin1",
                            "avatar_url": "https://subdomain.somedomain.com/data_uri_upload20171201-21853-1ijzccm.png"
                        }
                    ]
                }
            }
        ]
    }]

Código de status:200

Parâmetro Obrigatório Tipo de dados Definição
menu_type FALSO Array[String] Retorna registros com base no tipo de menu. Valores possíveis: ivr_menu, mobile_menu, web_menu
lang FALSO String Retorna registros que têm uma propriedade de idioma específica. Valores possíveis: en, es, fr, de

Endpoint

Method: GET
Type: 
URL: https://{​{subdomain}​}.{​{domain}​}/manager/api/v1/menus/tree

Mais exemplos de solicitações/respostas:

Exemplo de solicitação: árvore de menu

Corpo: nenhum

Exemplo de resposta: árvore de menu

[
    {
        "id": 2029,
        "name": "Mobile 1",
        "parent_id": null,
        "position": 0,
        "deleted": false,
        "menu_type": "mobile_menu",
        "output_msg": null,
        "hidden": false,
        "children": []
    },
    {
        "id": 2024,
        "name": "Death Star Venting System",
        "parent_id": null,
        "position": 1,
        "deleted": false,
        "menu_type": "mobile_menu",
        "output_msg": null,
        "hidden": false,
        "children": []
    },
    {
        "id": 2025,
        "name": "Droid Repair",
        "parent_id": null,
        "position": 2,
        "deleted": false,
        "menu_type": "mobile_menu",
        "output_msg": null,
        "hidden": false,
        "children": []
    },
    {
        "id": 2049,
        "name": "Emperor's Hotline",
        "parent_id": null,
        "position": 3,
        "deleted": false,
        "menu_type": "mobile_menu",
        "output_msg": null,
        "hidden": false,
        "children": []
    },
    {
        "id": 2026,
        "name": "Storm Trooper Armor",
        "parent_id": null,
        "position": 4,
        "deleted": false,
        "menu_type": "mobile_menu",
        "output_msg": null,
        "hidden": false,
        "children": [
            {
                "id": 2036,
                "name": "Armor Polishing Team",
                "parent_id": 2026,
                "position": 0,
                "deleted": false,
                "menu_type": "mobile_menu",
                "output_msg": null,
                "hidden": false,
                "children": []
            }
        ]
    }]

Código de status:200

Menu único

Parâmetro Obrigatório Tipo de dados Definição
record_id FALSO String Retorna um registro específico com base no ID.
with_deleted FALSO Booleano Retorna registros que foram excluídos (True) ou não, incluindo registros que foram excluídos (False).

Endpoint

Method: GET
Type: 
URL: https://{​{subdomain}​}.{​{domain}​}/manager/api/v1/menus/{​{menu_id}​}

Mais exemplos de solicitações/respostas:

Exemplo de solicitação: menu único

Corpo: nenhum

Exemplo de resposta: menu único

[
    {
        "id": 1693,
        "name": "Death Star",
        "parent_id": null,
        "position": 0,
        "deleted": false,
        "menu_type": "ivr_menu",
        "output_msg": "You have reached the Death Star",
        "hidden": false,
        "agent_assignments": [
            {
                "lang": "en",
                "queue_level": "primary",
                "channel_type": "voice_call",
                "assignee": {
                    "id": 97,
                    "agent_number": 97,
                    "name": "Darth Vader",
                    "last_name": "Darth",
                    "first_name": "Vader"
                }
            },
            {
                "lang": "it",
                "queue_level": "primary",
                "channel_type": "voice_call",
                "assignee": {
                    "id": 1407,
                    "agent_number": 123,
                    "name": "Moff Tarkin",
                    "last_name": "Moff",
                    "first_name": "Tarkin"
                }
            }
        ],
        "team_assignments": [
            {
                "lang": "en",
                "queue_level": "primary",
                "channel_type": "voice_call",
                "team": {
                    "id": 10,
                    "name": "Storm Troopers",
                    "parent_id": null,
                    "position": 1,
                    "agents_count": 48,
                    "deleted": false,
                    "assignees": [
                        {
                            "id": 1,
                            "agent_number": null,
                            "name": "Storm Troooper 1",
                            "last_name": "Storm ",
                            "first_name": "Admin1",
                            "avatar_url": "https://subdomain.somedomain.com/data_uri_upload20171201-21853-1ijzccm.png"
                        },
{
                            "id": 2,
                            "agent_number": null,
                            "name": "Storm Troooper 2",
                            "last_name": "Storm ",
                            "first_name": "Admin1",
                            "avatar_url": "https://subdomain.somedomain.com/data_uri_upload20171201-21853-1ijzccm.png"
                        },
{
                            "id": 3,
                            "agent_number": null,
                            "name": "Storm Troooper 3",
                            "last_name": "Storm ",
                            "first_name": "Admin1",
                            "avatar_url": "https://subdomain.somedomain.com/data_uri_upload20171201-21853-1ijzccm.png"
                        }
                    ]
                }
            }
        ]
    }]

Código de status:200

O status atual dos menus retorna todos os menus com chamadas ou chats na fila, além de dados adicionais sobre a duração desses itens.

Endpoint

Method: GET
Type: 
URL: https://{​{subdomain}​}.{​{domain}​}/manager/api/v1/menus/current_status

Mais exemplos de solicitações/respostas:

Exemplo de solicitação: status atual dos menus

Corpo: nenhum

Exemplo de resposta: status atual dos menus

[
    {
        "menu_id": 10,
        "lang": "en",
        "menu_path_id": 5,
        "menu_path": "zdco IVR Support/1 Day Shipping",
        "comm_type": "Call",
        "in_queue_count": 2,
        "oldest_in_queue": "2021-05-10T22:17:21.000Z",
        "oldest_duration_in_queue": 300,
        "total_queue_duration": 400,
        "average_queue_duration": 200
    }
]

Código de status:0

Parâmetro Obrigatório Tipo de dados Definição
canal TRUE String String. Valores aceitos: call, chat
minutos TRUE String String. O número de minutos a serem considerados desde agora ao calcular o SLA. Por exemplo, um valor de 15 solicitará o SLA dos últimos 15 minutos para cada caminho de menu.

Endpoint

Method: GET
Type: 
URL: https://{​{subdomain}​}.{​{domain}​}/manager/api/v1/menus/sla

Parâmetros de consulta:

Chave Valor Descrição
canal {channel} String. Valores aceitos: call, chat
minutos {minutes} String. O número de minutos a serem considerados desde agora ao calcular o SLA. Por exemplo, um valor de 15 solicitará o SLA dos últimos 15 minutos para cada caminho de menu.

Mais exemplos de solicitações/respostas:

Exemplo de solicitação: SLA do menu

Consulta:

Chave Valor Descrição
canal {channel} String. Valores aceitos: call, chat
minutos {minutes} String. O número de minutos a serem considerados desde agora ao calcular o SLA. Por exemplo, um valor de 15 solicitará o SLA dos últimos 15 minutos para cada caminho de menu.

Corpo: nenhum

Exemplo de resposta: SLA de cardápio

[
    {
        "menu_path_id": 100,
        "lang": "en",
        "menu_path": "Support/1 Day Shipping",
        "sla": 96.5
    },
    {
        "menu_path_id": 100,
        "lang": "es",
        "menu_path": "Support/1 Day Shipping Spanish",
        "sla": 99.0
    },
    {
        "menu_path_id": 101,
        "lang": "en",
        "menu_path": "Support/3 Day Shipping",
        "sla": 0.0
    }
]

Código de status:200

SLA dos grupos de filas

Parâmetro Obrigatório Tipo de dados Definição
canal TRUE String String. Valores aceitos: call, chat
minutos TRUE String String. O número de minutos a serem considerados desde agora ao calcular o SLA. Por exemplo, um valor de 15 solicitará o SLA dos últimos 15 minutos para cada caminho de menu.

Endpoint

Method: GET
Type: 
URL: https://{​{subdomain}​}.{​{domain}​}/manager/api/v1/menus/sla_by_queue_groups

Parâmetros de consulta:

Chave Valor Descrição
canal {channel} String. Valores aceitos: call, chat
minutos {minutes} String. O número de minutos a serem considerados desde agora ao calcular o SLA. Por exemplo, um valor de 15 solicitará o SLA dos últimos 15 minutos para cada caminho de menu.

Mais exemplos de solicitações/respostas:

Exemplo de solicitação: SLA de grupos de filas

Consulta:

Chave Valor Descrição
canal {channel} String. Valores aceitos: call, chat
minutos {lminutes} String. O número de minutos a serem considerados desde agora ao calcular o SLA. Por exemplo, um valor de 15 solicitará o SLA dos últimos 15 minutos para cada caminho de menu.

Corpo: nenhum

Exemplo de resposta: SLA de grupos de filas

[
    {
        "queue_group_id": 20,
        "queue_group_name": "Shipping",
        "sla": null
    },
    {
        "queue_group_id": 24,
        "queue_group_name": "Customer Support",
        "sla": 99.2
    },
    {
        "queue_group_id": 29,
        "queue_group_name": "Escalations",
        "sla": 98.3
    }
]

Código de status:200

Endpoint

Method: GET
Type: 
URL: https://{​{subdomain}​}.{​{domain}​}/manager/api/v1/menus/operation_hours

Parâmetros de consulta: nenhum

Mais exemplos de solicitações/respostas:

Exemplo de solicitação: horário de funcionamento do cardápio

Consulta: nenhuma

Corpo: nenhum

Exemplo de resposta: Horário de funcionamento do menu

[
    {
        "created_at": "2020-07-31T03:08:29.000Z",
        "fri_end_time": 86400,
        "fri_start_time": 0,
        "holidays": [],
        "id": 1,
        "mon_end_time": 86400,
        "mon_start_time": 0,
        "sat_end_time": 86400,
        "sat_start_time": 0,
        "sun_end_time": 86400,
        "sun_start_time": 0,
        "thu_end_time": 86400,
        "thu_start_time": 0,
        "time_zone": "Africa/Cairo",
        "tue_end_time": 86400,
        "tue_start_time": 0,
        "updated_at": "2021-03-24T13:23:43.000Z",
        "wed_end_time": 86400,
        "wed_start_time": 0
    },
    {
        "created_at": "2022-08-01T11:33:21.000Z",
        "fri_end_time": 28800,
        "fri_start_time": 21600,
        "holidays": [],
        "id": 2,
        "mon_end_time": 28800,
        "mon_start_time": 21600,
        "sat_end_time": 0,
        "sat_start_time": 0,
        "sun_end_time": 0,
        "sun_start_time": 0,
        "thu_end_time": 28800,
        "thu_start_time": 21600,
        "time_zone": "Europe/Helsinki",
        "tue_end_time": 28800,
        "tue_start_time": 21600,
        "updated_at": "2022-11-09T10:47:20.000Z",
        "wed_end_time": 28800,
        "wed_start_time": 21600
    }
]

Código de status:200