Telefonia Xtended Serv Interf (versão prévia)
Integre-se ao sistema de telefonia do BluIP para levar sua chamada para o próximo nível. XSI (Interface de Serviço Xtended) de telefonia.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte a BluIP |
| URL | https://support.bluip.com |
| developers@bluip.com |
| Metadados do conector | |
|---|---|
| Publicador | BluIP, Inc. |
| Site | https://www.bluip.com/ |
| Política de privacidade | https://www.bluip.com/company/legal/privacy-policy |
| Categorias | Produtividade; Comunicação |
Telefonia Xtended Serv Interf
Integre-se ao sistema de telefonia do BluIP para levar sua chamada para o próximo nível. XSI (Interface de Serviço Xtended) de telefonia.
Pré-requisitos
Uma conta de usuário, grupo, empresa ou administrador do sistema da BluIP.
Documentação da API
Como obter credenciais
Entre em contato com a equipe de suporte da BluIP para obter uma conta de demonstração ou detalhes sobre sua conta atual.
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Nome de usuário | secureString | Nome de usuário do MasterAccess (Usuário, Grupo, Empresa ou Administrador do Sistema) | Verdade |
| Senha | secureString | Senha do MasterAccess | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Alternar gravação de chamada |
Alterne o estado de gravação de chamadas. |
| Alternar o estado acd do agente |
Alterne o estado ACD do agente. |
| Fim da Chamada |
Desligar/Encerrar uma chamada. |
| Nova chamada |
Fazer uma chamada |
| Obter chamadas de usuário |
Obtenha chamadas de usuário. |
| Obter perfil de usuário |
Obtenha o perfil do usuário. |
| Resposta de chamada |
Atenda a uma chamada. |
| Retenção de chamada |
Coloque uma chamada em espera. |
| Solicitação Bruta |
Enviar uma solicitação bruta. Encontre mais recursos em: https://labxsp1.masteraccess.com/com.broadsoft.xsi-actions/test/v2.0/ |
| Transferir Chamada para Caixa Postal |
Transferir chamada para a caixa postal. |
| Transferir uma chamada |
Transferir uma chamada. |
Alternar gravação de chamada
Alterne o estado de gravação de chamadas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Ação
|
action | True | string | |
|
ID da chamada
|
callId | True | string | |
|
ID do Usuário
|
userId | True | string |
Retornos
- response
- object
Alternar o estado acd do agente
Alterne o estado ACD do agente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Estado acd do agente
|
agentACDState | True | string |
Estado acd do agente |
|
ID do Usuário
|
userID | string |
ID do Usuário |
Fim da Chamada
Desligar/Encerrar uma chamada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | string |
Uma ID de usuário do BluIP. |
|
|
ID da chamada
|
callId | True | string |
ID de chamada de uma chamada. |
Nova chamada
Fazer uma chamada
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userID | string |
Uma ID de usuário do BluIP. |
|
|
Número de Telefone
|
address | True | string |
Número de telefone. |
Obter chamadas de usuário
Obtenha chamadas de usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
Uma ID de usuário do BluIP. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
ID da chamada
|
callId | string |
Ex: callhalf-29519312843:0 |
|
URI
|
uri | string |
Ex: /v2.0/user/user@provider.com/calls/callhalf-29519312843:0 |
Obter perfil de usuário
Obtenha o perfil do usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
service@provider.com |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do Usuário
|
details.userId | string |
user@bluip.com |
|
Primeiro Nome
|
details.firstName | string |
Jordânia |
|
Apelido
|
details.lastName | string |
Smith |
|
Sobrenome Hirangana
|
details.hiranganaLastName | string |
Smith |
|
Nome de Hirangana
|
details.hiranganaFirstName | string |
Jordânia |
|
Apelido
|
details.nameDialingName.nameDialingLastName | string |
Smith |
|
Primeiro Nome
|
details.nameDialingName.nameDialingFirstName | string |
Jordânia |
|
ID do grupo
|
details.groupId | integer | |
|
ID do Provedor de Serviços/Empresa
|
details.serviceProvider | string | |
|
Número
|
details.number | integer | |
|
Extension
|
details.extension | integer | |
|
Telemóvel
|
additionalDetails.mobile | string | |
|
Yahoo ID
|
additionalDetails.yahooId | string | |
|
Pager
|
additionalDetails.pager | string | |
|
Endereço de Email
|
additionalDetails.emailAddress | string | |
|
Title
|
additionalDetails.title | string | |
|
Localização
|
additionalDetails.location | string | |
|
Departamento
|
additionalDetails.department | string | |
|
IM&P
|
additionalDetails.impId | string | |
|
Dias de expiração de senha
|
passwordExpiresDays | integer | |
|
FAC URI
|
fac | string | |
|
URI de registros
|
registrations | string | |
|
URI da Lista de Agendamentos
|
scheduleList | string | |
|
URI de alteração de senha do portal
|
portalPasswordChange | string | |
|
Código do país
|
countryCode | string |
Resposta de chamada
Atenda a uma chamada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | string |
Uma ID de usuário do BluIP. |
|
|
ID da chamada
|
callId | string |
ID da chamada. |
Retenção de chamada
Coloque uma chamada em espera.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | string |
Uma ID de usuário do BluIP. |
|
|
ID da chamada
|
callId | True | string |
ID de chamada de uma chamada. |
Solicitação Bruta
Enviar uma solicitação bruta. Encontre mais recursos em: https://labxsp1.masteraccess.com/com.broadsoft.xsi-actions/test/v2.0/
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | True | string |
Uma ID de usuário do BluIP. |
|
Recurso/Caminho
|
path | True | string |
Escolha um recurso ou insira o caminho para um recurso. |
|
Conteúdo
|
payload | string |
Deixe vazio para "GET" ou inclua carga para dados "PUT". |
|
|
Aceitar
|
Accept | string |
Aceitar |
Transferir Chamada para Caixa Postal
Transferir chamada para a caixa postal.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | string |
Uma ID de usuário do BluIP. |
|
|
ID da chamada
|
callId | True | string |
ID de chamada de uma chamada. |
Transferir uma chamada
Transferir uma chamada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | string |
Uma ID de usuário do BluIP. |
|
|
ID da chamada
|
callId | True | string |
ID de chamada de uma chamada. |
|
Número de Telefone
|
address | True | string |
Número de telefone para o qual transferir. |
Gatilhos
| Assinatura de evento bruto |
Eventos. |
| Em Não Incomodar Alteração |
Reaja à alteração de estado DND de um usuário. |
| Evento on call |
Quando algo acontece com uma chamada. |
| Na alteração da fila do Call Center |
Reaja às chamadas em uma fila de call center. |
| Na alteração de estado acd do agente do call center |
Reaja à alteração de estado ACD (Distribuição Automática de Chamadas) de um agente de call center. |
| No Call Center Monitoring Change |
Reagir ao tempo médio de espera do call center, chamadas versus contagem de agentes etc. |
| No Resumo da Mensagem do Voice Mail |
Reaja a mensagens de caixa postal novas ou removidas. |
Assinatura de evento bruto
Eventos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | string |
Assinatura no nível do usuário. |
|
|
ID do grupo
|
groupId | string |
Assinaturas de nível de grupo. |
|
|
ID do Provedor de Serviço/Empresa
|
enterpriseId | string |
Assinaturas no nível do Provedor de Serviço/Empresa. |
|
|
Event
|
event | True | string |
Evento ao qual assinar. |
|
Tipo
|
type | string |
Tipo específico de evento: CallAnsweredEvent, CallReceivedEvent |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de usuário/destino
|
targetId | string |
Usuário de destino do evento. |
|
Event
|
event | string |
Tipo de evento. |
|
ID do evento
|
eventId | string |
A ID do evento. |
|
Tipo
|
type | string |
Tipo de evento. |
Em Não Incomodar Alteração
Reaja à alteração de estado DND de um usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | string |
Assinatura no nível do usuário. |
|
|
ID do grupo
|
groupId | string |
Assinaturas de nível de grupo. |
|
|
ID do Provedor de Serviço/Empresa
|
enterpriseId | string |
Assinaturas no nível do Provedor de Serviço/Empresa. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Active
|
active | boolean |
verdadeiro, falso |
|
Espirro de Anel
|
ringSplash | boolean |
verdadeiro, falso |
|
ID do evento
|
eventId | string |
d6986908-461e-40b9-85ca-e717851f776c |
|
ID de usuário/destino
|
targetId | string |
user@bluip.com |
Evento on call
Quando algo acontece com uma chamada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | string |
Assinatura no nível do usuário. |
|
|
ID do grupo
|
groupId | string |
Assinaturas de nível de grupo. |
|
|
ID do Provedor de Serviço/Empresa
|
enterpriseId | string |
Assinaturas no nível do Provedor de Serviço/Empresa. |
|
|
Tipo
|
type | string |
Tipo específico de evento de chamada. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo
|
type | string |
CallAnsweredEvent, CallBargedInEvent, CallCollectingEvent, CallHeldEvent, HookStatusEvent, CallMonitoredEvent, CallOriginatedEvent, CallOriginatingEvent, CallPickedUpEvent, CallReceivedEvent, CallRecordingPausedEvent, CallRecordingResumedEvent, CallRecordingStartedEvent, CallRecordingStartingEvent, CallRecordingStoppedEvent, CallRedirectedEvent, CallReleasedEvent, CallReleasingEvent, CallRetrievedEvent, CallTransferredEvent, CallUpdatedEvent |
|
Status do gancho
|
hookStatus | string |
Off-Hook, On-Hook |
|
ID do evento
|
eventId | string |
d5e21e5d-7f54-4db3-8351-4302e8dbf941 |
|
ID de usuário/destino
|
targetId | string |
user@bluip.com |
|
Event
|
event | string |
Chamada avançada |
|
ID da chamada
|
callId | string |
callhalf-31126219817:0 |
|
ID de acompanhamento externo
|
extTrackingId | string |
129987974:2 |
|
ID da chamada de rede
|
networkCallId | string |
2002829250_115291504@207.223.XX.XXX |
|
Personalidade
|
personality | string |
Terminador, Originador |
|
Estado
|
state | string |
Alertas, Ativos, Mantidos, Desanexados |
|
Hora de Início
|
startTime | integer |
1568204580687 |
|
Nome
|
remoteParty.name | string |
Jordan Smith |
|
Texto
|
remoteParty.address.#text | string | |
|
Código do país
|
remoteParty.address.countryCode | string |
1 |
|
NPA
|
remoteParty.address.npa | string |
818-XXX-XXXX |
|
NXX
|
remoteParty.address.nxx | string |
XXX-867-XXXX |
|
Tipo de chamada
|
remoteParty.callType | string |
Rede, Grupo |
|
ID do Usuário
|
remoteParty.userId | string |
user@bluip.com |
|
Texto
|
remoteParty.userDN.#text | string | |
|
Código do país
|
remoteParty.userDN.countryCode | string |
1, 44, etc. |
|
Tipo
|
endpoint.type | string |
AccessEndpoint |
|
Endereço do registro
|
endpoint.addressOfRecord | string |
user@bluip.com |
|
Aparência
|
appearance | integer |
1, 2, etc. |
|
Permitir resposta
|
allowAnswer | string | |
|
Tempo de Resposta
|
answerTime | integer |
1568204585231 |
|
Controles de gravação permitidos
|
allowedRecordingControls | string |
none, pause, resume |
|
Classificação de segurança
|
securityClassification | string |
Classificado, Não Classificado |
|
Exarado
|
recorded | string | |
|
Estado de gravação
|
recordingState | string |
Iniciado, pausado |
|
Permitir Recuperação
|
allowRetrieve | string | |
|
Tempo de Retização
|
heldTime | integer |
1568204589829 |
|
Tempo total de retida
|
totalHeldTime | integer |
4172 |
|
Call
|
call | array of |
Matriz de chamadas quando mais de uma chamada é assosiada. |
|
Tempo desanexado
|
detachedTime | integer |
1568204605894 |
|
Hora da versão
|
releaseTime | integer |
1568204620298 |
|
Liberando Parte
|
releasingParty | string |
localRelease, remoteRelease |
|
Texto
|
redirect.address.#text | string | |
|
Código do país
|
redirect.address.countryCode | string |
1, 44, etc. |
|
Reason
|
redirect.reason | string |
transferência |
|
Tempo de Redirecionamento
|
redirect.redirectTime | integer |
1568204605894 |
Na alteração da fila do Call Center
Reaja às chamadas em uma fila de call center.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do grupo
|
groupId | string |
Assinaturas de nível de grupo. |
|
|
ID do Provedor de Serviço/Empresa
|
enterpriseId | string |
Assinaturas no nível do Provedor de Serviço/Empresa. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da chamada
|
callId | string |
callhalf-31139148485:0 |
|
ID de acompanhamento externo
|
extTrackingId | string |
130080177:2 |
|
Nome
|
remoteParty.name | string |
Jordan Smith |
|
Texto
|
remoteParty.address.#text | string | |
|
Código do país
|
remoteParty.address.countryCode | string |
1, 44, etc. |
|
Tipo de chamada
|
remoteParty.callType | string |
Rede, Grupo |
|
Adicionar Tempo
|
addTime | integer |
1568213984179 |
|
Nome do ACD
|
acdName | string |
Central de Atendimento à Demonstração do BluIP |
|
Texto
|
acdNumber.#text | string | |
|
Código do país
|
acdNumber.countryCode | string |
1, 44, etc. |
|
Prioridade do ACD
|
acdPriority | string |
3-Baixo |
|
Adicionar tempo no bucket de prioridade
|
addTimeInPriorityBucket | integer |
1568213984179 |
|
Tipo
|
type | string |
ACDCallAbandonedEvent, ACDCallAddedEvent, ACDCallOfferedToAgentEvent, ACDWhisperStartedEvent,Available, Sign-In, Sign-Out, Unavailable, Wrap-UpACDCallAnsweredByAgentEvent |
|
ID do evento
|
eventId | string |
0b5bc6c2-bc74-4234-93f9-2945aca8b215 |
|
ID de usuário/destino do Call Center
|
targetId | string |
BluIPCCDemo@bluip.com |
|
Respondendo à ID de usuário/destino
|
answeringUserId | string |
user@bluip.com |
|
Atendendo à ID da chamada
|
answeringCallId | string |
callhalf-31139148489:0 |
|
Tempo de Remoção
|
removeTime | integer |
1568213990637 |
Na alteração de estado acd do agente do call center
Reaja à alteração de estado ACD (Distribuição Automática de Chamadas) de um agente de call center.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | string |
Assinatura no nível do usuário. |
|
|
ID do grupo
|
groupId | string |
Assinaturas de nível de grupo. |
|
|
ID do Provedor de Serviço/Empresa
|
enterpriseId | string |
Assinaturas no nível do Provedor de Serviço/Empresa. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Estado
|
state | string |
Disponível, entrada, saída, indisponível, Wrap-Up |
|
Value
|
stateTimestamp.value | integer |
1568212016997 |
|
Carimbo de data/hora de entrada
|
signInTimestamp | integer |
1568212016997 |
|
Tempo Total Disponível
|
totalAvailableTime | integer |
17, etc. |
|
Código indisponível
|
unavailableCode | integer |
1, 2, 3, 4, etc. |
|
Value
|
averageWrapUpTime.value | integer |
0 |
|
ID do evento
|
eventId | string |
37bacb10-82a5-47ba-8a6f-f9335433e584 |
|
ID de usuário/destino
|
targetId | string |
user@bluip.com |
No Call Center Monitoring Change
Reagir ao tempo médio de espera do call center, chamadas versus contagem de agentes etc.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do grupo
|
groupId | string |
Assinaturas de nível de grupo. |
|
|
ID do Provedor de Serviço/Empresa
|
enterpriseId | string |
Assinaturas no nível do Provedor de Serviço/Empresa. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Value
|
averageHandlingTime.value | integer |
0 |
|
Value
|
expectedWaitTime.value | integer |
0 |
|
Value
|
averageSpeedOfAnswer.value | integer |
14622 |
|
Value
|
longestWaitTime.value | integer |
5005 |
|
Value
|
numCallsInQueue.value | integer |
1 |
|
Número de agentes atribuídos
|
numAgentsAssigned | integer |
1 |
|
Número de agentes com pessoal
|
numAgentsStaffed | integer |
1 |
|
Número de agentes com pessoal ocioso
|
numStaffedAgentsIdle | integer |
0 |
|
Número de agentes não disponíveis
|
numStaffedAgentsUnavailable | integer |
0 |
|
ID do evento
|
eventId | string |
795db7d3-1461-48dd-8a33-65cfdc9dab00 |
|
ID de usuário/destino do Call Center
|
targetId | string |
BluIPCCDemo@bluip.com |
No Resumo da Mensagem do Voice Mail
Reaja a mensagens de caixa postal novas ou removidas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
userId | string |
Assinatura no nível do usuário. |
|
|
ID do grupo
|
groupId | string |
Assinaturas de nível de grupo. |
|
|
ID do Provedor de Serviço/Empresa
|
enterpriseId | string |
Assinaturas no nível do Provedor de Serviço/Empresa. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Novas Mensagens
|
newMessages | integer |
1, 2, 3, etc. |
|
Mensagens antigas
|
oldMessages | integer |
1, 2, 3, etc. |
Definições
objeto
Esse é o tipo 'object'.