v1

latestOpenAPI 3.0.32026-07-24156161.2 MB
User Groups
Get assigned campaigns

Use the Get assigned campaigns API method if you want to get the list of campaigns assigned to a specific user group. You should add the user group id as a variable.
get/groups/{id}/campaigns
Response

Successful operation
Example response

{
  "groupCampaigns": [
    {
      "advanced_call_fields": "[\"campaignleadid\"]",
      "agent_callerid_name": "a",
      "agent_callerid_number": "123123123",
      "amd_enabled": "0",
      "amd_max_duration": "5",
      "amd_settings": "[]",
      "auto_dial": "0",
      "auto_dial_delay": "0",
      "available_agent_search_timeout": "30",
      "campaign_type": "",
      "client_callerid_name": "c",
      "client_callerid_number": "12312313",
      "created_at": "2019-02-04 14:02:33",
      "creator_user_id": "1",
      "custom_call_fields": "[\"campaignleadid\",\"original_identifier\",\"phone_normalized\",\"country_name\"]",
      "default_answer_status": "46",
      "default_busy_status": "5",
      "default_direct_dial_status": "0",
      "default_error_status": "6",
      "default_fax_status": "0",
      "default_not_exists_status": "0",
      "default_permanent_expiration_days": "365",
      "default_remote_adapter_channel_id": "0",
      "default_timeout_status": "7",
      "default_voice_mail_status": "0",
      "default_weight": "0",
      "description": "test",
      "end_call_show_timeout": "5",
      "feedback_default_status": "0",
      "feedback_timeout": "300",
      "fetch_leads_type": "priority",
      "hide_voicemail_for_no_ratio_permanents": "0",
      "highest_priority_weight": "10000",
      "highest_priority_weight_ratio_level": "0",
      "id": "1",
      "iframe_call_fields": "[\"campaignleadid\"]",
      "is_active": "1",
      "is_caller_id_random": "1",
      "is_deleted": "0",
      "is_hold_enabled": "1",
      "min_weight": "0",
      "name": "Campaign_test1",
      "no_ratio_leads_fetching_method": "queue",
      "notify_user_about_online_lead": "0",
      "override_dropped_call_action": "0",
      "parent_id": null,
      "permanent_agent_offline_keepalive": "33",
      "permanent_callback_keepalive": "365",
      "permanent_daily_limit": "0",
      "permanent_expiration_active": "0",
      "permanent_total_limit": "0",
      "phone_mask_mode": "last",
      "predictive_call_ratio": "0",
      "predictive_call_timeout": "50",
      "predictive_fallback_action": "",
      "predictive_fallback_action_options": "1_playback.wav",
      "predictive_fallback_action_timeout": "31",
      "predictive_preservation_min_ringing_duration": "15",
      "predictive_ringing_preservation_ratio": "0",
      "redial_limit": "3",
      "remote_call_screen_enabled": "1",
      "remote_data_url": "https://test/customer/view/{lead_id}",
      "remote_javascript_code": "",
      "show_phone_symbols": "3",
      "speech_callback_data": "",
      "speech_callback_method": "POST",
      "speech_callback_url": "",
      "speech_country_languages": "",
      "speech_default_language": "en-US",
      "speech_languages": "[\"en-US\"]",
      "speech_min_recording_duration": "10",
      "speech_recognition_enabled": "1",
      "speech_recognition_leg": "both",
      "speech_recognition_statuses": null,
      "updated_at": "2021-11-11 10:04:51",
      "voice_mail_button_status": "0",
      "voicemail_button_hide_timeout": "40",
      "voicemail_time_options": "once"
    }
  ]
}