This API lets you manage the phone numbers in your Zendesk voice account. See Managing Zendesk Talk lines in Zendesk help. You can also use it to search for available phone numbers.
JSON Format
Phone numbers are represented as JSON objects with the following properties:
Name
Type
Read-only
Mandatory
Description
call_recording_consent
string
false
false
What call recording consent is set to
capabilities
object
false
false
Whether a phone number has mms, sms, or voice capability. See the Capabilities section below.
The id and any settings associated with each greeting category. If the category has no settings, it defaults to the category name. See Managing outgoing greetings in the Talk Help Center
country_code
string
true
false
The ISO code of the country for this number
created_at
string
true
false
The date and time the phone number was created
default_greeting_ids
array
true
false
The names of default system greetings associated with the phone number. See Managing outgoing greetings in the Talk Help Center
default_group_id
integer
false
false
Default group id. *Writeable on most of the plans.
An array of associated groups. *Writeable on most of plans.
id
integer
true
false
Automatically assigned upon creation
ivr_id
integer
false
false
ID of IVR associated with the phone number
line_type
string
false
false
The type of line associated with the phone number
location
string
true
false
The number's geographical location. For example, "CA" or "Leeds"
name
string
true
false
The nickname if one is set. Otherwise the display_number
nickname
string
false
false
The nickname of the number if one is set
number
string
true
false
The phone number digits
outbound_enabled
boolean
false
false
Whether or not the phone number has outbound enabled
priority
integer
false
false
Level of priority associated with the phone number
recorded
boolean
false
false
Whether calls for the number are recorded or not
schedule_id
integer
false
false
ID of schedule associated with the phone number
sms_enabled
boolean
false
false
Whether or not the phone number has sms enabled
sms_group_id
integer
false
false
The group associated with this phone number
token
string
false
false
A generated token, unique for each phone number and used when provisioning the number. *Writeable on create only.
toll_free
boolean
true
false
Whether the number is toll-free or local
transcription
boolean
false
false
Whether calls for the number are transcribed or not
voice_enabled
boolean
false
false
Whether or not the phone number has voice enabled
Capabilities
Name
Type
Read-only
Mandatory
Description
sms
boolean
true
false
Whether phone number has sms capability
mms
boolean
true
false
Whether phone number has mms capability
voice
boolean
true
false
Whether phone number has voice capability
emergency_address
boolean
true
false
Whether the phone number can be associated with an emergency address
Example
{"capabilities":{"emergency_address":false,"mms":false,"sms":true,"voice":true},"categorised_greetings":{"1":"voicemail_en","2":"available_en"},"categorised_greetings_with_sub_settings":{"1":{"voicemail_off_inside_business_hours":"voicemail_en_voicemail_config,","voicemail_off_outside_business_hours":"voicemail_en_voicemail_config","voicemail_on_inside_business_hours":"voicemail_en,"},"2":{"voicemail_off":"available_en_voicemail_config","voicemail_on":"available_en,"}},"country_code":"US","created_at":"2013-04-13T16:02:33Z","default_greeting_ids":["voicemail_en","available_jp"],"default_group_id":1,"display_number":"+353 76 680 1402","external":false,"greeting_ids":[1,2],"group_ids":[1,2],"id":6,"location":"TX","name":"Awesome Support Line","nickname":"Awesome Support Line","number":"+353766801402","recorded":true,"sms_group_id":7,"toll_free":false,"transcription":false}
List Phone Numbers
GET /api/v2/channels/voice/phone_numbers
Allowed For
Agents
Minimizing the results
You can reduce the number of properties per phone number in the response with the minimal_mode=true query string parameter.
GET /api/v2/channels/voice/phone_numbers/search?country={country}
Returns available phone numbers.
This endpoint is not available for Trial accounts.
Allowed For
Agents
JSON Format of Available Phone Numbers
Name
Type
Comments
number
string
The phone number digits
display_number
string
The formatted phone number
toll_free
boolean
Whether the number is toll-free or local
location
string
The number's geographical location. For example, "CA" or "Leeds"
country_code
string
The ISO code of the country for the phone number
token
string
A generated token unique for each phone number and used when provisioning the number
price
string
The monthly cost of the phone number
address_requirements
string
The type of address that must be supplied when purchasing the phone number (based on specific country regulations). Possible values: "none", "local", "any", or "foreign"
Creates a Talk phone number from an available phone number. The available phone number is specified by a token returned by a search for available numbers. See Search for Available Phone Numbers.
Allowed For
Agents
This endpoint is not available for Trial accounts.