Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Page Properties
labelapi_docs_CONTROLLERTAG
NameClients / Phone Numbers / Show
DescriptionDisplay a specific Phone Number for a specific Client
TypeGET
URL/v9/clients/:client_id/phone_numbers/:phone_number_id

...

Name
Description
Type
Presence
Location
client_idThe ID of the specific ClientIntegerrequiredURI
phone_number_idThe ID of the specific Phone NumberIntegerrequiredURI

 

...

Properties

Paste in Request Code
Name
Request
Description
Response
Type
 
Code Block
themeConfluence
languageruby
country_code
The country calling codeString|null
extension
Specific extension

String|null

idThe unique ID of this Phone NumberInteger
label
Arbitrary description, like 'home' or 'office'String|null
number
The phone numberString
updated_atLast updated timestampDate (ISO_8601)
urlThe unique URL for this clientString

Examples

Paste in Response Code
RequestResponse
GET /v9/clients/109402/phone_numbers/229514

Code Block
themeConfluence
language
ruby
js
{
    "country_code": "+1",
    "extension": "102",
    "id": "229514",
    "label": "Work",
    "number": "(480) 555-1212",
    "updated_at": "2014-08-08T21:39:51Z",
    "url": "/clients/109402/phone_numbers/229514"
}