Evo Voice

<back to all web services

GetEndpointAppConfig

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager, Customer
The following routes are available for this service:
GET/endpoints/app/config
GetEndpointAppConfig Parameters:
NameParameterData TypeRequiredDescription
EndpointIdquerystringNoThe endpoint whose config you want to get (this must be a User)
EndpointEmailAddressquerystringNoThe endpoint email address whose config you want to get (this must be a User) - EndpointId takes priority over this
DeviceTypequeryDeviceTypesNoThe type of device you are requesting config for
PushCredentialSidquerystringNoUse a specific push credential SID
ApplicationSidquerystringNoUse a specific application SID
SandboxqueryboolNoIs this device operating in a sandbox environment? IOS only.
DeviceTypes Enum:
Web
iOS
Android
AppConfig Parameters:
NameParameterData TypeRequiredDescription
EndpointIdformstringNoThe ID of this endpoint
AccountIdformstringNoThe ID of the account
CustomerIdformstringNoThe customer ID associated with this user
AccessTokenformstringNoThe access token for use with Twilio Voice
IdentityformstringNoThe access token's identity
EmailAddressformstringNoThe email address of the user
UserInfoformAppUserInfoNoThe user's information
AgentStateformAgentStatesNoThe agent state (for call center users)
AgentStateReasonformAgentStateReasonsNoThe agent state reason
TabsformList<Object>NoThe tabs for the app
AppSettingsformAppSettingsNoThe app settings
ThirdPartyPhoneSystemSettingsformThirdPartyPhoneSystemSettingsNoThe phone settings for third party connectivity
AppUserInfo Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNoThe user's first name
LastNameformstringNoThe user's last name
NameformstringNoShortcut to the user's full name
AvatarUrlformstringNoThe URL to the user's avatar
AgentStates Enum:
Unknown
Ready
NotReady
LoggedOut
WrapUp
Outgoing
Other
AgentStateReasons Enum:
Unknown
SetByUser
MissedCall
SetBySystem
AppSettings Parameters:
NameParameterData TypeRequiredDescription
EnablePhoneNumberManagementformboolNo
EnableDeviceManagementformboolNo
EnableDialerformboolNo
EnableCallHistoryformboolNo
EnableAssistantsformboolNo
ShowFileNameInMessageCenterformboolNo
ChakraThemeformstringNo
CustomCssformstringNo
PageTitleformstringNo
StringMappingsformstringNo
LogoutUrlformstringNo
PortMyNumberUrlformstringNo
ThirdPartyPhoneSystemSettings Parameters:
NameParameterData TypeRequiredDescription
TypeformThirdPartyPhoneSystemTypesNo
SipSettingsformThirdPartySipSettingsNo
DemoSettingsformThirdPartyDemoSettingsNo
ThirdPartyPhoneSystemTypes Enum:
Demo
Sip
ThirdPartySipSettings Parameters:
NameParameterData TypeRequiredDescription
AccountsformList<ThirdPartySipAccountSettings>No
ThirdPartySipAccountSettings Parameters:
NameParameterData TypeRequiredDescription
NumberformstringNo
AgentformstringNo
AuthNameformstringNo
UserNameformstringNo
DisplayNameformstringNo
PasswordformstringNo
UserDomainformstringNo
RegistrationExpiresformintNo
TransportTypeformTransportTypesNo
LocalIPformstringNo
LocalPortformintNo
SipServerformstringNo
SipServerPortformintNo
OutboundServerformstringNo
OutboundServerPortformintNo
StunServerformstringNo
StunPortformintNo
AudioPlaybackDeviceNameformstringNo
AudioRecordingDeviceNameformstringNo
AudioCodecsformList<AudioCodecTypes>No
DTMFMethodformDtmfMethodsNo
TransportTypes Enum:
UDP
TLS
TCP
PERS
AudioCodecTypes Enum:
NameValue
PCMU0
GSM3
PCMA8
G7229
G72918
ILBC97
AMR98
AMRWB99
SPEEX100
DTMF101
SPEEXWB102
ISACWB103
ISACSWB104
OPUS105
G7221121
NONE-1
DtmfMethods Enum:
RFC2833
INFO
ThirdPartyDemoSettings Parameters:
NameParameterData TypeRequiredDescription
ExtensionformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /endpoints/app/config HTTP/1.1 
Host: team.evovoice.io 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"endpointId":"String","accountId":"String","customerId":"String","accessToken":"String","identity":"String","emailAddress":"String","userInfo":{"firstName":"String","lastName":"String","name":"String","avatarUrl":"String"},"agentState":"Unknown","agentStateReason":"Unknown","tabs":[{}],"appSettings":{"enablePhoneNumberManagement":false,"enableDeviceManagement":false,"enableDialer":false,"enableCallHistory":false,"enableAssistants":false,"showFileNameInMessageCenter":false,"chakraTheme":"String","customCss":"String","pageTitle":"String","stringMappings":"String","logoutUrl":"String","portMyNumberUrl":"String"},"thirdPartyPhoneSystemSettings":{"type":"Demo","sipSettings":{"accounts":[{"number":"String","agent":"String","authName":"String","userName":"String","displayName":"String","password":"String","userDomain":"String","registrationExpires":0,"transportType":"UDP","localIP":"String","localPort":0,"sipServer":"String","sipServerPort":0,"outboundServer":"String","outboundServerPort":0,"stunServer":"String","stunPort":0,"audioPlaybackDeviceName":"String","audioRecordingDeviceName":"String","audioCodecs":["PCMU"],"dtmfMethod":"RFC2833"}]},"demoSettings":{"extension":"String"}}}