~.pbx.kazoo.name.~ Ligação

~.pbx.kazoo.name.~ Ligação #

O ~.pbx.kazoo.name.~ conexão fornece um serviço de coleta de dados para o ~.pbx.kazoo.name.~ Plataforma UCaaS/CPaaS.

A tabela abaixo descreve as configurações necessárias ao configurar um ~.pbx.kazoo.name.~ PBX conexão:

Cenário Descrição
Designação Um nome único para poder identificar facilmente o uso da conexão.
API Chave O API chave para permitir ~.Dimensions.~ para se conectar a ~.pbx.kazoo.name.~ e monitorizar as comunicações do cliente.
ID da conta O ~.pbx.kazoo.name.~ ID da conta do locatário do cliente.
Crossbar REST API REST API conexão URL.
Blackhole WebSocket API Conexão WebSocket URL
País A localização da conexão do sistema telefônico. Isso é usado para localizar os números de telefone para a conexão.

Information Circle info

Certifique-se de que o correto tipos de eventos estão ativados no Blackhole WebSocket.\

Versões suportadas #

~.pbx.kazoo.name.~ Lançamento ~.Dimensions.~ Suporte Notas
5.3 Suportado Nenhum
5.2 Suportado Nenhum
5.1 Suportado Nenhum
5,0 Suportado Nenhum
4.31 Suportado ACDC suportado a partir de Sprint 85
4.21 Suportado Nenhum
< 4.x Não suportado Nenhum

  1. Os coletores de dados são mais lentos para iniciar em sistemas 4.x devido à necessidade de solicitar assinaturas de eventos individualmente. ↩︎

Requisitos de configuração #

Os seguintes requisitos aplicam-se a ~.pbx.kazoo.name.~ PBX ligações:

Número Exigência
Plano de numeração ~.Dimensions.~ requer um plano de numeração único para poder distinguir entre dispositivos e utilizadores. Dispositivo 'SIP Os nomes de utilizador não podem ser iguais a qualquer número de ramal (incluindo o ID de extensão/presença dos utilizadores, fluxos de chamadas, etc.)
Utilizadores Tudo ~.pbx.kazoo.name.~ os usuários DEVEM ter o seguinte para serem monitorados corretamente:
  • Um endereço de e-mail válido e exclusivo configurado em relação à sua conta
  • Um ID de presença (usado para mostrar o número do usuário em relatórios)
Além disso, para poder fazer login no ~.Dimensions.~ portal, o nome de utilizador do utilizador em ~.pbx.kazoo.name.~ deve ser o seu endereço de e-mail.
Filtragem de resumo do agente Atualmente, o status do agente não pode ser filtrado por fila. Ao filtrar o relatório de Resumo do Agente por Fila, todos os agentes serão mostrados com seu status para o intervalo de datas correspondente do relatório. Apenas as informações da chamada podem ser filtradas em relação a um específico, se necessário. Isso se deve ao fato de que informações de fila específicas não são armazenadas historicamente em eventos de status do agente.

API Chave #

Isto API chave é gerada a partir do ~.pbx.kazoo.name.~ usando o aplicativo "Autenticação". Permite ~.Dimensions.~ para se conectar ao seu ~.pbx.kazoo.name.~ instalação.

Captura de tela

ID da conta #

O ~.pbx.kazoo.name.~ O ID da conta do locatário é necessário para o cliente específico no ~.pbx.kazoo.name.~ plataforma. Isto permite ~.Dimensions.~ para identificar exclusivamente os usuários deste cliente e chamadas no ~.pbx.kazoo.name.~ plataforma. Isto pode ser encontrado no ~.pbx.kazoo.name.~ usando o aplicativo "Control Center". Edite o Nome da Conta e ele é mostrado.

Captura de tela

Sempre que possível, um API chave ao mais alto nível deve ser usada para permitir ~.Dimensions.~ para monitorar vários clientes através de uma única conexão com ~.pbx.kazoo.name.~. Isso reduzirá a carga no ~.pbx.kazoo.name.~ instância.

API Conexões #

Para se conectar ao ~.pbx.kazoo.name.~ plataforma, ~.Dimensions.~ requer acesso ao REST e APIs WebSocket. Introduza os URLs para estes nas caixas fornecidas.

Crossbar REST API URL #

O Crossbar REST API é usado para consultar informações sobre os usuários, dispositivos e callfows configurados na conta de um cliente. Essas informações são usadas para criar contas de usuário e ajudar na modelagem do tráfego de chamadas.

«Se estiver a utilizarui.zswitch.net, em seguida, o Crossbar (REST) éhttps://ui.zswitch.net

Document note

Remova o "/v2" do final do URL se existir.

Blackhole WebSocket URL #

