Removing Contacts / Removing Contacts from Groups
Description
When removing contacts from your Contacts List, or removing an existing Contact from a Contact Group, calls to the API must be made via URL:
http://www.webtext.com/api/remove_contact.html
https://www.webtext.com/api/remove_contact.html
Mandatory Parameters when removing a contact, or removing an existing contact from a group.
|
api_id |
This is your WebTEXT API id, unique to your WebTEXT account. Issued on request by WebTEXT (support@webtext.com). Note that this is NOT your WebTEXT user name. |
|
api_pwd |
API password, as issued to you by WebTEXT. |
|
remove_num |
The mobile phone number for this contact |
Optional Parameters when removing a contact, or adding an existing contact to a group.
|
group_alias |
This is an 8-digit numerical value, which can be found adjacent to the group in the WEBTEXT.COM web interface, under CONTACTS - CONTACT GROUPS |
Note: If you do not specify a value for group_alias, the contact will be completely removed from your Contact List.
To remove a contact completely from your WEBTEXT.COM Address Book, include only the remove_num parameter. This will automatically remove the Contact from all Contact Groups of which they are members, then remove the Contact itself.
To remove a contact from a group only, include the group_alias parameter.
Usage Example
This is a sample GET request, removing 353881234567 from my Contact List.
http://www.webtext.com/api/remove_contact.html?api_id=myid&api_pwd=mypwd&remove_num=353881234567
This is a sample GET request, removing 353881234567, from my Contact Group, alias 88812345
http://www.webtext.com/api/remove_contact.html?api_id=myid&api_pwd=mypwd&remove_num=353881234567&group_alias=88812345
A successful call to the API, to remove a Contact, will return the string: 000
An unsuccessful call will return a 3-digit error code, which can be found in the table 'RETURN CODES', at the end of this document.