Evo Voice

BuyPhoneNumber

Buys the specified phone number

**Requires Authentication**
Requires any of the roles:	SystemAdministrator, Manager, Customer

The following routes are available for this service:
POST	/endpoints/phone-numbers

**BuyPhoneNumber** Parameters:
Name	Parameter	Data Type	Required	Description
AccountId	body	string	No	The ID of the account to associate the number with
CustomerId	body	string	No	The ID of the customer to associate this number with
Number	body	string	No	The number to buy/create
IsVirtualPhoneNumber	body	bool	No	Is this number virtual? If so we will not buy but just create an entry
IsFaxNumber	body	bool	No	Is this a fax number?
AddressSid	body	string	No	The address SID to associate with the phone number
TagIds	body	List<string>	No	The list of tags to associate with the new endpoint
Data	body	Struct	No	Data values for this endpoint
FlowId	body	string	No	Specify the flow to use
FlowParams	body	Struct	No	The flow params

**Value** Parameters:
Name	Parameter	Data Type	Required
BoolValue	form	bool?	No
StringValue	form	string	No
NumberValue	form	double?	No
ListValue	form	List<Struct>	No
StructValue	form	Struct	No

**EndpointInfo** Parameters:
Name	Parameter	Data Type	Required	Description
AccountId	form	string	No	The account ID this endpoint is associated with
AccountName	form	string	No	The name of the account this endpoint is associated with
CustomerId	form	string	No	The ID of the customer this endpoint is associated with
CustomerName	form	string	No	The name of the customer this endpoint is associated with
ReferenceId	form	string	No	The third party reference ID for the endpoint
CustomerBreadcrumb	form	List<CustomerBreadcrumb>	No	The breadcrumb to the customer for this endpoint
DisplayName	form	string	No	The display name of the endpoint
Type	form	EndpointTypes	No	The type of endpoint
ExtraInformation	form	string	No	Extra info for this endpoint (typically to show in grid)
FlowId	form	string	No	The ID of the flow to use for voice
FlowName	form	string	No	The name of the flow to use for voice
FlowParams	form	Struct	No	The params for the voice flow
FlowSchedule	form	EndpointFlowSchedules	No	Whether to use a single flow always or use scheduled flow system
Schedule	form	Schedule	No	This endpoint's schedule
ScheduledFlows	form	List<ScheduledFlow>	No	The list of scheduled flows when using scheduling
DisableSms	form	bool	No	Disable SMS
UseExternal10DlcCampaign	form	bool	No	Set this to true to prevent Evo Voice from overriding the 10DLC / SMS settings for this number
IsVirtualPhoneNumber	form	bool	No	Is this a virtual phone number?
IsCallerIdVerified	form	bool	No	Is caller ID verified for this virtual number?
CallerIdVerificationCode	form	string	No	The verification code for this number
PhoneNumber	form	string	No	The phone number
PhoneNumberSid	form	string	No	The Sid of the phone number
CallerIdName	form	string	No	The caller ID Name (CNAM) for the phone number
AddressSid	form	string	No	The address SID associated with the phone number
DoNotTouchPhoneNumber	form	bool	No	Do not touch this phone number - for BYOA accounts
IsEnrolledIn10DlcService	form	bool	No	Is this number enrolled in a 10DLC messaging service campaign
EnableCallerIdLookup	form	bool	No	Whether we look up caller ID or not
UserEmailAddress	form	string	No	The email address of the user
SipRegion	form	TwilioSipRegions	No	The Twilio Region for the SIP endpoint
SipCredentialSid	form	string	No	The Twilio Sid of the credentials for Sip
SipUserName	form	string	No	The Twilio SIP user name
SipPassword	form	string	No	The Twilio SIP password
SipDomain	form	string	No	The SIP domain
EnableEmergencyCalling	form	bool	No	Is emergency calling enabled on this number?
EmergencyAddressSid	form	string	No	The SID of the emergency address for this number
EmergencyPhoneNumberId	form	string	No	The ID of the phone number to use for emergency dialing
AgentState	form	AgentStates	No	The current agent state of this user endpoint
AgentStateReason	form	AgentStateReasons	No	The current agent state reason of this user endpoint
UserMode	form	UserModes	No	The mode for this user
VoicemailGreetingId	form	string	No	The ID of the file to use for voicemail greeting
Data	form	Struct	No	The endpoint's data
EmailAddress	form	string	No	The email address for email endpoints
UserFirstName	form	string	No	The first name of the user (for user endpoints)
UserLastName	form	string	No	The last name of the user (for user endpoints)
AvatarUrl	form	string	No	The URL of an image for this user's avatar
ManagerRole	form	UserManagerRoles	No	Does this user have manager role?
DashboardPermissions	form	List<DashboardPermissions>	No	The list of dashboard permissions for when the manager role is custom
MyFieldPermissions	form	UserDataFieldModes	No	The type of visibility this user has to their own fields
CustomerFieldPermissions	form	UserDataFieldModes	No	The type of visibility this user has to customer fields
OtherUserFieldPermissions	form	UserDataFieldModes	No	The type of visibility this user has to other user fields
OtherEndpointFieldPermissions	form	UserDataFieldModes	No	The type of visibility this user has to other endpoint fields
Name	form	string	No	The name of this endpoint (for bots etc.)
Tags	form	List<Tag>	No	The list of tags for this endpoint
ActionUrls	form	List<EndpointActionUrl>	No	The list of action URLs
TeamMemberIds	form	List<string>	No	The list of members in this team
ContactListVisibility	form	CustomerVisibility	No	Visibility of this user/team in contact lists
Contacts	form	List<EndpointContact>	No	The list of contacts personal to this user
DocumoId	form	string	No	The documo ID for this number
IntegrationData	form	EntityIntegrationData	No	Integration data for this endpoint
ThirdPartyPhoneSystemSettings	form	ThirdPartyPhoneSystemSettings	No	Settings for third party phone system
OverrideAppSettings	form	bool	No	Should this user override the parent customer's app settings
AppSettings	form	AppSettings	No	App / Portal settings for this user
AssistantSettings	form	AssistantSettings	No	Configuration for the AI assistant
EmbedSettings	form	EmbedSettings	No	Configuration for the embed

**EntityInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No	The ID of the object
DateCreated	form	string	No	The date the object was created
DateLastModified	form	string	No	The date the object was last modified
CreatedBy	form	string	No	The user that created this object
LastModifiedBy	form	string	No	The user that last modified this object

**CustomerBreadcrumb** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No
Name	form	string	No

**EndpointTypes** Enum:
PhoneNumber
User
FaxNumber
EmailAddress
Unused_1
Unused_2
Unused_3
Unused_4
Unused_5
Team
Assistant

**EndpointFlowSchedules** Enum:
Always
Scheduled
Simple

**Schedule** Parameters:
Name	Parameter	Data Type	Required
TimeZoneId	form	string	No
Inherit	form	bool	No
ForceClosed	form	bool	No
Rules	form	List<SchedulingRule>	No
DefaultState	form	string	No

**SchedulingRule** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Name	form	string	No
Priority	form	int	No
State	form	string	No
Source	form	string	No
Condition	form	string	No
SimpleRuleType	form	SimpleSchedulingRuleTypes	No
CustomerState	form	string	No
FlowId	form	string	No
FlowParams	form	Struct	No
IsAllDay	form	bool	No
StartDate	form	string	No
StartTime	form	string	No
EndTime	form	string	No
BySetPosition	form	List<int>	No
ByMonth	form	List<int>	No
ByWeekNo	form	List<int>	No
ByYearDay	form	List<int>	No
ByMonthDay	form	List<int>	No
ByDay	form	List<ScheduleDay>	No
ByHour	form	List<int>	No
ByMinute	form	List<int>	No
Interval	form	int	No
Count	form	int	No
UntilDate	form	string	No
Frequency	form	SchedulingRuleFrequency	No

**SimpleSchedulingRuleTypes** Enum:
Always
CustomerState
Time

**ScheduleDay** Parameters:
Name	Parameter	Data Type	Required	Description
Offset	form	int	No
DayOfWeek	form	DayOfWeek	No

**SchedulingRuleFrequency** Enum:
None
Secondly
Minutely
Hourly
Daily
Weekly
Monthly
Yearly

**ScheduledFlow** Parameters:
Name	Parameter	Data Type	Required
StateName	form	string	No
FlowId	form	string	No
FlowParams	form	Struct	No

**TwilioSipRegions** Enum:
NorthAmericaVirginia
NorthAmericaOregon
EuropeIreland
EuropeFrankfurt
AsiaPacificSingapore
AsiaPacificTokyo
AsiaPacificSydney
SouthAmericaSanPaolo

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

**AgentStateReasons** Enum:
Unknown
SetByUser
MissedCall
SetBySystem

**UserModes** Enum:
SoftPhone
Sip
Flow
DataOnly
ThirdParty

**UserManagerRoles** Enum:
None
Manager
VoicemailAndCallHistory
Custom

**DashboardPermissions** Enum:
ViewFiles
ViewNotifications
ViewSessions
ViewEndpoints
ViewReports
ViewCustomers
ViewFlows

**UserDataFieldModes** Enum:
Hidden
ReadOnly
ReadWrite

**Tag** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Name	form	string	No
Color	form	TagColors	No

**TagColors** Enum:
Magenta
Red
Volcano
Orange
Gold
Lime
Green
Cyan
Blue
GeekBlue
Purple

**EndpointActionUrl** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Url	form	string	No
Method	form	ActionUrlHttpMethods	No

**ActionUrlHttpMethods** Enum:
GET
POST

**CustomerVisibility** Enum:
None
CurrentCustomer
CurrentAndChildCustomers

**EndpointContact** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
DisplayName	form	string	No
Address	form	string	No

**IntegrationData** Parameters:
Name	Parameter	Data Type	Required	Description
ThirdPartyId	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

