GET - Get power dialer campaign

Purpose

Use this API to get the power dialer campaign.

Authorization

HeaderKey	Description
Authorization*	Zoho-oauthtoken<space><ACCESS_TOKEN>
Accept*	Set to application/json.

Request URL

Method: GET

https://voice.zoho.com/rest/json/zv/api/powerdialer

Scope: ZohoVoice.powerdialer.READ

Parameters:

Param Name	Data Type	Description
campaign_id	Long	Represents the power dialer campaign ID.
from_index	Integer	Represents the starting index for retrieving records.
to_index	Integer	Represents the ending index up to which records are returned.
searchText	String	Represents the keyword used to search power dialer campaign by name.
searchStatus	String	Represents the status used to filter power dialer campaigns.
required_fields	JSONArray	Represents the list of required fields.
sort_by_field_name	String	Represents the field name used to sort the results.
is_asc	Boolean	Represents whether the data is sorted in ascending order.

Sample Request

Copiedcurl "https://voice.zoho.com/rest/json/zv/api/powerdialer" \
-X GET \
-H "Authorization:Zoho-oauthtoken *****"

Sample Response - Success

Copied{
  "code": "200",
  "records": [
    {
      "assign_user_name": "Alexander",
      "contact_upload_status": "success",
      "name": "Zoho Voice Camapign",
      "assign_user": "44385000000003005",
      "created_by_name": "Alexander",
      "created_by": "44385000000003005",
      "total_contact_count": 4,
      "campaign_id": "44385000000225001",
      "status": "not_started"
    },
    {
      "assign_user_name": "Alexander",
      "contact_upload_status": "success",
      "name": "Zoho Mail Camapign",
      "assign_user": "44385000000003005",
      "created_by_name": "Alexander",
      "created_by": "44385000000003005",
      "total_contact_count": 4,
      "campaign_id": "44385000000225001",
      "status": "not_started"
    }
  ],
  "status": "SUCCESS"
}

Sample Response - Error

Copied{
  "code": "ZVT0052",
  "message": "Unauthorized access.",
  "status": "ERROR"
}