Evo Voice

<back to all web services

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:
NameParameterData TypeRequiredDescription
AccountIdbodystringNoThe ID of the account to associate the number with
CustomerIdbodystringNoThe ID of the customer to associate this number with
NumberbodystringNoThe number to buy/create
IsVirtualPhoneNumberbodyboolNoIs this number virtual? If so we will not buy but just create an entry
IsFaxNumberbodyboolNoIs this a fax number?
AddressSidbodystringNoThe address SID to associate with the phone number
TagIdsbodyList<string>NoThe list of tags to associate with the new endpoint
DatabodyStructNoData values for this endpoint
FlowIdbodystringNoSpecify the flow to use
FlowParamsbodyStructNoThe flow params
Value Parameters:
NameParameterData TypeRequiredDescription
BoolValueformbool?No
StringValueformstringNo
NumberValueformdouble?No
ListValueformList<Struct>No
StructValueformStructNo
EndpointInfo Parameters:
NameParameterData TypeRequiredDescription
AccountIdformstringNoThe account ID this endpoint is associated with
AccountNameformstringNoThe name of the account this endpoint is associated with
CustomerIdformstringNoThe ID of the customer this endpoint is associated with
CustomerNameformstringNoThe name of the customer this endpoint is associated with
ReferenceIdformstringNoThe third party reference ID for the endpoint
CustomerBreadcrumbformList<CustomerBreadcrumb>NoThe breadcrumb to the customer for this endpoint
DisplayNameformstringNoThe display name of the endpoint
TypeformEndpointTypesNoThe type of endpoint
ExtraInformationformstringNoExtra info for this endpoint (typically to show in grid)
FlowIdformstringNoThe ID of the flow to use for voice
FlowNameformstringNoThe name of the flow to use for voice
FlowParamsformStructNoThe params for the voice flow
FlowScheduleformEndpointFlowSchedulesNoWhether to use a single flow always or use scheduled flow system
ScheduleformScheduleNoThis endpoint's schedule
ScheduledFlowsformList<ScheduledFlow>NoThe list of scheduled flows when using scheduling
DisableSmsformboolNoDisable SMS
UseExternal10DlcCampaignformboolNoSet this to true to prevent Evo Voice from overriding the 10DLC / SMS settings for this number
IsVirtualPhoneNumberformboolNoIs this a virtual phone number?
IsCallerIdVerifiedformboolNoIs caller ID verified for this virtual number?
CallerIdVerificationCodeformstringNoThe verification code for this number
PhoneNumberformstringNoThe phone number
PhoneNumberSidformstringNoThe Sid of the phone number
CallerIdNameformstringNoThe caller ID Name (CNAM) for the phone number
AddressSidformstringNoThe address SID associated with the phone number
DoNotTouchPhoneNumberformboolNoDo not touch this phone number - for BYOA accounts
IsEnrolledIn10DlcServiceformboolNoIs this number enrolled in a 10DLC messaging service campaign
EnableCallerIdLookupformboolNoWhether we look up caller ID or not
UserEmailAddressformstringNoThe email address of the user
SipRegionformTwilioSipRegionsNoThe Twilio Region for the SIP endpoint
SipCredentialSidformstringNoThe Twilio Sid of the credentials for Sip
SipUserNameformstringNoThe Twilio SIP user name
SipPasswordformstringNoThe Twilio SIP password
SipDomainformstringNoThe SIP domain
EnableEmergencyCallingformboolNoIs emergency calling enabled on this number?
EmergencyAddressSidformstringNoThe SID of the emergency address for this number
EmergencyPhoneNumberIdformstringNoThe ID of the phone number to use for emergency dialing
AgentStateformAgentStatesNoThe current agent state of this user endpoint
AgentStateReasonformAgentStateReasonsNoThe current agent state reason of this user endpoint
UserModeformUserModesNoThe mode for this user
VoicemailGreetingIdformstringNoThe ID of the file to use for voicemail greeting
DataformStructNoThe endpoint's data
EmailAddressformstringNoThe email address for email endpoints
UserFirstNameformstringNoThe first name of the user (for user endpoints)
UserLastNameformstringNoThe last name of the user (for user endpoints)
AvatarUrlformstringNoThe URL of an image for this user's avatar
ManagerRoleformUserManagerRolesNoDoes this user have manager role?
DashboardPermissionsformList<DashboardPermissions>NoThe list of dashboard permissions for when the manager role is custom
MyFieldPermissionsformUserDataFieldModesNoThe type of visibility this user has to their own fields
CustomerFieldPermissionsformUserDataFieldModesNoThe type of visibility this user has to customer fields
OtherUserFieldPermissionsformUserDataFieldModesNoThe type of visibility this user has to other user fields
OtherEndpointFieldPermissionsformUserDataFieldModesNoThe type of visibility this user has to other endpoint fields
NameformstringNoThe name of this endpoint (for bots etc.)
TagsformList<Tag>NoThe list of tags for this endpoint
ActionUrlsformList<EndpointActionUrl>NoThe list of action URLs
TeamMemberIdsformList<string>NoThe list of members in this team
ContactListVisibilityformCustomerVisibilityNoVisibility of this user/team in contact lists
ContactsformList<EndpointContact>NoThe list of contacts personal to this user
DocumoIdformstringNoThe documo ID for this number
IntegrationDataformEntityIntegrationDataNoIntegration data for this endpoint
ThirdPartyPhoneSystemSettingsformThirdPartyPhoneSystemSettingsNoSettings for third party phone system
OverrideAppSettingsformboolNoShould this user override the parent customer's app settings
AppSettingsformAppSettingsNoApp / Portal settings for this user
EntityInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNoThe ID of the object
DateCreatedformstringNoThe date the object was created
DateLastModifiedformstringNoThe date the object was last modified
CreatedByformstringNoThe user that created this object
LastModifiedByformstringNoThe user that last modified this object
CustomerBreadcrumb Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
EndpointTypes Enum:
PhoneNumber
User
FaxNumber
EmailAddress
Unused_1
Unused_2
Unused_3
Unused_4
Unused_5
Team
EndpointFlowSchedules Enum:
Always
Scheduled
Simple
Schedule Parameters:
NameParameterData TypeRequiredDescription
TimeZoneIdformstringNo
InheritformboolNo
ForceClosedformboolNo
RulesformList<SchedulingRule>No
DefaultStateformstringNo
SchedulingRule Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
PriorityformintNo
StateformstringNo
SourceformstringNo
ConditionformstringNo
SimpleRuleTypeformSimpleSchedulingRuleTypesNo
CustomerStateformstringNo
FlowIdformstringNo
FlowParamsformStructNo
IsAllDayformboolNo
StartDateformstringNo
StartTimeformstringNo
EndTimeformstringNo
BySetPositionformList<int>No
ByMonthformList<int>No
ByWeekNoformList<int>No
ByYearDayformList<int>No
ByMonthDayformList<int>No
ByDayformList<ScheduleDay>No
ByHourformList<int>No
ByMinuteformList<int>No
IntervalformintNo
CountformintNo
UntilDateformstringNo
FrequencyformSchedulingRuleFrequencyNo
SimpleSchedulingRuleTypes Enum:
Always
CustomerState
Time
ScheduleDay Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
DayOfWeekformDayOfWeekNo
SchedulingRuleFrequency Enum:
None
Secondly
Minutely
Hourly
Daily
Weekly
Monthly
Yearly
ScheduledFlow Parameters:
NameParameterData TypeRequiredDescription
StateNameformstringNo
FlowIdformstringNo
FlowParamsformStructNo
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:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
ColorformTagColorsNo
TagColors Enum:
Magenta
Red
Volcano
Orange
Gold
Lime
Green
Cyan
Blue
GeekBlue
Purple
EndpointActionUrl Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
UrlformstringNo
MethodformActionUrlHttpMethodsNo
ActionUrlHttpMethods Enum:
GET
POST
CustomerVisibility Enum:
None
CurrentCustomer
CurrentAndChildCustomers
EndpointContact Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
DisplayNameformstringNo
AddressformstringNo
IntegrationData Parameters:
NameParameterData TypeRequiredDescription
ThirdPartyIdformstringNo
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
AppSettings Parameters:
NameParameterData TypeRequiredDescription
EnablePhoneNumberManagementformboolNo
EnableDeviceManagementformboolNo
EnableDialerformboolNo
EnableCallHistoryformboolNo
ShowFileNameInMessageCenterformboolNo
ChakraThemeformstringNo
CustomCssformstringNo
PageTitleformstringNo
StringMappingsformstringNo
LogoutUrlformstringNo
PortMyNumberUrlformstringNo

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: 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"],"data":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}}},"flowId":"String","flowParams":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}}}}

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","flowParams":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}}},"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","flowParams":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}}},"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","flowParams":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}}}}],"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","data":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}],"structValue":{"String":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]}}}}}},"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,"showFileNameInMessageCenter":false,"chakraTheme":"String","customCss":"String","pageTitle":"String","stringMappings":"String","logoutUrl":"String","portMyNumberUrl":"String"},"id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}