Connectors Reference

Telephony Xtended Serv Interf

Integrate with BluIP's telephony system to take your call to the next level. Telephony Xtended Service Interface (XSI).

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

raw ([Optional]rawParameterBody body, [Optional]string Accept)

Raw Request

list.actions ()

Actions

list.eventTypes ()

Event Types

list.callTypes ()

Call Types

list.users ()

Users

user.calls ([internal]string Content-Type, user.callsParameterBody body, [internal]string Accept)

Get User Calls

user.profile (user.profileParameterBody body)

Get User Profile

call.recording ([Optional]call.recordingParameterBody body)

Toggle Call Recording

list.AgentACDStates ()

AgentACD States List

toggle.AgentACDState ([internal]string Content-Type, [Optional]toggle.AgentACDStateParameterBody body)

Toggle Agent ACD State

call.New ([Optional]call.NewParameterBody body)

New Call

call.Hold ([Optional]call.HoldParameterBody body)

Call Hold

call.End ([Optional]call.EndParameterBody body)

Call End

call.recording.states ([Optional]string Accept)

Call Recording States

call.TransfertoVoicemail ([Optional]call.TransfertoVoicemailParameterBody body)

Transfer Call to Voicemail

call.Transfer ([Optional]call.TransferParameterBody body)

Transfer a Call

call.Answer ([Optional]call.AnswerParameterBody body)

Call Answer

 

Triggers:

Name

Summary

events ([internal]string Content-Type, eventsParameterBody body)

Raw Event Subscription

events.doNotDisturb (events.doNotDisturbParameterBody body)

On Do Not Disturb Change

events.callCenterMonitoring (events.callCenterMonitoringParameterBody body)

On Call Center Monitoring Change

events.callCenterQueue (events.callCenterQueueParameterBody body)

On Call Center Queue Change

events.callCenterAgent (events.callCenterAgentParameterBody body)

On Call Center Agent ACD State Change

events.voicemail (events.voicemailParameterBody body)

On Voice Mail Message Summary

events.call (events.callParameterBody body)

On Call Event

 

Objects:

Name

Summary

call.AnswerParameterBody

 

call.AnswerResponse

 

call.EndParameterBody

 

call.EndResponse

 

call.HoldParameterBody

 

call.HoldResponse

 

call.NewParameterBody

 

call.NewResponse

 

call.recording.statesResponse

 

call.recordingParameterBody

 

call.recordingResponse

 

call.TransferParameterBody

 

call.TransferResponse

 

call.TransfertoVoicemailParameterBody

 

call.TransfertoVoicemailResponse

 

events.callCenterAgentParameterBody

 

events.callCenterAgentResponse

 

events.callCenterMonitoringParameterBody

 

events.callCenterMonitoringResponse

 

events.callCenterQueueParameterBody

 

events.callCenterQueueResponse

 

events.callParameterBody

 

events.callResponse

 

events.doNotDisturbParameterBody

 

events.doNotDisturbResponse

 

events.voicemailParameterBody

 

events.voicemailResponse

 

eventsParameterBody

 

eventsResponse

 

list.actionsResponse

 

list.AgentACDStatesResponse

 

list.callTypesResponse

 

list.eventTypesResponse

 

list.usersResponse

 

rawParameterBody

 

rawResponse

 

toggle.AgentACDStateParameterBody

 

toggle.AgentACDStateResponse

 

user.callsParameterBody

 

user.callsResponseItem

 

user.profileParameterBody

 

user.profileResponse

 

 

Actions:

raw

Summary: Raw Request

Description: Send a raw request. Find more resources at: https://labxsp1.masteraccess.com/com.broadsoft.xsi-actions/test/v2.0/

 

Syntax:

