CallGear

Setting up integration with CallGear virtual PBX

1. Go to Account management / Integrations ( available to the account owner or administrator). Click on Virtual PBX:

In the list that appears, click on Activate button.

2. Next a window will open, enter your CallGear login, password, and the virtual number you want to use for outgoing calls:

3.Set the employee extension numbers.

4.In your CallGear account, make sure the following options are activated for the integration to work: HTTP notifications, Call API Basic Set, Data API.

5. Allow access to the Call API and Data API from any IP address in your CallGear account:

6. Copy the Notification URL from the integration settings in Planfix:

Set up the following notifications in the Notifications section of your CallGear account.

1. Inbound call on a virtual phone number

{  
  "notification_mnemonic":{{notification_mnemonic}},
  "notification_name":{{notification_name}},
  "virtual_phone_number":{{virtual_phone_number}},
  "notification_time":{{notification_time}},
  "scenario_name": {{scenario_name}},
    "contact_phone_number":{{contact_phone_number}},
    "communication_number":{{communication_number}},
    "contact_id": {{contact_id}},
    "contact_full_name": {{contact_full_name}},
  "call_session_id":{{call_session_id}}
}

2. Call finished

{  
  "notification_name":{{notification_name}},
  "notification_mnemonic":{{notification_mnemonic}},
  "virtual_phone_number":{{virtual_phone_number}},
  "notification_time":{{notification_time}},
  "external_id": {{external_id}},
    "contact_phone_number":{{contact_phone_number}},
    "communication_number":{{communication_number}},
    "employee_full_name": {{employee_full_name}},
    "employee_id": {{employee_id}},
    "call_source": {{call_source}},
    "direction": {{direction}},
    "call_session_id":{{call_session_id}},
    "scenario_name": {{scenario_name}},
    "talk_time_duration": {{talk_time_duration}},
    "total_time_duration": {{total_time_duration}},
    "wait_time_duration": {{wait_time_duration}},
    "tag_names": {{tag_names}}
}

3. Call recording completed

{
  "notification_name": {{notification_name}},
  "notification_mnemonic":{{notification_mnemonic}},
  "virtual_phone_number": {{virtual_phone_number}},
  "notification_time": {{notification_time}},
  "scenario_name": {{scenario_name}},
    "contact_phone_number": {{contact_phone_number}},
    "communication_number": {{communication_number}},
    "contact_id": {{contact_id}},
    "contact_full_name": {{contact_full_name}},
  "call_session_id": {{call_session_id}},
    "employee_full_name": {{employee_full_name}},
    "employee_id": {{employee_id}},
    "file_link": {{file_link}},
    "file_duration": {{file_duration}},
  "tag_ids": {{tag_ids}},
  "tag_names": {{tag_names}}
}

4. Waiting for the answer

{  
  "notification_name":{{notification_name}},
  "notification_mnemonic":{{notification_mnemonic}},
  "virtual_phone_number": {{virtual_phone_number}},
  "notification_time":{{notification_time}},
  "external_id": {{external_id}},
    "contact_phone_number":{{contact_phone_number}},
    "contact_id": {{contact_id}},
    "employee_full_name": {{employee_full_name}},
    "employee_id": {{employee_id}},
  "call_source": {{call_source}},
  "call_session_id":{{call_session_id}},
  "direction": {{direction}},
  "leg_id": {{leg_id}}
}

5. Outbound call

{
  "notification_name": {{notification_name}},
  "notification_mnemonic":{{notification_mnemonic}},
  "virtual_phone_number": {{virtual_phone_number}},
  "notification_time": {{notification_time}},
    "contact_phone_number":{{contact_phone_number}},
    "contact_id":{{contact_id}},
    "contact_full_name":{{contact_full_name}},
  "call_session_id":{{call_session_id}},
    "employee_full_name":{{employee_full_name}},
    "employee_id":{{employee_id}},
    "employee_phone_number":{{employee_phone_number}}
}

6. Talk started

{  
  "notification_name":{{notification_name}},
  "notification_mnemonic":{{notification_mnemonic}},
  "virtual_phone_number": {{virtual_phone_number}},
  "notification_time":{{notification_time}},
  "external_id": {{external_id}},
    "contact_phone_number":{{contact_phone_number}},
    "contact_id": {{contact_id}},
    "employee_full_name": {{employee_full_name}},
    "employee_id": {{employee_id}},
  "call_source": {{call_source}},
  "call_session_id":{{call_session_id}},
  "direction": {{direction}},
  "leg_ids": {{leg_ids}}
}

7. Talk finished

{  
  "notification_name":{{notification_name}},
  "notification_mnemonic":{{notification_mnemonic}},
  "virtual_phone_number":{{virtual_phone_number}},
  "notification_time":{{notification_time}},
  "external_id": {{external_id}},
    "contact_phone_number":{{contact_phone_number}},
    "communication_number":{{communication_number}},
    "employee_full_name": {{employee_full_name}},
    "employee_id": {{employee_id}},
    "call_source": {{call_source}},
    "call_session_id":{{call_session_id}},
    "direction": {{direction}},
    "scenario_name": {{scenario_name}},
    "talk_time_duration": {{talk_time_duration}},
  "leg_ids": {{leg_ids}}
}

8. Lost call

{  
  "notification_name":{{notification_name}},
  "notification_mnemonic":{{notification_mnemonic}},
  "virtual_phone_number":{{virtual_phone_number}},
  "notification_time":{{notification_time}},
  "scenario_name": {{scenario_name}},
  "wait_time_duration" : {{wait_time_duration}},
  "employee_ids":{{employee_ids}},
    "contact_phone_number":{{contact_phone_number}},
    "communication_number":{{communication_number}},
    "contact_id": {{contact_id}},
    "contact_full_name":{{contact_full_name}},
  "call_session_id":{{call_session_id}}
}

Go To