Power Dialerの作成
このAPIを使用して、Power Dialerキャンペーンを作成します。
|
POST https://voice.zoho.com/rest/json/zv/api/powerdialer |
OAuthスコープ: ZohoVoice.powerdialer.CREATE
パラメーター
|
パラメーター名 |
データ型 |
説明 |
|
name |
string |
キャンペーン名 |
|
break_duration_secs |
int |
スヌーズ間隔 |
|
assign_users |
JSONArray |
Power Dialerに割り当てるユーザーID |
|
contactDetails * |
JSONArray |
[ { 'first_name':'ZohoVoice', 'mobile': ' ' } ] |
|
field_mapping * |
JSONObject |
{ 'defaultCC':'us' } |
レスポンス
成功
{
'code': '200',
'message': 'success',
'status': 'SUCCESS'
}
失敗
{
'code': 'ZVT0052',
'message': 'Unauthorized access.',
'status': 'ERROR'
}
Power Dialerの更新
このAPIを使用して、Power Dialerキャンペーンを更新します。
|
PUT https://voice.zoho.com/rest/json/zv/api/powerdialer |
OAuthスコープ:ZohoVoice.powerdialer.UPDATE
パラメーター
|
パラメーター名 |
データ型 |
説明 |
|
campaign_id * |
long |
Power DialerキャンペーンID |
|
name |
string |
キャンペーン名 |
|
break_duration_secs |
int |
スヌーズ間隔 |
|
assign_users |
JSONArray |
Power Dialerの割り当てユーザーID |
|
contactDetails * |
JSONArray |
[ { 'first_name':'ZohoVoice', 'mobile': ' ' } ] |
|
field_mapping * |
JSONObject |
{ 'defaultCC':'us' } |
レスポンス
成功
{
'code': '200',
'message': 'success',
'status': 'SUCCESS'
}
失敗
{
'code': 'ZVT0052',
'message': 'Unauthorized access.',
'status': 'ERROR'
}
Power Dialerの削除
このAPIを使用して、Power Dialerキャンペーンを削除します。
|
削除 https://voice.zoho.com/rest/json/zv/api/powerdialer |
OAuthスコープ: ZohoVoice.powerdialer.削除
パラメーター
|
パラメーター名 |
データ型 |
説明 |
|
campaign_id |
long |
Power DialerキャンペーンID |
|
campaign_ids |
JSONArray |
Power DialerキャンペーンIDの一覧 |
レスポンス
成功
{
'code': '200',
'データ': {
'44385000000225001': {
'reason': 'success',
'status': 'success'
}
},
'status': 'SUCCESS'
}
失敗
{
'code': 'ZVT0052',
'message': 'Unauthorized access.',
'status': 'ERROR'
}
Power Dialerの読み取り
このAPIを使用して、Power Dialerキャンペーンを読み取ります。
|
READ https://voice.zoho.com/rest/json/zv/api/powerdialer |
OAuthスコープ: ZohoVoice.powerdialer.READ
パラメーター
|
パラメーター名 |
データ型 |
説明 |
|
campaign_id |
long |
パワーダイヤラーのキャンペーンID |
|
from_index |
int |
取得開始インデックス |
|
to_index |
int |
取得終了インデックス |
|
searchText |
string |
パワーダイヤラー名を検索 |
|
searchStatus |
string |
パワーダイヤラーのステータスを検索 |
|
required_fields |
JSONArray |
必須項目を取得 |
|
sort_by_field_name |
string |
項目名で並べ替え |
|
is_asc |
boolean |
昇順でデータを取得 |
成功
{
'code': '200',
'データ': [
{
'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'
}
失敗
{
'code': 'ZVT0052',
'message': 'Unauthorized access.',
'status': 'ERROR'
}