Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Данный ресурс предназначен для получения истории по событиям очереди

Table of Contents

Возможные события по звонящим в очереди:

member-queue-start - звонящий начал вызов очереди

member-queue-end - звонящий закончил вызов в очереди (может совпадать с bridge-agent-end, если звонящему ответят в очереди)

Возможные события по агентам очереди:

agent-offering - агент вызывается

bridge-agent-fail - вызов агента был неуспешен

bridge-agent-start - агент соединился с звонящим

bridge-agent-end - агент закончил разговор с звонящим

Ресурс /extension/{extension_id}/queue/events/

Получить историю событий добавочного

Параметры URL

Имя

Тип

extension_id

string

Параметры запроса

Имя

Тип

Описание

start_datetime

string

дата начала

end_datetime

string

дата конца

order

string

desc или asc

event_name

integer

Необязательный параметр - фильтр по event_name (возможные варианты: member-queue-start, member-queue-end, agent-offering, bridge-agent-fail, bridge-agent-start, bridge-agent-end)

Ответ

Ответ содержит массив (см. ответ системы на пример ниже)

Имя

Тип

Описание

event_name

string

Имя события(возможные варианты: member-queue-start, member-queue-end, agent-offering, bridge-agent-fail, bridge-agent-start, bridge-agent-end)

queue_id

integer

id очереди

event_time_gmt

string

Время наступления события

call_uuid

string

id звонка, который можно использовать в ресурсе

agent_type

string

Тип агента. Может быть local, а может быть remote. Значение null в событиях member-queue-start и member-queue-end

agent_id

string

Id агента. Может быть local, а может быть remote. Значение null в событиях member-queue-start и member-queue-end

Пример

Получим историю событий очереди:

