API & DOCS

My Account

CONTACT GROUPS

Use the Contact Groups API to create and organize group contacts.

The Contact Groups API allows the user the ability to create and organize his or her contacts into groups. It enables the user to create and list groups according to their function, add and remove contacts, and add a list of phone numbers to different services.

The user may utilize the Contact Groups API with the Create, Details, Empty, List, Member Add, Member Remove, Remove, and Rename methods.

Create

group.create

Use the Create method to create a new group of contacts.

The parameters listed in the following table may be needed to complete this action:

PARAMETER	REQUIRED	OPTIONAL
API Key	X
Group Name	X

Details

group.details

Use the Details method to list the names, phone numbers, and email addresses for desired contact groups.

The parameters listed in the following table may be needed to complete this action:

PARAMETER	REQUIRED	OPTIONAL
API Key	X
Group ID	X

Empty

group.empty

Use the Empty method to clear all the contacts in a specified group.

The parameters listed in the following table may be needed to complete this action:

PARAMETER	REQUIRED	OPTIONAL
API Key	X
Group ID	X

List

group.list

Use the List method to list all user contact groups.

The parameters listed in the following table may be needed to complete this action:

PARAMETER	REQUIRED	OPTIONAL
API Key	X

Member Add

group.memberadd

Use the Member Add method to add a new contact to a contact group.

The parameters listed in the following table may be needed to complete this action:

PARAMETER	REQUIRED	OPTIONAL
API Key	X
Group ID	X
Member Email		X
Member Name	X
Member Phone	X
Members		X

Member Remove

group.memberremove

Use the Member Remove method to delete an entry in a contact group.

The parameters listed in the following table may be needed to complete this action:

PARAMETER	REQUIRED	OPTIONAL
API Key	X
Member ID	X

Remove

group.remove

Use the Remove method to delete an existing contact group.

The parameters listed in the following table may be needed to complete this action:

PARAMETER	REQUIRED	OPTIONAL
API Key	X
Group ID	X

Rename

group.rename

Use the Rename method to rename a contact group.

The parameters listed in the following table may be needed to complete this action:

PARAMETER	REQUIRED	OPTIONAL
API Key	X
Group ID	X
Name	X

API Test Panel

Use the DialogTech API Wizard and Test Panel to make changes to a customer account.

Please note that this tool works with the live data in a customer account. The user must be careful when adding, editing, or deleting data.

Example URLs

Create Example URL:

/ibp_api.php?api_key=foofoofoo&action=group.create&group_name=work

Details Example URL:

/ibp_api.php?api_key=foofoofoo&action=group.details&group_id=81

Empty Example URL:

/ibp_api.php?api_key=foofoofoo&action=group.empty&group_id=123

List Example URL:

/ibp_api.php?api_key=foofoofoo&action=group.list

Member Add Example URL:

/ibp_api.php?api_key=foofoofoo&action=group.memberadd&group_id=81&member_name=Jane%20Smith&member_phone=8475551234&[email protected]

Member Remove Example URL:

/ibp_api.php?api_key=foofoofoo&action=group.memberremove&member_id=261

Remove Example URL:

/ibp_api.php?api_key=foofoofoo&action=group.remove&group_id=82

Rename Example URL:

/ibp_api.php?api_key=foofoofoo&action=group.rename&group_id=123&name=Example%20Group

Example Responses

Create Example Response:

<response>
<result>success</result>
<result_description>Created group successfully</result_description>
<group_id>0000</group_id>
</response>

Details Example Response:

<response>
<result>success</result>
<result_description>success</result_description>
<group_details>
<member>
<member_id>123</member_id>
<member_name>John Doe</member_name>
<member_phone>8475551234</member_phone>
<member_email>[email protected]</member_email>
</member>
<member>
<member_id>456</member_id>
<member_name>Jane Smith</member_name>
<member_phone>3125554321</member_phone>
<member_email>[email protected]</member_email>
</member>
</group_details>
</response>

Empty Example Response:

<response>
<result>success</result>
<result_description>Emptied group successfully.</result_description>
<group_id>
</group_id>
</response>

List Example Response:

<response>
<result>success</result>
<result_description>success</result_description>
<group_list>
<group>
<group_id>81</group_id>
<group_name>dGroup</group_name>
<contact_count>1</contact_count>
</group>
<group>
<group_id>82</group_id>
<group_name>api test</group_name>
<contact_count>0</contact_count>
</group>
</group_list>
</response>

Member Add Example Response:

<response>
<result>success</result>
<result_description>Added member to group successfully.</result_description>
<member_id>261</member_id>
<group_id>81</group_id>
</response>

Member Remove Example Response:

<response>
<result>success</result>
<result_description>Removed member from group successfully.</result_description>
<member_id>261</member_id>
</response>

Remove Example Response:

<response>
<result>success</result>
<result_description>Removed group successfully.</result_description>
<group_id>82</group_id>
</response>

Rename Example Response:

<response>
<result>success</result>
<result_description>Renamed group successfully.</result_description>
<group_id>81</group_id>
</response>