~.pbx.kazoo.name.~ Conexã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:

Ambiente	Descrição
Nome	Um nome exclusivo 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 monitorar as comunicações do cliente.
ID da conta	O ~.pbx.kazoo.name.~ ID da conta do locatário para o cliente.
Crossbar REST API	REST API conexão URL.
Blackhole WebSocket API	Conexão WebSocket URL
País	O local da conexão do sistema telefônico. Isso é usado para localizar os números de telefone da conexão.

info

Certifique-se de que o tipos de evento estão habilitados no Blackhole WebSocket.\

Versões suportadas #

~.pbx.kazoo.name.~ Lançamento	~.Dimensions.~ Suporte	Observações
5.3	Com suporte	Nenhum
5.2	Com suporte	Nenhum
5.1	Com suporte	Nenhum
5.0	Com suporte	Nenhum
4.3¹	Com suporte	ACDC suportado pelo Sprint 85
4.2¹	Com suporte	Nenhum
< 4.x	Não suportado	Nenhum

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 se aplicam a ~.pbx.kazoo.name.~ PBX Conexões:

Item	Requisito
Plano de numeração	~.Dimensions.~ requer um plano de numeração exclusivo para poder distinguir entre dispositivos e usuários. Dispositivo 'SIP Os nomes de usuário não podem ser iguais a qualquer número de ramal (incluindo ID de ramal/presença de usuários, fluxos de chamadas, etc.)
Usuários	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 sua conta Uma ID de presença (usada para mostrar o número do usuário em relatórios) Além disso, para poder fazer login no ~.Dimensions.~ portal, o nome de usuário do usuário em ~.pbx.kazoo.name.~ deve ser o endereço de e-mail deles.
Filtragem de resumo do agente	No momento, o status do agente não pode ser filtrado por Fila. Ao filtrar o relatório Resumo do agente por fila, todos os agentes serão mostrados com seu status para o intervalo de datas correspondente do relatório. Somente as informações de chamada podem ser filtradas em relação a um específico, se necessário. Isso se deve ao fato de que informações específicas da fila não são armazenadas historicamente em relação a eventos de status do agente.

API Chave #

Este API é 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.~ A ID da conta do locatário é necessária para o cliente específico no ~.pbx.kazoo.name.~ plataforma. Isso permite ~.Dimensions.~ para identificar exclusivamente os usuários desse cliente e chamar o ~.pbx.kazoo.name.~ plataforma. Isso pode ser encontrado no ~.pbx.kazoo.name.~ através da aplicação "Centro de Controlo". Edite o nome da conta e ele será mostrado.

Captura de tela

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

API Conexões #

Para se conectar ao ~.pbx.kazoo.name.~ plataforma, ~.Dimensions.~ requer acesso ao REST e APIs WebSocket. Insira os URLs para eles 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 para ajudar na modelagem do tráfego de chamadas.

'Se você estiver usandoui.zswitch.net, então o Crossbar (REST) éhttps://ui.zswitch.net

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 rastrear eventos de alteração de documentos para os objetos ~.Dimensions.~ modelos (usuários, dispositivos, fluxos de chamadas, etc.).

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

Se você estiver usandoapi.zswitch.net, então o Blackhole (WebSocket) éwss://api.zswitch.net:5443

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

note

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

ACDC Apoio

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

DNS SRV #

~.Dimensions.~ suporta DNS Registros SRV para o 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 conexão	DNS Prefixo SVR
Crossbar REST API	_crossbar._tcp
Blackhole Soquete Web	_blackhole._tcp
WebRTC	_webrtc._tcp

Exemplo Crossbar Configuração SRV O exemplo abaixo mostra dois registros SRV para um Crossbar conexão. mais podem ser configurados conforme necessário.

No ~.Dimensions.~ PBX Template, 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 Template, 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 de 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.

note

Se usar qualquer um dos ~.UcClient.~ softphones (Desktop, Mobile ou CRM), uma configuração adicional de Proxy de Saída precisa ser configurada em sua conta de revendedor. Entre em contato ~.Dimensions.~ suporte para ter essa 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 obter mais informações, consulte o Sistemas telefônicos secção.

note

O monitoramento de subcontas está disponível apenas em contas de clientes e não deve ser usado em contas de revendedores.

Limitação de taxa #

~.Dimensions.~ executa uma série de consultas e solicitações durante seu processo inicial de inicialização quando está aprendendo sobre o ~.pbx.kazoo.name.~ exemplo. Se os limites de taxa no ~.pbx.kazoo.name.~ instância foram definidas muito baixas, é possível que essa inicialização inicial falhe. Se isso acontecer, um membro de ~.Dimensions.~ O suporte entrará 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 rastreadas:

"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}.deaf-member",
		"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 Solicitações #

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

Uso geral

{CROSSBAR}/v2/api_auth,httpMethod=PUT
{BARRA TRANSVERSAL}/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 String 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.~ Controle ACD

Usado durante o controle do estado do agente de ~.UcClient.~ e Painel.

{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

Controle de perfil de presença

Usado quando os Perfis de presença estão ativados 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 código aberto ~.pbx.kazoo.name.~ usando ACDC e eventos de agente/fila de EDR.

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

Restrições da plataforma #

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

Restrição	Descrição
Rastreamento de fluxo de chamadas	Nenhuma informação de chamada pode ser coletada por meio do soquete da web API para chamadas enquanto elas estão em um fluxo de chamadas. O rastreamento de chamadas começará assim que uma chamada interagir com um usuário/dispositivo ou fila de call center. Enquanto estiver 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 atendidas. Isso ocorre porque informações insuficientes são fornecidas por meio do soquete da web 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. Isso ocorre devido a uma limitação no FreeSWITCH.
Chamada rápida	Se estiver executando um ~.pbx.kazoo.name.~ versão anterior à 5.0, as chamadas rápidas atendidas em um dispositivo externo (celular/home) geram entradas de registro de chamadas inválidas.