Tabs
data[{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"В разделе "},{"type":"text","text":"authentication ","marks":[{"type":"strong"}]},{"type":"text","text":"в поля "},{"type":"text","text":"client_id ","marks":[{"type":"strong"}]},{"type":"text","text":"и "},{"type":"text","text":"client_secret ","marks":[{"type":"strong"}]},{"type":"text","text":"требуется ввести полученные при регистрации приложения значения "},{"type":"text","text":"Application_ID ","marks":[{"type":"strong"}]},{"type":"text","text":"и "},{"type":"text","text":"Application_Secret","marks":[{"type":"strong"}]},{"type":"text","text":", затем нажать на кнопку "},{"type":"text","text":"\"Try it out!\"","marks":[{"type":"strong"}]},{"type":"text","text":". Если данные приложения верны, в ответ вернётся токен доступа ("},{"type":"text","text":"access_token","marks":[{"type":"strong"}]},{"type":"text","text":"). Полученный токен доступа следует ввести в поле \""},{"type":"text","text":"Access Token Field","marks":[{"type":"strong"}]},{"type":"text","text":"\" вверху страницы и сохранить его нажатием кнопки "},{"type":"text","text":"\"Set Token\"","marks":[{"type":"strong"}]},{"type":"text","text":"."}]},{"type":"table","attrs":{"isNumberColumnEnabled":false,"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"метод","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"ресурс","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"данные","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"GET"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"/extension/35267/queue/events/?start_datetime=2022-11-24%2011%3A00%3A00&end_datetime=2022-11-24%2012%3A00%3A00&order=desc"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"hardBreak"},{"type":"text","text":" "}]},{"type":"paragraph","content":[]}]}]}]},{"type":"paragraph","content":[]}]},"id":"9de55939-4dc1-4959-a4ac-54df3341773f","label":"Интерактивный обозреватель API ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Для отправки запросов с помощью программы cURL установим значения переменных "},{"type":"text","text":"url ","marks":[{"type":"strong"}]},{"type":"text","text":"и "},{"type":"text","text":"access_token","marks":[{"type":"strong"}]},{"type":"text","text":":"}]},{"type":"paragraph","content":[{"type":"text","text":"export url=\"https://<hostname>/api/ver1.0\"","marks":[{"type":"code"}]},{"type":"text","text":" "},{"type":"hardBreak"},{"type":"text","text":"(где hostname — hostname API-сервера провайдера IP-телефонии),"}]},{"type":"paragraph","content":[{"type":"text","text":"export access_token=\"8SNsrS0jV35vfmKqKeKtRrHfpbg4UX\"","marks":[{"type":"code"}]},{"type":"text","text":" "},{"type":"hardBreak"},{"type":"text","text":"(полученный токен доступа)."}]},{"type":"paragraph","content":[{"type":"text","text":"export ext_id=\"123\"","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"type":"text","text":"(id добавочного очереди)"}]},{"type":"paragraph","content":[{"type":"text","text":"Отправим запрос:"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"type":"text","text":"curl \\\r\n-H \"Authorization: Bearer ${access_token}\" \\\r\n-X GET \"${url}/extension/${ext_id}/queue/events/?start_datetime=2022-11-24%2011%3A00%3A00&end_datetime=2022-11-24%2012%3A00%3A00&order=desc\""}]}]},"id":"0206ac4d-1d38-40ff-b49f-4c1b42a217ac","label":"Программа cURL ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Для отправки запросов на языке Python установим значения переменных URL и ACCESS_TOKEN:"}]},{"type":"paragraph","content":[{"type":"text","text":"URL = \"https://<hostname>/api/ver1.0\"","marks":[{"type":"code"}]},{"type":"hardBreak"},{"type":"text","text":"(где hostname — hostname API-сервера провайдера IP-телефонии),"}]},{"type":"paragraph","content":[{"type":"text","text":"ACCESS_TOKEN = \"8SNsrS0jV35vfmKqKeKtRrHfpbg4UX\"","marks":[{"type":"code"}]},{"type":"hardBreak"},{"type":"text","text":"(полученный токен доступа)."}]},{"type":"codeBlock","attrs":{"language":"python"},"content":[{"type":"text","text":"#!/usr/bin/python\n\nimport requests\n\nurl = f'{URL}/extension/{ext_id}/queue/events/?start_datetime=2022-11-24%2011%3A00%3A00&end_datetime=2022-11-24%2012%3A00%3A00&order=desc'\nheaders = {\n 'Authorization': f'Bearer {ACCESS_TOKEN}'\n}\nresponse = requests.get(url, headers=headers)\nprint(response.text)"}]}]},"id":"6d775a6e-a971-4f40-8e3f-4972b79f65b4","label":"На языке Python3 ","type":"tab"}]
tabsConfiguration{"position":"top"}
[{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"В разделе "},{"type":"text","text":"authentication ","marks":[{"type":"strong"}]},{"type":"text","text":"в поля "},{"type":"text","text":"client_id ","marks":[{"type":"strong"}]},{"type":"text","text":"и "},{"type":"text","text":"client_secret  ","marks":[{"type":"strong"}]},{"type":"text","text":"требуется ввести полученные при регистрации приложения значения "},{"type":"text","text":"Application_ID ","marks":[{"type":"strong"}]},{"type":"text","text":"и "},{"type":"text","text":"Application_Secret","marks":[{"type":"strong"}]},{"type":"text","text":", затем нажать на кнопку "},{"type":"text","text":"\"Try it out!\"","marks":[{"type":"strong"}]},{"type":"text","text":". Если данные приложения верны, в ответ вернётся токен доступа ("},{"type":"text","text":"access_token","marks":[{"type":"strong"}]},{"type":"text","text":"). Полученный токен доступа следует ввести в поле \""},{"type":"text","text":"Access Token Field","marks":[{"type":"strong"}]},{"type":"text","text":"\" вверху страницы и сохранить его нажатием кнопки "},{"type":"text","text":"\"Set Token\"","marks":[{"type":"strong"}]},{"type":"text","text":"."}]},{"type":"table","attrs":{"isNumberColumnEnabled":false,"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"метод","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"ресурс","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"данные","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"GET"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"/extension/35267/queue/events/?start_datetime=2022-11-24%2011%3A00%3A00&end_datetime=2022-11-24%2012%3A00%3A00&order=desc"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"hardBreak"},{"type":"text","text":" "}]},{"type":"paragraph","content":[]}]}]}]},{"type":"paragraph","content":[]}]},"id":"9de55939-4dc1-4959-a4ac-54df3341773f","label":"Интерактивный обозреватель API    ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Для отправки запросов с помощью программы cURL установим значения переменных "},{"type":"text","text":"url ","marks":[{"type":"strong"}]},{"type":"text","text":"и "},{"type":"text","text":"access_token","marks":[{"type":"strong"}]},{"type":"text","text":":"}]},{"type":"paragraph","content":[{"type":"text","text":"export url=\"https://<hostname>/api/ver1.0\"","marks":[{"type":"code"}]},{"type":"text","text":" "},{"type":"hardBreak"},{"type":"text","text":"(где hostname — hostname API-сервера провайдера IP-телефонии),"}]},{"type":"paragraph","content":[{"type":"text","text":"export access_token=\"8SNsrS0jV35vfmKqKeKtRrHfpbg4UX\"","marks":[{"type":"code"}]},{"type":"text","text":" "},{"type":"hardBreak"},{"type":"text","text":"(полученный токен доступа)."}]},{"type":"paragraph","content":[{"type":"text","text":"export ext_id=\"123\"","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"type":"text","text":"(id добавочного очереди)"}]},{"type":"paragraph","content":[{"type":"text","text":"Отправим запрос:"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"type":"text","text":"curl \\\r\n-H \"Authorization: Bearer ${access_token}\" \\\r\n-X GET \"${url}/extension/${ext_id}/queue/events/?start_datetime=2022-11-24%2011%3A00%3A00&end_datetime=2022-11-24%2012%3A00%3A00&order=desc\""}]}]},"id":"0206ac4d-1d38-40ff-b49f-4c1b42a217ac","label":"Программа cURL    ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Для отправки запросов на языке Python установим значения переменных URL и ACCESS_TOKEN:"}]},{"type":"paragraph","content":[{"type":"text","text":"URL = \"https://<hostname>/api/ver1.0\"","marks":[{"type":"code"}]},{"type":"hardBreak"},{"type":"text","text":"(где hostname — hostname API-сервера провайдера IP-телефонии),"}]},{"type":"paragraph","content":[{"type":"text","text":"ACCESS_TOKEN = \"8SNsrS0jV35vfmKqKeKtRrHfpbg4UX\"","marks":[{"type":"code"}]},{"type":"hardBreak"},{"type":"text","text":"(полученный токен доступа)."}]},{"type":"codeBlock","attrs":{"language":"python"},"content":[{"type":"text","text":"#!/usr/bin/python\n\nimport requests\n\nurl = f'{URL}/extension/{ext_id}/queue/events/?start_datetime=2022-11-24%2011%3A00%3A00&end_datetime=2022-11-24%2012%3A00%3A00&order=desc'\nheaders = {\n    'Authorization': f'Bearer {ACCESS_TOKEN}'\n}\nresponse = requests.get(url, headers=headers)\nprint(response.text)"}]}]},"id":"6d775a6e-a971-4f40-8e3f-4972b79f65b4","label":"На языке Python3    ","type":"tab"}]