O Blackhole conexão é usada para monitorar o tráfego de chamadas e para rastrear eventos de alteração de documentos para os objetos ~.Dimensions.~ modelos (utilizadores, dispositivos, fluxos de chamadas, etc.).

Ao configurar os detalhes da conexão, inclua o número da porta para o Blackhole conexão.

Se estiver a utilizarapi.zswitch.net, em seguida, o Blackhole (WebSocket) éwss://api.zswitch.net:5443

Se utilizar um DNS Registro SRV, o número da porta não deve ser fornecido.

Document note

Remova o "/v2" do final do URL se existir.

ACDC Suporte

Se estiver usando uma versão de ~.pbx.kazoo.name.~ que suporta ACDC em vez de Qubicle, Fila e Os eventos do agente podem ser monitorados se o soquete EDR estiver habilitado. O mesmo URL configurado para Blackhole será usado para se conectar ao soquete EDR.

DNS SRV #

~.Dimensions.~ suportes DNS Registos SRV para ambos os Crossbar e Blackhole conexões. ao configurar seus registros SRV, os prefixos listados abaixo devem ser usados para cada um dos diferentes tipos de conexão:

Tipo de Ligação DNS Prefixo SVR
Crossbar REST API _crossbar._tcp
Blackhole WebSocket _blackhole._tcp
WebRTC _webrtc._tcp

Exemplo Crossbar Configuração SRV O exemplo abaixo mostra dois registros SRV para a Crossbar conexão. mais pode ser configurado conforme necessário.

No ~.Dimensions.~ PBX Modelo, o Crossbar seria configurado parahttps://zone1.example.com .

\_crossbar.\_tcp.zone01.example.com.	1 EM SRV 10 100 8443 apps001-ca.example.com.
\_crossbar.\_tcp.zone01.example.com.	1 EM SRV 100 10 8443 apps001-fl.example.com.

Exemplo Blackhole Configuração SRV

No ~.Dimensions.~ PBX Modelo, o Blackhole seria configurado parawss://zone1.example.com .

\_blackhole.\_tcp.zone01.example.com.	1 EM SRV 10 100 2096 apps001-ca.example.com.
\_blackhole.\_tcp.zone01.example.com.	1 EM SRV 100 10 2096 apps001-fl.example.com.

Exemplo de configuração SRV WebRTC

\_webrtc.\_tcp.zone01.example.com.	1 EM SRV 10 100 5065 apps001-ca.example.com.
\_webrtc.\_tcp.zone01.example.com.	1 EM SRV 100 10 5065 apps001-fl.example.com.

Document note

Se utilizar qualquer uma das seringas ~.UcClient.~ softphones (Desktop, Mobile ou CRM), uma configuração adicional de Proxy de Saída precisa ser configurada na sua conta de revendedor. Entre em contato ~.Dimensions.~ suporte para ter esta configuração.

~.pbx.kazoo.name.~ Requisitos/restrições da plataforma #

Subcontas #

~.Dimensions.~ pode ser configurado para provisionar e monitorar automaticamente as subcontas de um cliente, até 1 nível abaixo. Para usar esse recurso, a conexão de um cliente deve ser configurada manualmente sem um PBX modelo.

Para mais informações, consulte o Sistemas telefónicos secção.

Document note

A monitorização de subcontas só está disponível em contas de Clientes e não deve ser utilizada em contas de Revendedores.

Limitação de Taxa #

~.Dimensions.~ realiza uma série de consultas e solicitações durante seu processo inicial de inicialização quando está aprendendo sobre o ~.pbx.kazoo.name.~ instância. Se a taxa limita o ~.pbx.kazoo.name.~ instância foram definidas muito baixas, é possível que esta inicialização inicial falhe. Se isso acontecer, um membro do ~.Dimensions.~ O suporte estará em contato com mais informações.

Eventos WebSocket #

~.Dimensions.~ requer que os seguintes eventos sejam habilitados no WebSocket para permitir que todas as chamadas sejam modeladas e as modificações de programação sejam controladas:

