Telefonia Xtended Serv Interf (Pré-visualização)
Integre com o sistema de telefonia BluIP para levar sua chamada para o próximo nível. Interface de serviço Xtended de telefonia (XSI).
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte BluIP |
| URL | https://support.bluip.com |
| developers@bluip.com |
| Metadados do conector | |
|---|---|
| Editora | BluIP, Inc. |
| Sítio Web | 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 com o sistema de telefonia BluIP para levar sua chamada para o próximo nível. Interface de serviço Xtended de telefonia (XSI).
Pre-requisites
Uma conta de usuário, grupo, empresa ou administrador de sistema BluIP.
Documentação da API
Como obter credenciais
Entre em contato com a equipe de suporte da BluIP para obter uma conta demo ou detalhes sobre sua conta atual.
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | 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.
Esta conexão não é compartilhável. Se o aplicativo avançado 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 utilizador | securestring | Nome de usuário MasterAccess (usuário, grupo, empresa ou administrador do sistema) | Verdade |
| Palavra-passe | securestring | Palavra-passe MasterAccess | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Alternar gravação de chamadas |
Alternar o estado de gravação da chamada. |
| Alternar o estado do ACD do agente |
Alterne o estado do ACD do agente. |
| Atendimento de chamadas |
Atenda uma chamada. |
| Chamada em espera |
Coloque uma chamada em espera. |
| Fim da chamada |
Desligar/Terminar uma chamada. |
| Nova Chamada |
Fazer uma chamada |
| Obter perfil de usuário |
Obter perfil de usuário. |
| Pedido Raw |
Envie uma solicitação bruta. Encontre mais recursos em: https://labxsp1.masteraccess.com/com.broadsoft.xsi-actions/test/v2.0/ |
| Receba chamadas de usuário |
Receba chamadas de usuários. |
| Transferir chamada para o correio de voz |
Transfira a chamada para o correio de voz. |
| Transferir uma chamada |
Transfira uma chamada. |
Alternar gravação de chamadas
Alternar o estado de gravação da chamada.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Ação
|
action | True | string | |
|
ID da chamada
|
callId | True | string | |
|
ID de utilizador
|
userId | True | string |
Devoluções
- response
- object
Alternar o estado do ACD do agente
Alterne o estado do ACD do agente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Estado do ACD do agente
|
agentACDState | True | string |
Estado do ACD do agente |
|
ID de utilizador
|
userID | string |
ID de utilizador |
Atendimento de chamadas
Atenda uma chamada.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userId | string |
Um ID de usuário BluIP. |
|
|
ID da chamada
|
callId | string |
ID de chamada de chamada. |
Chamada em espera
Coloque uma chamada em espera.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userId | string |
Um ID de usuário BluIP. |
|
|
ID da chamada
|
callId | True | string |
ID de chamada de uma chamada. |
Fim da chamada
Desligar/Terminar uma chamada.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userId | string |
Um ID de usuário BluIP. |
|
|
ID da chamada
|
callId | True | string |
ID de chamada de uma chamada. |
Nova Chamada
Fazer uma chamada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userID | string |
Um ID de usuário BluIP. |
|
|
Número de Telefone
|
address | True | string |
Número de telefone. |
Obter perfil de usuário
Obter perfil de usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userId | True | string |
service@provider.com |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de utilizador
|
details.userId | string |
user@bluip.com |
|
Nome Próprio
|
details.firstName | string |
Jordânia |
|
Apelido
|
details.lastName | string |
Smith |
|
Sobrenome Hirangana
|
details.hiranganaLastName | string |
Smith |
|
Nome Hirangana
|
details.hiranganaFirstName | string |
Jordânia |
|
Apelido
|
details.nameDialingName.nameDialingLastName | string |
Smith |
|
Nome Próprio
|
details.nameDialingName.nameDialingFirstName | string |
Jordânia |
|
ID do grupo
|
details.groupId | integer | |
|
Provedor de serviços/Enterprise ID
|
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 E-mail
|
additionalDetails.emailAddress | string | |
|
Title
|
additionalDetails.title | string | |
|
Localização
|
additionalDetails.location | string | |
|
Departamento
|
additionalDetails.department | string | |
|
IM&P
|
additionalDetails.impId | string | |
|
A palavra-passe expira dias
|
passwordExpiresDays | integer | |
|
FAC URI
|
fac | string | |
|
URI de inscrições
|
registrations | string | |
|
URI da lista de agendamento
|
scheduleList | string | |
|
URI de alteração de senha do portal
|
portalPasswordChange | string | |
|
Código do país
|
countryCode | string |
Pedido Raw
Envie uma solicitação bruta. Encontre mais recursos em: https://labxsp1.masteraccess.com/com.broadsoft.xsi-actions/test/v2.0/
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userId | True | string |
Um ID de usuário BluIP. |
|
Recurso/Caminho
|
path | True | string |
Escolha um recurso ou insira o caminho para um recurso. |
|
Carga útil
|
payload | string |
Deixe vazio para "GET" ou inclua carga útil para dados "PUT". |
|
|
Aceitar
|
Accept | string |
Aceitar |
Receba chamadas de usuário
Receba chamadas de usuários.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userId | True | string |
Um ID de usuário BluIP. |
Devoluções
| Name | 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 |
Transferir chamada para o correio de voz
Transfira a chamada para o correio de voz.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userId | string |
Um ID de usuário BluIP. |
|
|
ID da chamada
|
callId | True | string |
ID de chamada de uma chamada. |
Transferir uma chamada
Transfira uma chamada.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userId | string |
Um ID de usuário 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. |
Acionadores
| Alteração de estado do ACD do agente de call center |
Reaja à alteração de estado ACD (Distribuição Automática de Chamadas) de um agente de call center. |
| Alteração na fila do Call Center |
Reaja a chamadas em uma fila de call center. |
| Em Não Perturbe a Mudança |
Reaja à alteração de estado DND de um usuário. |
| Evento On Call |
Quando algo acontece a uma chamada. |
| Mudança de monitoramento no call center |
Reaja ao tempo médio de espera do call center, à contagem de chamadas vs. agentes, etc. |
| Resumo da mensagem da caixa postal |
Reaja a mensagens de correio de voz novas ou removidas. |
| Subscrição de Eventos Raw |
Eventos. |
Alteração de estado do ACD do agente de call center
Reaja à alteração de estado ACD (Distribuição Automática de Chamadas) de um agente de call center.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userId | string |
Subscrição ao nível do utilizador. |
|
|
ID do grupo
|
groupId | string |
Subscrições a nível de grupo. |
|
|
ID da empresa/provedor de serviços
|
enterpriseId | string |
Subscrições ao nível da Empresa/Fornecedor de Serviços. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Estado
|
state | string |
Disponível, Entrar, Sair, Indisponível, Wrap-Up |
|
Valor
|
stateTimestamp.value | integer |
1568212016997 |
|
Carimbo de data/hora de login
|
signInTimestamp | integer |
1568212016997 |
|
Tempo Total Disponível
|
totalAvailableTime | integer |
17, etc. |
|
Código indisponível
|
unavailableCode | integer |
1, 2, 3, 4, etc. |
|
Valor
|
averageWrapUpTime.value | integer |
0 |
|
ID do Evento
|
eventId | string |
37BABB10-82A5-47BA-8A6F-F9335433E584 |
|
ID de Utilizador/Destino
|
targetId | string |
user@bluip.com |
Alteração na fila do Call Center
Reaja a chamadas em uma fila de call center.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do grupo
|
groupId | string |
Subscrições a nível de grupo. |
|
|
ID da empresa/provedor de serviços
|
enterpriseId | string |
Subscrições ao nível da Empresa/Fornecedor de Serviços. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da chamada
|
callId | string |
callhalf-31139148485:0 |
|
ID de rastreamento externo
|
extTrackingId | string |
130080177:2 |
|
Nome
|
remoteParty.name | string |
Jordan Soares |
|
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 BluIP Demo |
|
Texto
|
acdNumber.#text | string | |
|
Código do país
|
acdNumber.countryCode | string |
1, 44, etc. |
|
Prioridade ACD
|
acdPriority | string |
3-Baixo |
|
Adicionar tempo no bucket prioritário
|
addTimeInPriorityBucket | integer |
1568213984179 |
|
Tipo
|
type | string |
ACDCallAbandonedEvent, ACDCallAddedEvent, ACDCallOfferToAgentEvent, ACDWhisperStartedEvent,Available, Sign-In, Sign-Out, Unavailable, Wrap-UpACDCallAnsweredByAgentEvent |
|
ID do Evento
|
eventId | string |
0b5bc6c2-bc74-4234-93f9-2945aca8b215 |
|
ID de Utilizador/Destino do Call Center
|
targetId | string |
BluIPCCDemo@bluip.com |
|
Respondendo ID de usuário/destino
|
answeringUserId | string |
user@bluip.com |
|
ID de Atendimento de Chamadas
|
answeringCallId | string |
callhalf-31139148489:0 |
|
Remover Tempo
|
removeTime | integer |
1568213990637 |
Em Não Perturbe a Mudança
Reaja à alteração de estado DND de um usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userId | string |
Subscrição ao nível do utilizador. |
|
|
ID do grupo
|
groupId | string |
Subscrições a nível de grupo. |
|
|
ID da empresa/provedor de serviços
|
enterpriseId | string |
Subscrições ao nível da Empresa/Fornecedor de Serviços. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Active
|
active | boolean |
verdadeiro, falso |
|
Salpicos de anel
|
ringSplash | boolean |
verdadeiro, falso |
|
ID do Evento
|
eventId | string |
d6986908-461e-40b9-85ca-e717851f776c |
|
ID de Utilizador/Destino
|
targetId | string |
user@bluip.com |
Evento On Call
Quando algo acontece a uma chamada.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userId | string |
Subscrição ao nível do utilizador. |
|
|
ID do grupo
|
groupId | string |
Subscrições a nível de grupo. |
|
|
ID da empresa/provedor de serviços
|
enterpriseId | string |
Subscrições ao nível da Empresa/Fornecedor de Serviços. |
|
|
Tipo
|
type | string |
Tipo específico de evento de chamada. |
Devoluções
| Name | 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 |
Fora do gancho, no gancho |
|
ID do Evento
|
eventId | string |
d5e21e5d-7f54-4db3-8351-4302e8dbf941 |
|
ID de Utilizador/Destino
|
targetId | string |
user@bluip.com |
|
Event
|
event | string |
Chamada Avançada |
|
ID da chamada
|
callId | string |
callhalf-31126219817:0 |
|
ID de rastreamento externo
|
extTrackingId | string |
129987974:2 |
|
ID de chamada de rede
|
networkCallId | string |
2002829250_115291504@207.223.XX.XXX |
|
Personalidade
|
personality | string |
Exterminador, Originador |
|
Estado
|
state | string |
Alerta, Ativo, Detido, Destacado |
|
Hora de Início
|
startTime | integer |
1568204580687 |
|
Nome
|
remoteParty.name | string |
Jordan Soares |
|
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 de utilizador
|
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 de registo
|
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 |
nenhum, pausar, retomar |
|
Classificação de Segurança
|
securityClassification | string |
Classificado, Não classificado |
|
Gravado
|
recorded | string | |
|
Estado de gravação
|
recordingState | string |
Iniciado, pausado |
|
Permitir recuperação
|
allowRetrieve | string | |
|
Tempo Retido
|
heldTime | integer |
1568204589829 |
|
Tempo total retido
|
totalHeldTime | integer |
4172 |
|
Call
|
call | array of |
Matriz de chamadas quando mais de uma chamada é associada. |
|
Tempo Destacado
|
detachedTime | integer |
1568204605894 |
|
Tempo de Lançamento
|
releaseTime | integer |
1568204620298 |
|
Festa de Lançamento
|
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 |
Mudança de monitoramento no call center
Reaja ao tempo médio de espera do call center, à contagem de chamadas vs. agentes, etc.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do grupo
|
groupId | string |
Subscrições a nível de grupo. |
|
|
ID da empresa/provedor de serviços
|
enterpriseId | string |
Subscrições ao nível da Empresa/Fornecedor de Serviços. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Valor
|
averageHandlingTime.value | integer |
0 |
|
Valor
|
expectedWaitTime.value | integer |
0 |
|
Valor
|
averageSpeedOfAnswer.value | integer |
14622 |
|
Valor
|
longestWaitTime.value | integer |
5005 |
|
Valor
|
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 ociosos
|
numStaffedAgentsIdle | integer |
0 |
|
Número de agentes com pessoal indisponível
|
numStaffedAgentsUnavailable | integer |
0 |
|
ID do Evento
|
eventId | string |
795db7d3-1461-48dd-8a33-65cfdc9dab00 |
|
ID de Utilizador/Destino do Call Center
|
targetId | string |
BluIPCCDemo@bluip.com |
Resumo da mensagem da caixa postal
Reaja a mensagens de correio de voz novas ou removidas.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userId | string |
Subscrição ao nível do utilizador. |
|
|
ID do grupo
|
groupId | string |
Subscrições a nível de grupo. |
|
|
ID da empresa/provedor de serviços
|
enterpriseId | string |
Subscrições ao nível da Empresa/Fornecedor de Serviços. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Novas mensagens
|
newMessages | integer |
1, 2, 3, etc. |
|
Mensagens antigas
|
oldMessages | integer |
1, 2, 3, etc. |
Subscrição de Eventos Raw
Eventos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
userId | string |
Subscrição ao nível do utilizador. |
|
|
ID do grupo
|
groupId | string |
Subscrições a nível de grupo. |
|
|
ID da empresa/provedor de serviços
|
enterpriseId | string |
Subscrições ao nível da Empresa/Fornecedor de Serviços. |
|
|
Event
|
event | True | string |
Evento para subscrever. |
|
Tipo
|
type | string |
Tipo específico de evento: CallAnsweredEvent, CallReceivedEvent |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de Utilizador/Destino
|
targetId | string |
Usuário alvo do evento. |
|
Event
|
event | string |
Tipo de evento. |
|
ID do Evento
|
eventId | string |
A ID do evento. |
|
Tipo
|
type | string |
Tipo de evento. |
Definições
objecto
Este é o tipo 'objeto'.