**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

**AssistantSettings** Parameters:
Name	Parameter	Data Type	Required
CompanyName	form	string	No
Greeting	form	string	No
CompanyInformation	form	string	No
CustomPrompt	form	string	No
Voice	form	string	No
VoiceStyle	form	string	No
Tuning	form	AssistantTunings	No
Words	form	List<AssistantWord>	No
Links	form	List<AssistantLink>	No
Contacts	form	List<AssistantContact>	No
Integrations	form	List<AssistantIntegration>	No

**AssistantTunings** Enum:
Accuracy
Speed

**AssistantWord** Parameters:
Name	Parameter	Data Type	Required	Description
Word	form	string	No
Pronounced	form	string	No

**AssistantLink** Parameters:
Name	Parameter	Data Type	Required	Description
Url	form	string	No
Description	form	string	No

**AssistantContact** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
PhoneNumber	form	string	No
TransferType	form	AssistantTransferTypes	No
About	form	string	No
EmailAddress	form	string	No
TakeMessageFields	form	List<AssistantTakeMessageField>	No

**AssistantTransferTypes** Enum:
Blind
Supervised
MessagesOnly

**AssistantTakeMessageField** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Description	form	string	No
Required	form	bool	No

**AssistantIntegration** Parameters:
Name	Parameter	Data Type	Required
Uri	form	string	No
HttpMethod	form	string	No
AuthToken	form	string	No

**EmbedSettings** Parameters:
Name	Parameter	Data Type	Required	Description
Enabled	form	bool	No
AllowedHosts	form	string	No

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /endpoints/phone-numbers HTTP/1.1 
Host: team.evovoice.io 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"accountId":"String","customerId":"String","number":"String","isVirtualPhoneNumber":false,"isFaxNumber":false,"addressSid":"String","tagIds":["String"],"flowId":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"accountId":"String","accountName":"String","customerId":"String","customerName":"String","referenceId":"String","customerBreadcrumb":[{"id":"String","name":"String"}],"displayName":"String","type":"PhoneNumber","extraInformation":"String","flowId":"String","flowName":"String","flowSchedule":"Always","schedule":{"timeZoneId":"String","inherit":false,"forceClosed":false,"rules":[{"id":"String","name":"String","priority":0,"state":"String","source":"String","condition":"String","simpleRuleType":"Always","customerState":"String","flowId":"String","isAllDay":false,"startDate":"String","startTime":"String","endTime":"String","bySetPosition":[0],"byMonth":[0],"byWeekNo":[0],"byYearDay":[0],"byMonthDay":[0],"byDay":[{"offset":0,"dayOfWeek":"Sunday"}],"byHour":[0],"byMinute":[0],"interval":0,"count":0,"untilDate":"String","frequency":"None"}],"defaultState":"String"},"scheduledFlows":[{"stateName":"String","flowId":"String"}],"disableSms":false,"useExternal10DlcCampaign":false,"isVirtualPhoneNumber":false,"isCallerIdVerified":false,"callerIdVerificationCode":"String","phoneNumber":"String","phoneNumberSid":"String","callerIdName":"String","addressSid":"String","doNotTouchPhoneNumber":false,"isEnrolledIn10DlcService":false,"enableCallerIdLookup":false,"userEmailAddress":"String","sipRegion":"NorthAmericaVirginia","sipCredentialSid":"String","sipUserName":"String","sipPassword":"String","sipDomain":"String","enableEmergencyCalling":false,"emergencyAddressSid":"String","emergencyPhoneNumberId":"String","agentState":"Unknown","agentStateReason":"Unknown","userMode":"SoftPhone","voicemailGreetingId":"String","emailAddress":"String","userFirstName":"String","userLastName":"String","avatarUrl":"String","managerRole":"None","dashboardPermissions":["ViewFiles"],"myFieldPermissions":"Hidden","customerFieldPermissions":"Hidden","otherUserFieldPermissions":"Hidden","otherEndpointFieldPermissions":"Hidden","name":"String","tags":[{"id":"String","name":"String","color":"Magenta"}],"actionUrls":[{"id":"String","url":"String","method":"GET"}],"teamMemberIds":["String"],"contactListVisibility":"None","contacts":[{"id":"String","displayName":"String","address":"String"}],"documoId":"String","integrationData":{"String":{"thirdPartyId":"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"}},"overrideAppSettings":false,"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"},"assistantSettings":{"companyName":"String","greeting":"String","companyInformation":"String","customPrompt":"String","voice":"String","voiceStyle":"String","tuning":"Accuracy","words":[{"word":"String","pronounced":"String"}],"links":[{"url":"String","description":"String"}],"contacts":[{"name":"String","phoneNumber":"String","transferType":"Blind","about":"String","emailAddress":"String","takeMessageFields":[{"name":"String","description":"String","required":false}]}],"integrations":[{"uri":"String","httpMethod":"String","authToken":"String"}]},"embedSettings":{"enabled":false,"allowedHosts":"String"},"id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}