TelephonyXtendedServInterf.raw ([Optional]rawParameterBody body, [Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

rawParameterBody

 

 

False

Accept

string

(Accept)Values: [application/json, application/xml]

Accept

False

 

Returns:

          Type:rawResponse

 

list.actions

Summary: Actions

Description: List actions in your scope.

 

Syntax:

TelephonyXtendedServInterf.list.actions ()

 

Returns:

          Type:list.actionsResponse

 

list.eventTypes

Summary: Event Types

Description: List of event types.

 

Syntax:

TelephonyXtendedServInterf.list.eventTypes ()

 

Returns:

          Type:list.eventTypesResponse

 

list.callTypes

Summary: Call Types

Description: List of call types.

 

Syntax:

TelephonyXtendedServInterf.list.callTypes ()

 

Returns:

          Type:list.callTypesResponse

 

list.users

Summary: Users

Description: List users in your scope.

 

Syntax:

TelephonyXtendedServInterf.list.users ()

 

Returns:

          Type:list.usersResponse

 

user.calls

Summary: Get User Calls

Description: Get user calls.

 

Syntax:

TelephonyXtendedServInterf.user.calls ([internal]string Content-Type, user.callsParameterBody body, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

body

user.callsParameterBody

 

 

True

Accept

string

 

 

True

 

Returns:

          Type:array of (user.callsResponseItem)

 

user.profile

Summary: Get User Profile

Description: Get user profile.

 

Syntax:

TelephonyXtendedServInterf.user.profile (user.profileParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

user.profileParameterBody

 

 

True

 

Returns:

          Type:user.profileResponse

 

call.recording

Summary: Toggle Call Recording

Description: Toggle call recording state.

 

Syntax:

TelephonyXtendedServInterf.call.recording ([Optional]call.recordingParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

call.recordingParameterBody

 

 

False

 

Returns:

          Type:call.recordingResponse

 

list.AgentACDStates

Summary: AgentACD States List

Description: List of Agent ACD States.

 

Syntax:

TelephonyXtendedServInterf.list.AgentACDStates ()

 

Returns:

          Type:list.AgentACDStatesResponse

 

toggle.AgentACDState

Summary: Toggle Agent ACD State

Description: Toggle the Agent ACD State.

 

Syntax:

TelephonyXtendedServInterf.toggle.AgentACDState ([internal]string Content-Type, [Optional]toggle.AgentACDStateParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

body

toggle.AgentACDStateParameterBody

 

 

False

 

Returns:

          Type:toggle.AgentACDStateResponse

 

call.New

Summary: New Call

Description: Make a call

 

Syntax:

TelephonyXtendedServInterf.call.New ([Optional]call.NewParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

call.NewParameterBody

 

 

False

 

Returns:

          Type:call.NewResponse

 

call.Hold

Summary: Call Hold

Description: Put a call on hold.

 

Syntax:

TelephonyXtendedServInterf.call.Hold ([Optional]call.HoldParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

call.HoldParameterBody

 

 

False

 

Returns:

          Type:call.HoldResponse

 

call.End

Summary: Call End

Description: Hangup/End a call.

 

Syntax:

TelephonyXtendedServInterf.call.End ([Optional]call.EndParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

call.EndParameterBody

 

 

False

 

Returns:

          Type:call.EndResponse

 

call.recording.states

Summary: Call Recording States

Description: Call recording states.

 

Syntax:

TelephonyXtendedServInterf.call.recording.states ([Optional]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

Accept

string

 

 

False

 

Returns:

          Type:call.recording.statesResponse

 

call.TransfertoVoicemail

Summary: Transfer Call to Voicemail

Description: Transfer call to voicemail.

 

Syntax:

TelephonyXtendedServInterf.call.TransfertoVoicemail ([Optional]call.TransfertoVoicemailParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

call.TransfertoVoicemailParameterBody

 

 

False

 

Returns:

          Type:call.TransfertoVoicemailResponse

 

call.Transfer

Summary: Transfer a Call

Description: Transfer a call.

 

Syntax:

TelephonyXtendedServInterf.call.Transfer ([Optional]call.TransferParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

call.TransferParameterBody

 

 

False

 

Returns:

          Type:call.TransferResponse

 

call.Answer

Summary: Call Answer

Description: Answer a call.

 

Syntax:

TelephonyXtendedServInterf.call.Answer ([Optional]call.AnswerParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

call.AnswerParameterBody

 

 

False

 

Returns:

          Type:call.AnswerResponse

 

Triggers:

Trigger events

Summary: Raw Event Subscription

Description: Events.

 

Syntax:

TelephonyXtendedServInterf.events ([internal]string Content-Type, eventsParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

body

eventsParameterBody

 

 

True

 

Returns:

          Type:eventsResponse

 

Trigger events.doNotDisturb

Summary: On Do Not Disturb Change

Description: React to a user's DND state change.

 

Syntax:

TelephonyXtendedServInterf.events.doNotDisturb (events.doNotDisturbParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

events.doNotDisturbParameterBody

 

 

True

 

Returns:

          Type:events.doNotDisturbResponse

 

Trigger events.callCenterMonitoring

Summary: On Call Center Monitoring Change

Description: React to call center average wait time, calls vs. agent count, etc.

 

Syntax:

TelephonyXtendedServInterf.events.callCenterMonitoring (events.callCenterMonitoringParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

events.callCenterMonitoringParameterBody

 

 

True

 

Returns:

          Type:events.callCenterMonitoringResponse

 

Trigger events.callCenterQueue

Summary: On Call Center Queue Change

Description: React to calls in a call center queue.

 

Syntax:

TelephonyXtendedServInterf.events.callCenterQueue (events.callCenterQueueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

events.callCenterQueueParameterBody

 

 

True

 

Returns:

          Type:events.callCenterQueueResponse

 

Trigger events.callCenterAgent

Summary: On Call Center Agent ACD State Change

Description: React to a call center agent's ACD (Automatic Call Distribution) state change.

 

Syntax:

TelephonyXtendedServInterf.events.callCenterAgent (events.callCenterAgentParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

events.callCenterAgentParameterBody

 

 

True

 

Returns:

          Type:events.callCenterAgentResponse

 

Trigger events.voicemail

Summary: On Voice Mail Message Summary

Description: React to new or removed voicemail messages.

 

Syntax:

TelephonyXtendedServInterf.events.voicemail (events.voicemailParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

events.voicemailParameterBody

 

 

True

 

Returns:

          Type:events.voicemailResponse

 

Trigger events.call

Summary: On Call Event

Description: When something happens to a call.

 

Syntax:

TelephonyXtendedServInterf.events.call (events.callParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

events.callParameterBody

 

 

True

 

Returns:

          Type:events.callResponse

 


 

call.AnswerParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

userId

string

 

A BluIP User ID.

callId

string

 

Call Call ID.


 

call.AnswerResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

call.EndParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

userId

string

 

A BluIP User ID.

callId

string

 

Call ID of a call.

decline

string

 

decline

declineReason

string

 

declineReason

allowDetached

string

 

allowDetached


 

call.EndResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

call.HoldParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

userId

string

 

A BluIP User ID.

callId

string

 

Call ID of a call.


 

call.HoldResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

call.NewParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

userID

string

 

A BluIP User ID.

pin

string

 

pin

location

string

 

location

clId

string

 

clId

address

string

 

Phone number.

roomId

string

 

roomId

conferenceId

string

 

conferenceId

locationAddress

string

 

locationAddress

info

string

 

info


 

call.NewResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

call.recording.statesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

summary

string

 

summary

description

string

 

description

operationId

string

 

operationId

parameters

array of (ParametersItem)

 

parameters

responses

Responses

 

responses

 

ParametersItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

name

value

string

 

value

 

Responses

Summary:

Description: responses

 

          Properties:

Name

Type

Summary

200

200

 

200

default

Default

 

default

 

200

Summary:

Description: 200

 

          Properties:

Name

Type

Summary

description

string

 

description

schema

Schema

 

schema

 

Schema

Summary:

Description: schema

 

          Properties:

Name

Type

Summary

type

string

 

type

 

Default

Summary:

Description: default

 

          Properties:

Name

Type

Summary

description

string

 

description

 


 

call.recordingParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

action

string

 

 

callId

string

 

 

userId

string

 

 


 

call.recordingResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

call.TransferParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

userId

string

 

A BluIP User ID.

callId

string

 

Call ID of a call.

address

string

 

Phone number to transfer to.

toFront

string

 

toFront


 

call.TransferResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

call.TransfertoVoicemailParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

userId

string

 

A BluIP User ID.

callId

string

 

Call ID of a call.

address

string

 

address


 

call.TransfertoVoicemailResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

events.callCenterAgentParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

userId

string

 

User level subscription.

groupId

string

 

Group level subscriptions.

enterpriseId

string

 

Enterprise/Service Provider level subscriptions.

event

string

 

event

notificationUrl

string

 

notificationUrl


 

events.callCenterAgentResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

events.callCenterMonitoringParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

groupId

string

 

Group level subscriptions.

enterpriseId

string

 

Enterprise/Service Provider level subscriptions.

event

string

 

event

notificationUrl

string

 

notificationUrl


 

events.callCenterMonitoringResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

events.callCenterQueueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

groupId

string

 

Group level subscriptions.

enterpriseId

string

 

Enterprise/Service Provider level subscriptions.

event

string

 

event

notificationUrl

string

 

notificationUrl


 

events.callCenterQueueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

events.callParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

userId

string

 

User level subscription.

groupId

string

 

Group level subscriptions.

enterpriseId

string

 

Enterprise/Service Provider level subscriptions.

event

string

 

event

type

string

 

Specific type of call event.

notificationUrl

string

 

notificationUrl


 

events.callResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

events.doNotDisturbParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

userId

string

 

User level subscription.

groupId

string

 

Group level subscriptions.

enterpriseId

string

 

Enterprise/Service Provider level subscriptions.

event

string

 

event

notificationUrl

string

 

notificationUrl


 

events.doNotDisturbResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

events.voicemailParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

userId

string

 

User level subscription.

groupId

string

 

Group level subscriptions.

enterpriseId

string

 

Enterprise/Service Provider level subscriptions.

event

string

 

event

notificationUrl

string

 

notificationUrl


 

events.voicemailResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

eventsParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

userId

string

 

User level subscription.

groupId

string

 

Group level subscriptions.

enterpriseId

string

 

Enterprise/Service Provider level subscriptions.

event

string

 

Event to subscribe to.

type

string

 

Specific type of event: CallAnsweredEvent, CallReceivedEvent

notificationUrl

string

 

notificationUrl


 

eventsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

list.actionsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

summary

string

 

summary

description

string

 

description

operationId

string

 

operationId

parameters

array of (ParametersItem)

 

parameters

responses

Responses

 

responses

 

ParametersItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

name

value

string

 

value

 

Responses

Summary:

Description: responses

 

          Properties:

Name

Type

Summary

200

200

 

200

default

Default

 

default

 

200

Summary:

Description: 200

 

          Properties:

Name

Type

Summary

description

string

 

description

schema

Schema

 

schema

 

Schema

Summary:

Description: schema

 

          Properties:

Name

Type

Summary

type

string

 

type

 

Default

Summary:

Description: default

 

          Properties:

Name

Type

Summary

description

string

 

description

 


 

list.AgentACDStatesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

summary

string

 

summary

description

string

 

description

operationId

string

 

operationId

parameters

array of (ParametersItem)

 

parameters

responses

Responses

 

responses

 

ParametersItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

name

value

string

 

value

 

Responses

Summary:

Description: responses

 

          Properties:

Name

Type

Summary

200

200

 

200

default

Default

 

default

 

200

Summary:

Description: 200

 

          Properties:

Name

Type

Summary

description

string

 

description

schema

Schema

 

schema

 

Schema

Summary:

Description: schema

 

          Properties:

Name

Type

Summary

type

string

 

type

 

Default

Summary:

Description: default

 

          Properties:

Name

Type

Summary

description

string

 

description

 


 

list.callTypesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

summary

string

 

summary

description

string

 

description

operationId

string

 

operationId

parameters

array of (ParametersItem)

 

parameters

responses

Responses

 

responses

 

ParametersItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

name

value

string

 

value

 

Responses

Summary:

Description: responses

 

          Properties:

Name

Type

Summary

200

200

 

200

default

Default

 

default

 

200

Summary:

Description: 200

 

          Properties:

Name

Type

Summary

description

string

 

description

schema

Schema

 

schema

 

Schema

Summary:

Description: schema

 

          Properties:

Name

Type

Summary

type

string

 

type

 

Default

Summary:

Description: default

 

          Properties:

Name

Type

Summary

description

string

 

description

 


 

list.eventTypesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

summary

string

 

summary

description

string

 

description

operationId

string

 

operationId

parameters

array of (ParametersItem)

 

parameters

responses

Responses

 

responses

 

ParametersItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

name

value

string

 

value

 

Responses

Summary:

Description: responses

 

          Properties:

Name

Type

Summary

200

200

 

200

default

Default

 

default

 

200

Summary:

Description: 200

 

          Properties:

Name

Type

Summary

description

string

 

description

schema

Schema

 

schema

 

Schema

Summary:

Description: schema

 

          Properties:

Name

Type

Summary

type

string

 

type

 

Default

Summary:

Description: default

 

          Properties:

Name

Type

Summary

description

string

 

description

 


 

list.usersResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

summary

string

 

summary

description

string

 

description

operationId

string

 

operationId

parameters

array of (ParametersItem)

 

parameters

responses

Responses

 

responses

 

ParametersItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

name

value

string

 

value

 

Responses

Summary:

Description: responses

 

          Properties:

Name

Type

Summary

200

200

 

200

default

Default

 

default

 

200

Summary:

Description: 200

 

          Properties:

Name

Type

Summary

description

string

 

description

schema

Schema

 

schema

 

Schema

Summary:

Description: schema

 

          Properties:

Name

Type

Summary

type

string

 

type

 

Default

Summary:

Description: default

 

          Properties:

Name

Type

Summary

description

string

 

description

 


 

rawParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

userId

string

User ID

A BluIP User ID.

path

string

 

Pick a resource or enter the path to a resource.

payload

string

 

Leave empty to "GET" or include payload to "PUT" data.


 

rawResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

toggle.AgentACDStateParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

agentACDState

string

 

Agent ACD State

userID

string

 

User ID


 

toggle.AgentACDStateResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

user.callsParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

userId

string

 

A BluIP User ID.


 

user.callsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

callId

string

 

Ex: callhalf-29519312843:0

uri

string

 

Ex: /v2.0/user/user@provider.com/calls/callhalf-29519312843:0


 

user.profileParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

userId

string

 

service@provider.com


 

user.profileResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

details

Details

 

 

additionalDetails

AdditionalDetails

 

 

passwordExpiresDays

integer(int32)

 

 

fac

string

 

 

registrations

string

 

 

scheduleList

string

 

 

portalPasswordChange

string

 

 

countryCode

string

 

 

 

Details

Summary:

Description:

 

          Properties:

Name

Type

Summary

userId

string

 

user@bluip.com

firstName

string

 

Jordan

lastName

string

 

Smith

hiranganaLastName

string

 

Smith

hiranganaFirstName

string

 

Jordan

nameDialingName

NameDialingName

 

 

groupId

integer

 

 

serviceProvider

string

 

 

number

integer(int32)

 

 

extension

integer(int32)

 

 

 

NameDialingName

Summary:

Description:

 

          Properties:

Name

Type

Summary

nameDialingLastName

string

 

Smith

nameDialingFirstName

string

 

Jordan

 

AdditionalDetails

Summary:

Description:

 

          Properties:

Name

Type

Summary

mobile

string

 

 

yahooId

string

 

 

pager

string

 

 

emailAddress

string

 

 

title

string

 

 

location

string

 

 

department

string

 

 

impId

string