Welcome to Portal

?Unknown\pull-down

Welcome to Zoho Cares

Bienvenido a Soporte de Zoho

Search our knowledge base, ask the community or submit a request.

Power Dialer API

Create Power Dialer

Use this API to create Power Dialer campaign.

 

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

 

OAuth Scope: ZohoVoice.powerdialer.CREATE

 

Parameters

 

Param Name

DataType

Description

name

string

campaign name

break_duration_secs

int

snooze interval

assign_user

long

power dialer assign user id

contactDetails *

JSONArray

[

{

"first_name":"ZohoVoice",

"mobile": " "

}

]

field_mapping *

JSONObject

{

"defaultCC":"us"

}

 

 

Response

 

SUCCESS

{

    "code": "200",

    "message": "success",

    "status": "SUCCESS"

}

 

FAILURE

{

    "code": "ZVT0052",

    "message": "Unauthorized access.",

    "status": "ERROR"

}

 


Update Power Dialer


Use this API to update the power dialer campaign.

 

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

 

OAuth Scope: ZohoVoice.powerdialer.UPDATE

 

Parameters

 

Param Name

DataType

Description

campaign_id *

long

power dialer campaign id

name

string

campaign name

break_duration_secs

int

snooze interval

assign_user

long

power dialer assign iser

contactDetails *

JSONArray

[

{

"first_name":"ZohoVoice",

"mobile": " "

}

]

field_mapping *

JSONObject

{

"defaultCC":"us"

}

 

 

Response

 

SUCCESS

{

   "code": "200",

   "message": "success",

   "status": "SUCCESS"

}

 

FAILURE

{

   "code": "ZVT0052",

   "message": "Unauthorized access.",

   "status": "ERROR"

}

 


Delete Power Dialer

 

Use this API to delete the power dialer campaign.

 

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

 

OAuth Scope: ZohoVoice.powerdialer.DELETE

 

Parameters

 

Param Name

DataType

Description

campaign_id

long

power dialer campaign id

campaign_ids

JSONArray

power dialer campaign ids

 

Response

 

SUCCESS

{

   "code": "200",

   "records": {

       "44385000000225001": {

           "reason": "success",

           "status": "success"

       }

   },

   "status": "SUCCESS"

}

 

FAILURE

{

    "code": "ZVT0052",

    "message": "Unauthorized access.",

    "status": "ERROR"
}

 


READ Power Dialer

 

Use this API to read the power dialer campaign.

 

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

 

OAuth Scope: ZohoVoice.powerdialer.READ

 

Parameters

 

Param Name

DataType

Description

campaign_id

long

power dialer campaign id

from_index

int

get from index

to_index

int

get up to index

searchText

string

search power dialer name

searchStatus

string

search power dialer status

required_fields

JSONArray

get required fields

sort_by_field_name

string

sort by field name

is_asc

boolean

get data from ascending order

 

SUCCESS

{

   "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"

}

 

FAILURE

{

    "code": "ZVT0052",

    "message": "Unauthorized access.",

    "status": "ERROR"
}

 


Helpful?00
Updated: 1 month ago
Share :