"dados": {
	"chamada": [	
		"Ligue. CHANNEL_CREATE. {CALL_ID}",
        "Ligue. CHANNEL_ANSWER. {CALL_ID}",
        "Ligue. CHANNEL_DESTROY. {CALL_ID}",
		"Ligue. CHANNEL_HOLD. {CALL_ID}",
		"Ligue. CHANNEL_UNHOLD. {CALL_ID}",
		"Ligue. CHANNEL_BRIDGE. {CALL_ID}",
		"Ligue. PARK_PARKED. {CALL_ID}",
		"Ligue. PARK_RETRIEVED. {CALL_ID}",
		"Ligue. PARK_ABANDONED. {CALL_ID}"
		][	
		"call.CHANNEL_CREATE.{CALL_ID}",
        "call.CHANNEL_ANSWER.{CALL_ID}",
        "call.CHANNEL_DESTROY.{CALL_ID}",
		"call.CHANNEL_HOLD.{CALL_ID}",
		"call.CHANNEL_UNHOLD.{CALL_ID}",
		"call.CHANNEL_BRIDGE.{CALL_ID}",
		"call.PARK_PARKED.{CALL_ID}",
		"call.PARK_RETRIEVED.{CALL_ID}",
		"call.PARK_ABANDONED.{CALL_ID}"
		],
	"conferência": [ 
		"conferência.comando. {CONFERENCE_ID}",
		"conferência.evento. {CONFERENCE_ID}. {CALL_ID}.undeaf-member",
		"conferência.evento. {CONFERENCE_ID}. {CALL_ID}.membro surdo",
		"conferência.evento. {CONFERENCE_ID}. {CALL_ID}.unmute-member",
		"conferência.evento. {CONFERENCE_ID}. {CALL_ID}.mute-member",
		"conferência.evento. {CONFERENCE_ID}. {CALL_ID}.start-talking",
		"conferência.evento. {CONFERENCE_ID}. {CALL_ID}.stop-talking",
		"conferência.evento. {CONFERENCE_ID}. {CALL_ID}.del-member",
		"conferência.evento. {CONFERENCE_ID}. {CALL_ID}.add-member",
		"conferência.evento. {CONFERENCE_ID}. {CALL_ID}.unlock",
		"conferência.evento. {CONFERENCE_ID}. {CALL_ID}.lock",
		"conferência.evento. {CONFERENCE_ID}. {CALL_ID}.conference-destroy",
		"conferência.evento. {CONFERENCE_ID}. {CALL_ID}.conference-create",
		"conferência.evento. {CONFERENCE_ID}. {CALL_ID}.\*"
		][ 
		"conference.command.{CONFERENCE_ID}",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.undeaf-member",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.deaf-member",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.unmute-member",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.mute-member",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.start-talking",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.stop-talking",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.del-member",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.add-member",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.unlock",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.lock",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.conference-destroy",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.conference-create",
		"conference.event.{CONFERENCE_ID}.{CALL_ID}.*"
		],
	"fax": [	
		"fax.status. {FAX_ID}",
		"fax.object. {AÇÃO}"
		][	
		"fax.status.{FAX_ID}",
		"fax.object.{ACTION}"
		],
	"objeto": [
	"object.doc_created.account",
	"object.doc_created.callflow",
	"object.doc_created.device",
	"object.doc_created.faxbox",
	"object.doc_created.media",
	"object.doc_created.user",
	"object.doc_created.vmbox",
	"object.doc_created.fax",
	"object.doc_created.mailbox_message",
	"object.doc_created.call_recording",
	"object.doc_edited.account",
	"object.doc_edited.callflow",
	"object.doc_edited.device",
	"object.doc_edited.faxbox",
	"object.doc_edited.media",
	"object.doc_edited.user",
	"object.doc_edited.vmbox",
	"object.doc_edited.fax",
	"object.doc_edited.mailbox_message",
	"object.doc_edited.call_recording",
	"object.doc_deleted.account",
	"object.doc_deleted.callflow",
	"object.doc_deleted.device",
	"object.doc_deleted.faxbox",
	"object.doc_deleted.media",
	"object.doc_deleted.user",
	"object.doc_deleted.vmbox",
	"object.doc_deleted.fax",
	"object.doc_deleted.mailbox_message",
	"object.doc_deleted.call_recording"
	][
	"object.doc_created.account",
	"object.doc_created.callflow",
	"object.doc_created.device",
	"object.doc_created.faxbox",
	"object.doc_created.media",
	"object.doc_created.user",
	"object.doc_created.vmbox",
	"object.doc_created.fax",
	"object.doc_created.mailbox_message",
	"object.doc_created.call_recording",
	"object.doc_edited.account",
	"object.doc_edited.callflow",
	"object.doc_edited.device",
	"object.doc_edited.faxbox",
	"object.doc_edited.media",
	"object.doc_edited.user",
	"object.doc_edited.vmbox",
	"object.doc_edited.fax",
	"object.doc_edited.mailbox_message",
	"object.doc_edited.call_recording",
	"object.doc_deleted.account",
	"object.doc_deleted.callflow",
	"object.doc_deleted.device",
	"object.doc_deleted.faxbox",
	"object.doc_deleted.media",
	"object.doc_deleted.user",
	"object.doc_deleted.vmbox",
	"object.doc_deleted.fax",
	"object.doc_deleted.mailbox_message",
	"object.doc_deleted.call_recording"
	]
}

Crossbar API Pedidos #

