Evo Voice

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:
Name	Parameter	Data Type	Required	Description
EndpointId	query	string	No	The endpoint whose config you want to get (this must be a User)
EndpointEmailAddress	query	string	No	The endpoint email address whose config you want to get (this must be a User) - EndpointId takes priority over this
DeviceType	query	DeviceTypes	No	The type of device you are requesting config for
PushCredentialSid	query	string	No	Use a specific push credential SID
ApplicationSid	query	string	No	Use a specific application SID
Sandbox	query	bool	No	Is this device operating in a sandbox environment? IOS only.

**DeviceTypes** Enum:
Web
iOS
Android

**AppConfig** Parameters:
Name	Parameter	Data Type	Required	Description
EndpointId	form	string	No	The ID of this endpoint
AccountId	form	string	No	The ID of the account
CustomerId	form	string	No	The customer ID associated with this user
AccessToken	form	string	No	The access token for use with Twilio Voice
Identity	form	string	No	The access token's identity
EmailAddress	form	string	No	The email address of the user
UserInfo	form	AppUserInfo	No	The user's information
AgentState	form	AgentStates	No	The agent state (for call center users)
AgentStateReason	form	AgentStateReasons	No	The agent state reason
Tabs	form	List<Object>	No	The tabs for the app
AppSettings	form	AppSettings	No	The app settings
ThirdPartyPhoneSystemSettings	form	ThirdPartyPhoneSystemSettings	No	The phone settings for third party connectivity

**AppUserInfo** Parameters:
Name	Parameter	Data Type	Required	Description
FirstName	form	string	No	The user's first name
LastName	form	string	No	The user's last name
Name	form	string	No	Shortcut to the user's full name
AvatarUrl	form	string	No	The URL to the user's avatar

**AgentStates** Enum:
Unknown
Ready
NotReady
LoggedOut
WrapUp
Outgoing
Other

**AgentStateReasons** Enum:
Unknown
SetByUser
MissedCall
SetBySystem

**AppSettings** Parameters:
Name	Parameter	Data Type	Required
EnablePhoneNumberManagement	form	bool	No
EnableDeviceManagement	form	bool	No
EnableDialer	form	bool	No
EnableCallHistory	form	bool	No
EnableAssistants	form	bool	No
ShowFileNameInMessageCenter	form	bool	No
ChakraTheme	form	string	No
CustomCss	form	string	No
PageTitle	form	string	No
StringMappings	form	string	No
LogoutUrl	form	string	No
PortMyNumberUrl	form	string	No

**ThirdPartyPhoneSystemSettings** Parameters:
Name	Parameter	Data Type	Required
Type	form	ThirdPartyPhoneSystemTypes	No
SipSettings	form	ThirdPartySipSettings	No
DemoSettings	form	ThirdPartyDemoSettings	No

**ThirdPartyPhoneSystemTypes** Enum:
Demo
Sip

**ThirdPartySipSettings** Parameters:
Name	Parameter	Data Type	Required	Description
Accounts	form	List<ThirdPartySipAccountSettings>	No

**ThirdPartySipAccountSettings** Parameters:
Name	Parameter	Data Type	Required
Number	form	string	No
Agent	form	string	No
AuthName	form	string	No
UserName	form	string	No
DisplayName	form	string	No
Password	form	string	No
UserDomain	form	string	No
RegistrationExpires	form	int	No
TransportType	form	TransportTypes	No
LocalIP	form	string	No
LocalPort	form	int	No
SipServer	form	string	No
SipServerPort	form	int	No
OutboundServer	form	string	No
OutboundServerPort	form	int	No
StunServer	form	string	No
StunPort	form	int	No
AudioPlaybackDeviceName	form	string	No
AudioRecordingDeviceName	form	string	No
AudioCodecs	form	List<AudioCodecTypes>	No
DTMFMethod	form	DtmfMethods	No

**TransportTypes** Enum:
UDP
TLS
TCP
PERS

**AudioCodecTypes** Enum:
Name	Value
PCMU	0
GSM	3
PCMA	8
G722	9
G729	18
ILBC	97
AMR	98
AMRWB	99
SPEEX	100
DTMF	101
SPEEXWB	102
ISACWB	103
ISACSWB	104
OPUS	105
G7221	121
NONE	-1

**DtmfMethods** Enum:
RFC2833
INFO

**ThirdPartyDemoSettings** Parameters:
Name	Parameter	Data Type	Required	Description
Extension	form	string	No

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

HTTP + JSV

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/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}