| Requires any of the roles: | SystemAdministrator, Manager, Customer | 
| PATCH | /phone-numbers/{endpointId}/fax | 
|---|
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| EndpointId | path | string | No | The ID of the endpoint | 
| IsFax | query | bool | No | Whether it's a fax or not? | 
| 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? | 
| ManagerAccess | form | UserManagerAccess | No | The read/write/delete access that the user has in the dashboard | 
| 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 | 
| 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 | 
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| Id | form | string | No | |
| Name | form | string | No | 
| PhoneNumber | |
| User | |
| FaxNumber | |
| EmailAddress | |
| Unused_1 | |
| Unused_2 | |
| Unused_3 | |
| Unused_4 | |
| Unused_5 | |
| Team | |
| Assistant | 
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| BoolValue | form | bool? | No | |
| StringValue | form | string | No | |
| NumberValue | form | double? | No | |
| ListValue | form | List<Struct> | No | |
| StructValue | form | Struct | No | 
| Always | |
| Scheduled | |
| Simple | 
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| TimeZoneId | form | string | No | |
| Inherit | form | bool | No | |
| ForceClosed | form | bool | No | |
| Rules | form | List<SchedulingRule> | No | |
| DefaultState | form | string | No | 
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| 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 | 
| Always | |
| CustomerState | |
| Time | 
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| Offset | form | int | No | |
| DayOfWeek | form | DayOfWeek | No | 
| None | |
| Secondly | |
| Minutely | |
| Hourly | |
| Daily | |
| Weekly | |
| Monthly | |
| Yearly | 
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| StateName | form | string | No | |
| FlowId | form | string | No | |
| FlowParams | form | Struct | No | 
| NorthAmericaVirginia | |
| NorthAmericaOregon | |
| EuropeIreland | |
| EuropeFrankfurt | |
| AsiaPacificSingapore | |
| AsiaPacificTokyo | |
| AsiaPacificSydney | |
| SouthAmericaSanPaolo | 
| Unknown | |
| Ready | |
| NotReady | |
| LoggedOut | |
| WrapUp | |
| Outgoing | |
| Other | 
| Unknown | |
| SetByUser | |
| MissedCall | |
| SetBySystem | 
| SoftPhone | |
| Sip | |
| Flow | |
| DataOnly | |
| ThirdParty | 
| None | |
| Manager | |
| VoicemailAndCallHistory | |
| Custom | 
| ReadOnly | |
| ReadWrite | |
| ReadWriteDelete | 
| ViewFiles | |
| ViewNotifications | |
| ViewSessions | |
| ViewEndpoints | |
| ViewReports | |
| ViewCustomers | |
| ViewFlows | |
| ViewCallCenter | 
| Hidden | |
| ReadOnly | |
| ReadWrite | 
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| Id | form | string | No | |
| Name | form | string | No | |
| Color | form | TagColors | No | 
| Magenta | |
| Red | |
| Volcano | |
| Orange | |
| Gold | |
| Lime | |
| Green | |
| Cyan | |
| Blue | |
| GeekBlue | |
| Purple | 
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| Id | form | string | No | |
| Url | form | string | No | |
| Method | form | ActionUrlHttpMethods | No | 
| GET | |
| POST | 
| None | |
| CurrentCustomer | |
| CurrentAndChildCustomers | 
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| Id | form | string | No | |
| DisplayName | form | string | No | |
| Address | form | string | No | 
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| ThirdPartyId | form | string | No | 
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| Type | form | ThirdPartyPhoneSystemTypes | No | |
| SipSettings | form | ThirdPartySipSettings | No | |
| DemoSettings | form | ThirdPartyDemoSettings | No | 
| Demo | |
| Sip | 
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| Accounts | form | List<ThirdPartySipAccountSettings> | No | 
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| 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 | 
| UDP | |
| TLS | |
| TCP | |
| PERS | 
| 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 | 
| RFC2833 | |
| INFO | 
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| Extension | form | string | No | 
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| 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 | 
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| 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 | 
| Accuracy | |
| Speed | 
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| Word | form | string | No | |
| Pronounced | form | string | No | 
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| Url | form | string | No | |
| Description | form | string | No | 
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| 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 | 
| Blind | |
| Supervised | |
| MessagesOnly | 
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| Name | form | string | No | |
| Description | form | string | No | |
| Required | form | bool | No | 
| Name | Parameter | Data Type | Required | Description | 
|---|---|---|---|---|
| Uri | form | string | No | |
| HttpMethod | form | string | No | |
| AuthToken | form | string | No | 
| 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 .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PATCH /phone-numbers/{endpointId}/fax HTTP/1.1 
Host: evovoice.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
	endpointId: String,
	isFax: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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,
	managerAccess: ReadOnly,
	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
}