Voiceflow bearer token
Phone Numbers
Connect phone numbers to your agents.
See Authentication for credentials and permissions.
Returns every phone number of one workspace in one response, or only those assigned to one project, each with the voice and sms targets it answers as.
Authentication
Query parameters
List only the numbers assigned to this project, for either target. Mutually exclusive with workspaceID.
List every number the workspace holds, assigned or not. Mutually exclusive with projectID.
Response
Returns the phone numbers, each with its name, value, provider, and the voice and sms targets that name the project, environment, and version it is assigned to (null when a side is unassigned).
The matching phone numbers, each with the project, environment and version its voice and sms sides reach.
Adds a phone number to a workspace, either by buying one through Voiceflow or by connecting a number you already own with its provider credentials. A new number is assigned to nothing and answers nothing until you assign it.
Authentication
Voiceflow bearer token
Request body
Response
Returns the new phone number with its ID, value, and provider. Its voice and sms targets are null because it is not assigned to a project yet.
Returns one phone number with its provider and the targets each side answers as. The phoneNumberID is the ID Voiceflow gives the number, not the number itself.
Authentication
Voiceflow bearer token
Path parameters
The ID of the phone number to operate on.
Query parameters
The ID of the workspace the number belongs to.
Response
Returns the phone number with its name, value, provider, and the voice and sms targets naming the project, environment, and version each side answers as.
Renames a phone number. The name is a label shown in the workspace; it does not change the number, its provider, or where it routes.
Authentication
Voiceflow bearer token
Path parameters
The ID of the phone number to operate on.
Query parameters
The ID of the workspace the number belongs to.
Request body
The display name of the number within the workspace. Callers never see it.
Response
Confirms the phone number was updated. The body is a message only, so refetch the phone number to see its new name.
A human-readable message confirming the update.
Removes a phone number from the workspace, so it stops answering calls and messages; unassign it instead to keep the number. The response carries only a confirmation message, so refetch the phone numbers to see what is left.
Authentication
Voiceflow bearer token
Path parameters
The ID of the phone number to operate on.
Query parameters
The ID of the workspace the number belongs to.
Response
Confirms the phone number was deleted. The body is a message only, so list the workspace's phone numbers to see the ones you still hold.
A human-readable message confirming the deletion.
Points the voice side or the SMS side of a phone number at a project, optionally pinning an environment and a version. Only the side named by target changes, so moving a number that uses both sides takes one call per side.
Authentication
Voiceflow bearer token
Path parameters
The ID of the phone number to operate on.
Query parameters
The ID of the workspace the number belongs to.
Request body
Which side of the number to point at the project: voice for incoming calls, sms for incoming SMS. The other side is left as it was.
sms, voiceWhich version of the environment answers: published, the one serving live traffic, or draft, the working copy. Requires environmentAlias. Defaults to published.
draft, publishedThe ID of the project the number should reach.
The alias of the environment that should answer (e.g. main). Omit it to assign the number to the project without pinning an environment, which also clears a pin a previous assign set.
Response
Confirms the phone number was assigned. The body is a message only, so refetch the phone number to see the voice or sms target it now answers as.
A human-readable message confirming the update.
Clears the assignment of a phone number so it stops reaching an agent, while the number stays on the workspace. Naming a target clears that side, and leaving it out clears both.
Authentication
Voiceflow bearer token
Path parameters
The ID of the phone number to operate on.
Query parameters
The ID of the workspace the number belongs to.
Request body
Which side of the number to clear: voice or sms. Omit it to clear both. Clearing a side that is not assigned is refused.
sms, voiceResponse
Confirms the assignment was cleared. The body is a message only, so refetch the phone number to see which sides are now unassigned.
A human-readable message confirming the update.