Ответ системы:

Code Block
breakoutModefull-width
languagejson
[
  {
    "event_name": "member-queue-end",
    "queue_id": 35267,
    "event_time_gmt": "2022-11-24 11:00:46",
    "call_uuid": "3E26E6FE6BE711EDA82981C398F02F83",
    "agent_type": null,
    "agent_id": null
  },
  {
    "event_name": "bridge-agent-fail",
    "queue_id": 35267,
    "event_time_gmt": "2022-11-24 11:00:45",
    "call_uuid": "3E26E6FE6BE711EDA82981C398F02F83",
    "agent_type": "remote",
    "agent_id": 610
  },
  {
    "event_name": "bridge-agent-fail",
    "queue_id": 35267,
    "event_time_gmt": "2022-11-24 11:00:45",
    "call_uuid": "3E26E6FE6BE711EDA82981C398F02F83",
    "agent_type": "local",
    "agent_extension_id": 32488,
    "agent_id": 13226
  },
  {
    "event_name": "agent-offering",
    "queue_id": 35267,
    "event_time_gmt": "2022-11-24 11:00:45",
    "call_uuid": "3E26E6FE6BE711EDA82981C398F02F83",
    "agent_type": "remote",
    "agent_id": 610
  },
  {
    "event_name": "agent-offering",
    "queue_id": 35267,
    "event_time_gmt": "2022-11-24 11:00:45",
    "call_uuid": "3E26E6FE6BE711EDA82981C398F02F83",
    "agent_type": "local",
    "agent_extension_id": 32488,
    "agent_id": 13226
  },
  {
    "event_name": "member-queue-start",
    "queue_id": 35267,
    "event_time_gmt": "2022-11-24 11:00:44",
    "call_uuid": "3E26E6FE6BE711EDA82981C398F02F83",
    "agent_type": null,
    "agent_id": null
  }
]