List dialer phone fields

GET 
/:organization_id/dialer_phone_fields

Returns a paginated list of dialer phone fields for the organization

Request

Query Parameters

page integer
Default value: 1
per_page integer
Default value: 20
sort_by string

Possible values: [created_at, updated_at, name, label, order]

sort_order string
Possible values: [asc, desc]
Default value: desc
dialer_campaign_id integer

Responses

200

Success response

application/json

Schema

Schema

data object[]
Array [
idinteger
organization_idinteger
dialer_campaign_idinteger
schedule_idintegernullable
orderinteger
Display order of the field
namestring
Internal name of the field
labelstring
Display label of the field
supports_smsboolean
Whether this phone field supports SMS
created_atdate-time
updated_atdate-time
]
meta object
total_countinteger
total_pagesinteger
current_pageinteger

Example (auto)

{
  "data": [
    {
      "id": 0,
      "organization_id": 0,
      "dialer_campaign_id": 0,
      "schedule_id": 0,
      "order": 0,
      "name": "string",
      "label": "string",
      "supports_sms": true,
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z"
    }
  ],
  "meta": {
    "total_count": 0,
    "total_pages": 0,
    "current_page": 0
  }
}

401

Unauthorized

403

Forbidden

Authorization: http

name: basicAuthtype: httpscheme: basicdescription: Basic Authentication using API Key ID and API Key.
- API Key ID is used as the username
- API Key is used as the password

• python
• nodejs
• ruby
• curl
• go
• php
• java
• powershell
• javascript
• rust

• HTTP.CLIENT
• REQUESTS

import http.client

conn = http.client.HTTPSConnection("cloud-staging.cloverhound.com")
payload = ''
headers = {
  'Accept': 'application/json',
  'Authorization': 'Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
}
conn.request("GET", "/:organization_id/dialer_phone_fields", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Request Collapse all

Auth

Username

Password

Parameters

page — query

per_page — query

sort_by — query

---created_atupdated_atnamelabelorder

sort_order — query

---ascdesc

dialer_campaign_id — query