Skip to main content

Add Phone Number

Attach a new phone number to a telephony configuration
1 min read
post/api/v1/organizations/telephony-configs/{config_id}/phone-numbers
Request example
Response
post/api/v1/organizations/telephony-configs/{config_id}/phone-numbers

Set inbound_workflow_id to bind incoming calls on this number to a specific agent — Menace Voice will register the inbound webhook with the provider and the response will include a provider_sync block reporting the result. Omit it to add the number for outbound use only.

The (provider, account_id, address) tuple must be globally unique across all Menace Voice organizations, since inbound dispatch keys on it. Attempting to add a number that another organization already owns returns 409.

Path parameters

config_idintegerrequired#

Headers

authorizationstring · null#
X-API-Keystring · null#

Body

application/json
addressstringrequired#

Length: 1–255

country_codestring · null#
Show child attributes
labelstring · null#
Show child attributes
inbound_workflow_idinteger · null#
Show child attributes
telephony_trunk_idinteger · null#
Show child attributes
is_activeboolean#

Default: true

is_default_caller_idboolean#

Default: false

extra_metadataobject#

Responses

application/json
Successful Response
idintegerrequired#
telephony_configuration_idintegerrequired#
addressstringrequired#
address_normalizedstringrequired#
address_typestringrequired#
country_codestring · null#
Show child attributes
labelstring · null#
Show child attributes
inbound_workflow_idinteger · null#
Show child attributes
inbound_workflow_namestring · null#
Show child attributes
telephony_trunk_idinteger · null#
Show child attributes
is_activebooleanrequired#
is_default_caller_idbooleanrequired#
extra_metadataobjectrequired#
created_atstringrequired#
updated_atstringrequired#
provider_syncobject · null#
Show child attributes