Contacts API
Manage your groups (create, modify or delete groups) and contacts with our API for contacts.
Create group with SQL Server
sp_configure 'show advanced options', 1;
GO
RECONFIGURE;
GO
sp_configure 'Ole Automation Procedures', 1;
GO
RECONFIGURE;
GO
DECLARE @class varchar(500) = 'group';
DECLARE @method varchar(500) = 'creategroup';
DECLARE @user varchar(500) = 'user';
DECLARE @password varchar(500) = 'password';
DECLARE @name varchar(500) = 'test name';
DECLARE @type varchar(500) = 'mobile';
DECLARE @fields varchar(500) = 'mobile,name,address';
DECLARE @url varchar(255) = 'https://www.afilnet.com/api/http/?class='+@class+'&method='+@method+'&user='+@user+'&password='+@password+'&name='+@name+'&type='+@type+'&fields='+@fields;
DECLARE @win int
DECLARE @hr int
DECLARE @text varchar(8000)
EXEC @hr=sp_OACreate 'WinHttp.WinHttpRequest.5.1',@win OUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win, 'Open',NULL,'GET',@url,'false'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win,'Send'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAGetProperty @win,'ResponseText',@text OUTPUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OADestroy @win
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win| Parameter | Description | Compulsory / Optional |
|---|---|---|
| class=group | Class requested: Class to which the request is made | Compulsory |
| method=creategroup | Class method requested: Method of the class to which the request is made | Compulsory |
| user | User and e-mail of your Afilnet account | Compulsory |
| password | Password of your Afilnet account | Compulsory |
| name | Name of the group | Compulsory |
| type | Type of group (email or mobile) | Compulsory |
| fields | List of fields separated by commas. It's compulsory to include a mobile field if type=mobile and an email field if type = email | Compulsory |
Answer:
- status
-
result (if status=success), here you will receive the following values:
- No additional values will be sent to you
- error (if status=error), here you will receive the error code
Error codes:
| Code | Description |
|---|---|
| MISSING_USER | User or email not included |
| MISSING_PASSWORD | Password not included |
| MISSING_CLASS | Class not included |
| MISSING_METHOD | Method not included |
| MISSING_COMPULSORY_PARAM | Compulsory parameter not included |
| INCORRECT_USER_PASSWORD | Incorrect user or password |
| INCORRECT_CLASS | Incorrect class |
| INCORRECT_METHOD | Incorrect method |
| INCORRECT_TYPE | Incorrect type. The type must be mobile or email |
| MISSING_MAIN_FIELD | Main field missing (mobile if type = mobile or email if type = email) |
Get field of a group with SQL Server
sp_configure 'show advanced options', 1;
GO
RECONFIGURE;
GO
sp_configure 'Ole Automation Procedures', 1;
GO
RECONFIGURE;
GO
DECLARE @class varchar(500) = 'group';
DECLARE @method varchar(500) = 'getgroupcolumns';
DECLARE @user varchar(500) = 'user';
DECLARE @password varchar(500) = 'password';
DECLARE @idgroup varchar(500) = '1000';
DECLARE @url varchar(255) = 'https://www.afilnet.com/api/http/?+'&class='+@class+'&method='+@method+'&user='+@user+'&password='+@password+'&idgroup='+@idgroup;
DECLARE @win int
DECLARE @hr int
DECLARE @text varchar(8000)
EXEC @hr=sp_OACreate 'WinHttp.WinHttpRequest.5.1',@win OUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win, 'Open',NULL,'GET',@url,'false'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win,'Send'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAGetProperty @win,'ResponseText',@text OUTPUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OADestroy @win
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win| Parameter | Description | Compulsory / Optional |
|---|---|---|
| class=group | Class requested: Class to which the request is made | Compulsory |
| method=getgroupcolumns | Class method requested: Method of the class to which the request is made | Compulsory |
| user | User and e-mail of your Afilnet account | Compulsory |
| password | Password of your Afilnet account | Compulsory |
| idgroup | Group ID | Compulsory |
Answer:
- status
-
result (if status=success), here you will receive the following values:
- No additional values will be sent to you
- error (if status=error), here you will receive the error code
Error codes:
| Code | Description |
|---|---|
| MISSING_USER | User or email not included |
| MISSING_PASSWORD | Password not included |
| MISSING_CLASS | Class not included |
| MISSING_METHOD | Method not included |
| MISSING_COMPULSORY_PARAM | Compulsory parameter not included |
| INCORRECT_USER_PASSWORD | Incorrect user or password |
| INCORRECT_CLASS | Incorrect class |
| INCORRECT_METHOD | Incorrect method |
| NOT_ACCESS_TO_GROUP | You are not allowed into the indicated group |
Add field to a group with SQL Server
sp_configure 'show advanced options', 1;
GO
RECONFIGURE;
GO
sp_configure 'Ole Automation Procedures', 1;
GO
RECONFIGURE;
GO
DECLARE @class varchar(500) = 'group';
DECLARE @method varchar(500) = 'addcolumntogroup';
DECLARE @user varchar(500) = 'user';
DECLARE @password varchar(500) = 'password';
DECLARE @idgroup varchar(500) = '1000';
DECLARE @field varchar(500) = 'name';
DECLARE @url varchar(255) = 'https://www.afilnet.com/api/http/?+'&class='+@class+'&method='+@method+'&user='+@user+'&password='+@password+'&idgroup='+@idgroup+'&field='+@field;
DECLARE @win int
DECLARE @hr int
DECLARE @text varchar(8000)
EXEC @hr=sp_OACreate 'WinHttp.WinHttpRequest.5.1',@win OUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win, 'Open',NULL,'GET',@url,'false'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win,'Send'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAGetProperty @win,'ResponseText',@text OUTPUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OADestroy @win
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win| Parameter | Description | Compulsory / Optional |
|---|---|---|
| class=group | Class requested: Class to which the request is made | Compulsory |
| method=addcolumntogroup | Class method requested: Method of the class to which the request is made | Compulsory |
| user | User and e-mail of your Afilnet account | Compulsory |
| password | Password of your Afilnet account | Compulsory |
| idgroup | Group ID | Compulsory |
| field | Group field | Compulsory |
Answer:
- status
-
result (if status=success), here you will receive the following values:
- No additional values will be sent to you
- error (if status=error), here you will receive the error code
Error codes:
| Code | Description |
|---|---|
| MISSING_USER | User or email not included |
| MISSING_PASSWORD | Password not included |
| MISSING_CLASS | Class not included |
| MISSING_METHOD | Method not included |
| MISSING_COMPULSORY_PARAM | Compulsory parameter not included |
| INCORRECT_USER_PASSWORD | Incorrect user or password |
| INCORRECT_CLASS | Incorrect class |
| INCORRECT_METHOD | Incorrect method |
| NOT_ACCESS_TO_GROUP | You are not allowed into the indicated group |
Delete field from a group with SQL Server
sp_configure 'show advanced options', 1;
GO
RECONFIGURE;
GO
sp_configure 'Ole Automation Procedures', 1;
GO
RECONFIGURE;
GO
DECLARE @class varchar(500) = 'group';
DECLARE @method varchar(500) = 'deletecolumnfromgroup';
DECLARE @user varchar(500) = 'user';
DECLARE @password varchar(500) = 'password';
DECLARE @idgroup varchar(500) = '1000';
DECLARE @field varchar(500) = 'name';
DECLARE @url varchar(255) = 'https://www.afilnet.com/api/http/?+'&class='+@class+'&method='+@method+'&user='+@user+'&password='+@password+'&idgroup='+@idgroup+'&field='+@field;
DECLARE @win int
DECLARE @hr int
DECLARE @text varchar(8000)
EXEC @hr=sp_OACreate 'WinHttp.WinHttpRequest.5.1',@win OUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win, 'Open',NULL,'GET',@url,'false'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win,'Send'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAGetProperty @win,'ResponseText',@text OUTPUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OADestroy @win
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win| Parameter | Description | Compulsory / Optional |
|---|---|---|
| class=group | Class requested: Class to which the request is made | Compulsory |
| method=deletecolumnfromgroup | Class method requested: Method of the class to which the request is made | Compulsory |
| user | User and e-mail of your Afilnet account | Compulsory |
| password | Password of your Afilnet account | Compulsory |
| idgroup | Group ID | Compulsory |
| field | Group field | Compulsory |
Answer:
- status
-
result (if status=success), here you will receive the following values:
- No additional values will be sent to you
- error (if status=error), here you will receive the error code
Error codes:
| Code | Description |
|---|---|
| MISSING_USER | User or email not included |
| MISSING_PASSWORD | Password not included |
| MISSING_CLASS | Class not included |
| MISSING_METHOD | Method not included |
| MISSING_COMPULSORY_PARAM | Compulsory parameter not included |
| INCORRECT_USER_PASSWORD | Incorrect user or password |
| INCORRECT_CLASS | Incorrect class |
| INCORRECT_METHOD | Incorrect method |
| NOT_ACCESS_TO_GROUP | You are not allowed into the indicated group |
Delete a contact from a group with SQL Server
sp_configure 'show advanced options', 1;
GO
RECONFIGURE;
GO
sp_configure 'Ole Automation Procedures', 1;
GO
RECONFIGURE;
GO
DECLARE @class varchar(500) = 'group';
DECLARE @method varchar(500) = 'deletegroup';
DECLARE @user varchar(500) = 'user';
DECLARE @password varchar(500) = 'password';
DECLARE @idgroup varchar(500) = '1000';
DECLARE @url varchar(255) = 'https://www.afilnet.com/api/http/?+'&class='+@class+'&method='+@method+'&user='+@user+'&password='+@password+'&idgroup='+@idgroup;
DECLARE @win int
DECLARE @hr int
DECLARE @text varchar(8000)
EXEC @hr=sp_OACreate 'WinHttp.WinHttpRequest.5.1',@win OUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win, 'Open',NULL,'GET',@url,'false'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win,'Send'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAGetProperty @win,'ResponseText',@text OUTPUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OADestroy @win
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win| Parameter | Description | Compulsory / Optional |
|---|---|---|
| class=group | Class requested: Class to which the request is made | Compulsory |
| method=deletegroup | Class method requested: Method of the class to which the request is made | Compulsory |
| user | User and e-mail of your Afilnet account | Compulsory |
| password | Password of your Afilnet account | Compulsory |
| idgroup | Group ID | Compulsory |
Answer:
- status
-
result (if status=success), here you will receive the following values:
- No additional values will be sent to you
- error (if status=error), here you will receive the error code
Error codes:
| Code | Description |
|---|---|
| MISSING_USER | User or email not included |
| MISSING_PASSWORD | Password not included |
| MISSING_CLASS | Class not included |
| MISSING_METHOD | Method not included |
| MISSING_COMPULSORY_PARAM | Compulsory parameter not included |
| INCORRECT_USER_PASSWORD | Incorrect user or password |
| INCORRECT_CLASS | Incorrect class |
| INCORRECT_METHOD | Incorrect method |
| NOT_ACCESS_TO_GROUP | You are not allowed into the indicated group |
Assign country to a group with SQL Server
sp_configure 'show advanced options', 1;
GO
RECONFIGURE;
GO
sp_configure 'Ole Automation Procedures', 1;
GO
RECONFIGURE;
GO
DECLARE @class varchar(500) = 'group';
DECLARE @method varchar(500) = 'assigncountrytogroup';
DECLARE @user varchar(500) = 'user';
DECLARE @password varchar(500) = 'password';
DECLARE @idgroup varchar(500) = '1000';
DECLARE @countryiso3 varchar(500) = 'esp';
DECLARE @url varchar(255) = 'https://www.afilnet.com/api/http/?+'&class='+@class+'&method='+@method+'&user='+@user+'&password='+@password+'&idgroup='+@idgroup+'&countryiso3='+@countryiso3;
DECLARE @win int
DECLARE @hr int
DECLARE @text varchar(8000)
EXEC @hr=sp_OACreate 'WinHttp.WinHttpRequest.5.1',@win OUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win, 'Open',NULL,'GET',@url,'false'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win,'Send'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAGetProperty @win,'ResponseText',@text OUTPUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OADestroy @win
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win| Parameter | Description | Compulsory / Optional |
|---|---|---|
| class=group | Class requested: Class to which the request is made | Compulsory |
| method=assigncountrytogroup | Class method requested: Method of the class to which the request is made | Compulsory |
| user | User and e-mail of your Afilnet account | Compulsory |
| password | Password of your Afilnet account | Compulsory |
| idgroup | Group ID | Compulsory |
| countryiso3 | Country ISO code | Compulsory |
Answer:
- status
-
result (if status=success), here you will receive the following values:
- No additional values will be sent to you
- error (if status=error), here you will receive the error code
Error codes:
| Code | Description |
|---|---|
| MISSING_USER | User or email not included |
| MISSING_PASSWORD | Password not included |
| MISSING_CLASS | Class not included |
| MISSING_METHOD | Method not included |
| MISSING_COMPULSORY_PARAM | Compulsory parameter not included |
| INCORRECT_USER_PASSWORD | Incorrect user or password |
| INCORRECT_CLASS | Incorrect class |
| INCORRECT_METHOD | Incorrect method |
| NOT_ACCESS_TO_GROUP | You are not allowed into the indicated group |
| COUNTRY_NOT_FOUND | There is no country with the indicated code |
Get group contacts with SQL Server
sp_configure 'show advanced options', 1;
GO
RECONFIGURE;
GO
sp_configure 'Ole Automation Procedures', 1;
GO
RECONFIGURE;
GO
DECLARE @class varchar(500) = 'group';
DECLARE @method varchar(500) = 'getcontacts';
DECLARE @user varchar(500) = 'user';
DECLARE @password varchar(500) = 'password';
DECLARE @idgroup varchar(500) = '1000';
DECLARE @url varchar(255) = 'https://www.afilnet.com/api/http/?+'&class='+@class+'&method='+@method+'&user='+@user+'&password='+@password+'&idgroup='+@idgroup;
DECLARE @win int
DECLARE @hr int
DECLARE @text varchar(8000)
EXEC @hr=sp_OACreate 'WinHttp.WinHttpRequest.5.1',@win OUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win, 'Open',NULL,'GET',@url,'false'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win,'Send'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAGetProperty @win,'ResponseText',@text OUTPUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OADestroy @win
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win| Parameter | Description | Compulsory / Optional |
|---|---|---|
| class=group | Class requested: Class to which the request is made | Compulsory |
| method=getcontacts | Class method requested: Method of the class to which the request is made | Compulsory |
| user | User and e-mail of your Afilnet account | Compulsory |
| password | Password of your Afilnet account | Compulsory |
| idgroup | Group ID | Compulsory |
Answer:
- status
-
result (if status=success), here you will receive the following values:
- No additional values will be sent to you
- error (if status=error), here you will receive the error code
Error codes:
| Code | Description |
|---|---|
| MISSING_USER | User or email not included |
| MISSING_PASSWORD | Password not included |
| MISSING_CLASS | Class not included |
| MISSING_METHOD | Method not included |
| MISSING_COMPULSORY_PARAM | Compulsory parameter not included |
| INCORRECT_USER_PASSWORD | Incorrect user or password |
| INCORRECT_CLASS | Incorrect class |
| INCORRECT_METHOD | Incorrect method |
| NOT_ACCESS_TO_GROUP | You are not allowed into the indicated group |
Get a contact from a group with SQL Server
sp_configure 'show advanced options', 1;
GO
RECONFIGURE;
GO
sp_configure 'Ole Automation Procedures', 1;
GO
RECONFIGURE;
GO
DECLARE @class varchar(500) = 'group';
DECLARE @method varchar(500) = 'getcontact';
DECLARE @user varchar(500) = 'user';
DECLARE @password varchar(500) = 'password';
DECLARE @idgroup varchar(500) = '1000';
DECLARE @idcontact varchar(500) = '1000';
DECLARE @url varchar(255) = 'https://www.afilnet.com/api/http/?+'&class='+@class+'&method='+@method+'&user='+@user+'&password='+@password+'&idgroup='+@idgroup+'&idcontact='+@idcontact;
DECLARE @win int
DECLARE @hr int
DECLARE @text varchar(8000)
EXEC @hr=sp_OACreate 'WinHttp.WinHttpRequest.5.1',@win OUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win, 'Open',NULL,'GET',@url,'false'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win,'Send'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAGetProperty @win,'ResponseText',@text OUTPUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OADestroy @win
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win| Parameter | Description | Compulsory / Optional |
|---|---|---|
| class=group | Class requested: Class to which the request is made | Compulsory |
| method=getcontact | Class method requested: Method of the class to which the request is made | Compulsory |
| user | User and e-mail of your Afilnet account | Compulsory |
| password | Password of your Afilnet account | Compulsory |
| idgroup | group id | Compulsory |
| idcontact | Contact ID | Compulsory |
Answer:
- status
-
result (if status=success), here you will receive the following values:
- No additional values will be sent to you
- error (if status=error), here you will receive the error code
Error codes:
| Code | Description |
|---|---|
| MISSING_USER | User or email not included |
| MISSING_PASSWORD | Password not included |
| MISSING_CLASS | Class not included |
| MISSING_METHOD | Method not included |
| MISSING_COMPULSORY_PARAM | Compulsory parameter not included |
| INCORRECT_USER_PASSWORD | Incorrect user or password |
| INCORRECT_CLASS | Incorrect class |
| INCORRECT_METHOD | Incorrect method |
| NOT_ACCESS_TO_GROUP | You are not allowed into the indicated group |
| NOT_ACCESS_TO_CONTACT | ERROR_NOT_ACCESS_TO_CONTACT |
Add a contact to a group with SQL Server
sp_configure 'show advanced options', 1;
GO
RECONFIGURE;
GO
sp_configure 'Ole Automation Procedures', 1;
GO
RECONFIGURE;
GO
DECLARE @class varchar(500) = 'group';
DECLARE @method varchar(500) = 'addcontact';
DECLARE @user varchar(500) = 'user';
DECLARE @password varchar(500) = 'password';
DECLARE @idgroup varchar(500) = '1000';
DECLARE @contact varchar(500) = 'mobile:123456789,name:testname';
DECLARE @url varchar(255) = 'https://www.afilnet.com/api/http/?+'&class='+@class+'&method='+@method+'&user='+@user+'&password='+@password+'&idgroup='+@idgroup+'&contact='+@contact;
DECLARE @win int
DECLARE @hr int
DECLARE @text varchar(8000)
EXEC @hr=sp_OACreate 'WinHttp.WinHttpRequest.5.1',@win OUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win, 'Open',NULL,'GET',@url,'false'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win,'Send'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAGetProperty @win,'ResponseText',@text OUTPUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OADestroy @win
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win| Parameter | Description | Compulsory / Optional |
|---|---|---|
| class=group | Class requested: Class to which the request is made | Compulsory |
| method=addcontact | Class method requested: Method of the class to which the request is made | Compulsory |
| user | User and e-mail of your Afilnet account | Compulsory |
| password | Password of your Afilnet account | Compulsory |
| idgroup | Group ID | Compulsory |
| contact | Contact to be added with its fields separated by commas, see example | Compulsory |
Answer:
- status
-
result (if status=success), here you will receive the following values:
- No additional values will be sent to you
- error (if status=error), here you will receive the error code
Error codes:
| Code | Description |
|---|---|
| MISSING_USER | User or email not included |
| MISSING_PASSWORD | Password not included |
| MISSING_CLASS | Class not included |
| MISSING_METHOD | Method not included |
| MISSING_COMPULSORY_PARAM | Compulsory parameter not included |
| INCORRECT_USER_PASSWORD | Incorrect user or password |
| INCORRECT_CLASS | Incorrect class |
| INCORRECT_METHOD | Incorrect method |
| CONTACT_EXISTS | The contact already exists in the group |
| NOT_ACCESS_TO_GROUP | You are not allowed into the indicated group |
Add a contact list to a group with SQL Server
sp_configure 'show advanced options', 1;
GO
RECONFIGURE;
GO
sp_configure 'Ole Automation Procedures', 1;
GO
RECONFIGURE;
GO
DECLARE @class varchar(500) = 'group';
DECLARE @method varchar(500) = 'addcontactlist';
DECLARE @user varchar(500) = 'user';
DECLARE @password varchar(500) = 'password';
DECLARE @idgroup varchar(500) = '1000';
DECLARE @contacts varchar(500) = '[{\"name\":\"Test\",\"mobile\":\"34600000000\"},{\"name\":\"Test\",\"mobile\":\"34600000001\"}]';
DECLARE @url varchar(255) = 'https://www.afilnet.com/api/http/?+'&class='+@class+'&method='+@method+'&user='+@user+'&password='+@password+'&idgroup='+@idgroup+'&contacts='+@contacts;
DECLARE @win int
DECLARE @hr int
DECLARE @text varchar(8000)
EXEC @hr=sp_OACreate 'WinHttp.WinHttpRequest.5.1',@win OUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win, 'Open',NULL,'GET',@url,'false'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win,'Send'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAGetProperty @win,'ResponseText',@text OUTPUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OADestroy @win
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win| Parameter | Description | Compulsory / Optional |
|---|---|---|
| class=group | Class requested: Class to which the request is made | Compulsory |
| method=addcontactlist | Class method requested: Method of the class to which the request is made | Compulsory |
| user | User and e-mail of your Afilnet account | Compulsory |
| password | Password of your Afilnet account | Compulsory |
| idgroup | group id | Compulsory |
| contacts | Contact list in JSON format | Compulsory |
Answer:
- status
-
result (if status=success), here you will receive the following values:
- No additional values will be sent to you
- error (if status=error), here you will receive the error code
Error codes:
| Code | Description |
|---|---|
| MISSING_USER | User or email not included |
| MISSING_PASSWORD | Password not included |
| MISSING_CLASS | Class not included |
| MISSING_METHOD | Method not included |
| MISSING_COMPULSORY_PARAM | Compulsory parameter not included |
| INCORRECT_USER_PASSWORD | Incorrect user or password |
| INCORRECT_CLASS | Incorrect class |
| INCORRECT_METHOD | Incorrect method |
| NOT_ACCESS_TO_GROUP | You are not allowed into the indicated group |
Modify contact of a group with SQL Server
sp_configure 'show advanced options', 1;
GO
RECONFIGURE;
GO
sp_configure 'Ole Automation Procedures', 1;
GO
RECONFIGURE;
GO
DECLARE @class varchar(500) = 'group';
DECLARE @method varchar(500) = 'modifycontact';
DECLARE @user varchar(500) = 'user';
DECLARE @password varchar(500) = 'password';
DECLARE @idgroup varchar(500) = '1000';
DECLARE @idcontact varchar(500) = '1000';
DECLARE @contact varchar(500) = 'mobile:123456789,name:testname';
DECLARE @url varchar(255) = 'https://www.afilnet.com/api/http/?+'&class='+@class+'&method='+@method+'&user='+@user+'&password='+@password+'&idgroup='+@idgroup+'&idcontact='+@idcontact+'&contact='+@contact;
DECLARE @win int
DECLARE @hr int
DECLARE @text varchar(8000)
EXEC @hr=sp_OACreate 'WinHttp.WinHttpRequest.5.1',@win OUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win, 'Open',NULL,'GET',@url,'false'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win,'Send'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAGetProperty @win,'ResponseText',@text OUTPUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OADestroy @win
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win| Parameter | Description | Compulsory / Optional |
|---|---|---|
| class=group | Class requested: Class to which the request is made | Compulsory |
| method=modifycontact | Class method requested: Method of the class to which the request is made | Compulsory |
| user | User and e-mail of your Afilnet account | Compulsory |
| password | Password of your Afilnet account | Compulsory |
| idgroup | Group ID | Compulsory |
| idcontact | Contact ID | Compulsory |
| contact | Contact to be added with its fields separated by commas, see example | Compulsory |
Answer:
- status
-
result (if status=success), here you will receive the following values:
- No additional values will be sent to you
- error (if status=error), here you will receive the error code
Error codes:
| Code | Description |
|---|---|
| MISSING_USER | User or email not included |
| MISSING_PASSWORD | Password not included |
| MISSING_CLASS | Class not included |
| MISSING_METHOD | Method not included |
| MISSING_COMPULSORY_PARAM | Compulsory parameter not included |
| INCORRECT_USER_PASSWORD | Incorrect user or password |
| INCORRECT_CLASS | Incorrect class |
| INCORRECT_METHOD | Incorrect method |
| NOT_ACCESS_TO_GROUP | You are not allowed into the indicated group |
Delete contact from a group with SQL Server
sp_configure 'show advanced options', 1;
GO
RECONFIGURE;
GO
sp_configure 'Ole Automation Procedures', 1;
GO
RECONFIGURE;
GO
DECLARE @class varchar(500) = 'group';
DECLARE @method varchar(500) = 'deletecontact';
DECLARE @user varchar(500) = 'user';
DECLARE @password varchar(500) = 'password';
DECLARE @idgroup varchar(500) = '1000';
DECLARE @idcontact varchar(500) = '1000';
DECLARE @url varchar(255) = 'https://www.afilnet.com/api/http/?+'&class='+@class+'&method='+@method+'&user='+@user+'&password='+@password+'&idgroup='+@idgroup+'&idcontact='+@idcontact;
DECLARE @win int
DECLARE @hr int
DECLARE @text varchar(8000)
EXEC @hr=sp_OACreate 'WinHttp.WinHttpRequest.5.1',@win OUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win, 'Open',NULL,'GET',@url,'false'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAMethod @win,'Send'
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OAGetProperty @win,'ResponseText',@text OUTPUT
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win
EXEC @hr=sp_OADestroy @win
IF @hr <> 0 EXEC sp_OAGetErrorInfo @win| Parameter | Description | Compulsory / Optional |
|---|---|---|
| class=group | Class requested: Class to which the request is made | Compulsory |
| method=deletecontact | Class method requested: Method of the class to which the request is made | Compulsory |
| user | User and e-mail of your Afilnet account | Compulsory |
| password | Password of your Afilnet account | Compulsory |
| idgroup | Group ID | Compulsory |
| idcontact | Contact ID | Compulsory |
Answer:
- status
-
result (if status=success), here you will receive the following values:
- No additional values will be sent to you
- error (if status=error), here you will receive the error code
Error codes:
| Code | Description |
|---|---|
| MISSING_USER | User or email not included |
| MISSING_PASSWORD | Password not included |
| MISSING_CLASS | Class not included |
| MISSING_METHOD | Method not included |
| MISSING_COMPULSORY_PARAM | Compulsory parameter not included |
| INCORRECT_USER_PASSWORD | Incorrect user or password |
| INCORRECT_CLASS | Incorrect class |
| INCORRECT_METHOD | Incorrect method |
| NOT_ACCESS_TO_GROUP | You are not allowed into the indicated group |
Afilnet offers you methods to improve security when using our API with SQL Server, thanks to the possibility of creating accesses and the possibility of activating filtering by IP.
Which API for SQL Server should I use?
Discover the advantages and disadvantages of each of our APIs. Find out which API is best for your Software in SQL Server.
This API allows you to connect to us from SQL Server to send requests via HTTP GET requests. This request sends the parameters in the same URL as the request.
- HTTP GET is extremely simple to implement
- Information is sent unencrypted (passwords could be extracted from logs or cache)
- Maximum request of ~4000 characters
The POST request API allows you to connect to our API from SQL Server by sending request parameters via HTTP POST parameters. The information is sent independently of the URL.
- HTTP POST is simple to implement
- Information is sent encrypted
- There is no limit on the size of the request
- Medium security
The basic authentication API allows the use of GET and POST requests in SQL Server with an additional security layer, since in this case the username and password are sent in the header of the request.
- Basic authentication is easy to implement
- Access data is sent encrypted
- The size limit depends on the use of GET or POST
- Medium security
SOAP allows you to send requests in XML format with SQL Server, SOAP adds an extra layer of security to API requests.
- SOAP integration is more complex
- Information is sent encrypted
- There is no limit on the size of the request
- Medium / High security
Our JSON API allows you to send requests in JSON format with SQL Server, in addition this API adds the oAuth 2.0 protocol in the authentication that allows you to add an additional layer of security.
- JSON oAuth 2.0 integration is more complex
- Information is sent encrypted
- There is no limit on the size of the request
- High security
Connect SQL Server with our CONTACTS API
01
Register as a client
In order to have access to the API you must be an Afilnet client. Registration will take a few minutes.
02
Request your free trial
Our company will offer you trial balance that will allow you to test with the API you need.
03
Integrate the API
Perform API integration using the programming language of your choice. If you have any questions or suggestions about the API, contact us
04
Welcome to Afilnet!
Everything ready!, has managed to improve its communications with Afilnet. We are here to support our API when you need it
Contact our team with any questions through the contact methods that we offer. Our team will try to offer you an immediate solution and will help you in the integration of our API in your Software.