O seguinte Crossbar API as solicitações são usadas por Dimensões:

Uso geral

{BARRA TRANSVERSAL}/v2/api_auth,httpMethod=PUT
{CROSSBAR}/v2/websockets,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID},httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/api_key,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/descendants?paginate=false,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/users?paginate=false,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/users/{USERID},httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/users/{USERID}/quickcall/{DESTINATION},httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/users/{USERID}/presence,httpMethod=POST
{CROSSBAR}/v2/accounts/{ACCOUNTID}/devices?paginate=false,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/devices/{DEVICEID},httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/devices/{DEVICEID}/quickcall/{DESTINATION},httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/callflows?paginate=false,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/callflows? {Filtros de Cadeia de Caracteres de Consulta},httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/callflows/{CALLFLOWID},httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/groups?paginate=false,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/groups/{GROUPID}?paginate=false,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/conferences?paginate=false,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/conferences/{CONFERENCEID},httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/vmboxes?paginate=false,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/metaflows,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/storage,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/channels,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/channels/{CHANNELID},httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/channels/{CHANNELID},httpMethod=PUT
{CROSSBAR}/v2/accounts/{ACCOUNTID}/resources,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/qubicle_queues?paginate=false,httpMethod=GET
{CROSSBAR}/v2/accounts/{ACCOUNTID}/qubicle_queues/{QUEUEID},httpMethod=GET

~.UcClient.~ Controlo ACD

Usado ao controlar o estado do agente de ~.UcClient.~ e Dashboard.

{CROSSBAR}/v2/accounts/{ACCOUNTID}/qubicle_recipients/status,httpMethod=POST,content={"data":{"recipient_ids":[" {RECIPIENTID1}","{RECIPIENTID2}"]["{RECIPIENTID1}","{RECIPIENTID2}"]}}
{CROSSBAR}/v2/accounts/{ACCOUNTID}/qubicle_recipients/{USERID},httpMethod=POST
{CROSSBAR}/v2/accounts/{ACCOUNTID}/qubicle_recipients/{USERID}/status,httpMethod=POST

Controlo de Perfil de Presença

Usado quando os Perfis de Presença estão habilitados no ~.UcClient.~.

{CROSSBAR}/v2/accounts/{accountId}/users/{userId},httpMethod=PATCH
{CROSSBAR}/v2/accounts/{accountId}/callflows/{callFlowId},httpMethod=POST
{CROSSBAR}/v2/accounts/{accountId}/callflows/groups/{groupId},httpMethod=POST
{CROSSBAR}/v2/accounts/{accountId}/callflows/groups/{groupId},httpMethod=POST

ACDC Suporte em código aberto

Usado se estiver executando Open source ~.pbx.kazoo.name.~ usando ACDC e eventos de agente/fila EDR.

{barra cruzada}/v2/accounts/{accountId}/queues,httpMethod=GET
{barra cruzada}/v2/accounts/{accountId}/queues/{queueId},httpMethod=GET
{barra cruzada}/v2/accounts/{accountId}/queues/{queueId}/stats_summary,httpMethod=GET
{barra cruzada}/v2/accounts/{accountId}/agents/{recipientId}/status,httpMethod=GET
{barra cruzada}/v2/accounts/{accountId}/agents/{userId}/status,httpMethod=POST

Restrições da plataforma #

As restrições listadas abaixo aplicam-se à versão mais recente do ~.pbx.kazoo.name.~ suportado.

Restrição Descrição
Rastreamento do fluxo de chamadas Nenhuma informação de chamada pode ser coletada através do soquete web API para chamadas enquanto estão em um fluxo de chamadas. O rastreamento de chamadas começará assim que uma chamada interage com um usuário/dispositivo ou fila de call center. Enquanto estiverem em um fluxo de chamadas, as chamadas serão tratadas como estando no estado 'Enfileiramento'.
Rastreamento de correio de voz As chamadas que são desviadas para o correio de voz de um telefone não podem ser rastreadas como tendo ido para o correio de voz e, em vez disso, serão modeladas como não sendo atendidas. Isto é devido a informações insuficientes que estão sendo fornecidas através do web socket API para que o cenário correto seja modelado.
Rastreamento de transferência anunciado Devido à forma como os eventos de chamada são gerados, recomendamos que todos os telefones sejam configurados para transferência cega. Se os telefones não estiverem configurados para transferência cega e uma transferência assistida for desligada antes de ser conectada, a chamada pode não ser modelada corretamente. Isto é devido a uma limitação no FreeSWITCH.
Chamada rápida Se estiver executando um ~.pbx.kazoo.name.~ anterior à 5.0, Quickcalls atendidas em um dispositivo externo (célula/casa) geram entradas de registro de chamadas inválidas.