Web Chat API for Ruby on rails
Manage the Chat system from API. Access or reply to conversations from our API.
Get a list of active chat channels with Ruby on rails
# net/http library is required
require 'net/http'
afilnet_class="chat";
afilnet_method="getchatchannels";
afilnet_user="user";
afilnet_password="password";
# Create an URL request
sUrl = "https://www.afilnet.com/api/http/?class="+afilnet_class+"&method="+afilnet_method+"&user="+afilnet_user+"&password="+afilnet_password;
uri = URI(sUrl)
response = Net::HTTP.get(uri)
# net/http library is required
require 'net/http'
afilnet_class="chat";
afilnet_method="getchatchannels";
afilnet_user="user";
afilnet_password="password";
# Create an URL request
sUrl = "https://www.afilnet.com/api/http/";
uri = URI(sUrl)
response = Net::HTTP.post_form(uri, "class" => afilnet_class, "method" => afilnet_method, "user" => afilnet_user, "password" => afilnet_password)
puts response.body
# net/http library is required
require 'net/http'
afilnet_class="chat";
afilnet_method="getchatchannels";
afilnet_user="user";
afilnet_password="password";
# Create an URL request
sUrl = "https://www.afilnet.com/api/basic/?class="+afilnet_class+"&method="+afilnet_method;
uri = URI(sUrl)
req = Net::HTTP::Get.new(uri)
req.basic_auth afilnet_user, afilnet_password
res = Net::HTTP.start(uri.hostname) {|http|
http.request(req)
}
puts res.body
# Savon library is required
require 'savon'
# We define vars
afilnet_class="chat";
afilnet_method="getchatchannels";
afilnet_user="user";
afilnet_password="password";
# We create the client instance
client = Savon.client(wsdl: 'https://www.afilnet.com/api/soap/index.php?wsdl', ssl_verify_mode: :none)
# We call to the service
res = client.call(:call, message: {
user: afilnet_user,
password: afilnet_password,
class: afilnet_class,
method: afilnet_method,
petition: "{}"
})
puts res.body
Parameter | Description | Compulsory / Optional |
---|---|---|
class=chat | Class requested: Class to which the request is made | Compulsory |
method=getchatchannels | 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 |
Answer:
- status
-
result (if status=success), here you will receive the following values:
-
list
- platformid
- platform
- name
-
list
- 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 |
Send a message via chat with Ruby on rails
# Savon library is required
require 'savon'
# We define vars
afilnet_class="chat";
afilnet_method="getchatchannels";
afilnet_user="user";
afilnet_password="password";
# We create the client instance
client = Savon.client(wsdl: 'https://www.afilnet.com/api/soap/index.php?wsdl', ssl_verify_mode: :none)
# We call to the service
res = client.call(:call, message: {
user: afilnet_user,
password: afilnet_password,
class: afilnet_class,
method: afilnet_method,
petition: "{}"
})
puts res.body# net/http library is required
require 'net/http'
afilnet_class="chat";
afilnet_method="sendmessage";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
afilnet_destination="3460000000";
afilnet_message="test+message";
# Create an URL request
sUrl = "https://www.afilnet.com/api/http/?class="+afilnet_class+"&method="+afilnet_method+"&user="+afilnet_user+"&password="+afilnet_password+"&platform="+afilnet_platform+"&platformid="+afilnet_platformid+"&destination="+afilnet_destination+"&message="+afilnet_message;
uri = URI(sUrl)
response = Net::HTTP.get(uri)
# net/http library is required
require 'net/http'
afilnet_class="chat";
afilnet_method="sendmessage";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
afilnet_destination="3460000000";
afilnet_message="test+message";
# Create an URL request
sUrl = "https://www.afilnet.com/api/http/";
uri = URI(sUrl)
response = Net::HTTP.post_form(uri, "class" => afilnet_class, "method" => afilnet_method, "user" => afilnet_user, "password" => afilnet_password, "platform" => afilnet_platform, "platformid" => afilnet_platformid, "destination" => afilnet_destination, "message" => afilnet_message)
puts response.body
# net/http library is required
require 'net/http'
afilnet_class="chat";
afilnet_method="sendmessage";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
afilnet_destination="3460000000";
afilnet_message="test+message";
# Create an URL request
sUrl = "https://www.afilnet.com/api/basic/?class="+afilnet_class+"&method="+afilnet_method+"&platform="+afilnet_platform+"&platformid="+afilnet_platformid+"&destination="+afilnet_destination+"&message="+afilnet_message;
uri = URI(sUrl)
req = Net::HTTP::Get.new(uri)
req.basic_auth afilnet_user, afilnet_password
res = Net::HTTP.start(uri.hostname) {|http|
http.request(req)
}
puts res.body
# Savon library is required
require 'savon'
# We define vars
afilnet_class="chat";
afilnet_method="sendmessage";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
afilnet_destination="3460000000";
afilnet_message="test+message";
# We create the client instance
client = Savon.client(wsdl: 'https://www.afilnet.com/api/soap/index.php?wsdl', ssl_verify_mode: :none)
# We call to the service
res = client.call(:call, message: {
user: afilnet_user,
password: afilnet_password,
class: afilnet_class,
method: afilnet_method,
petition: "{\"platform\":\""+afilnet_platform+"\",\"platformid\":\""+afilnet_platformid+"\",\"destination\":\""+afilnet_destination+"\",\"message\":\""+afilnet_message+"\"}"
})
puts res.body
Parameter | Description | Compulsory / Optional |
---|---|---|
class=chat | Class requested: Class to which the request is made | Compulsory |
method=sendmessage | 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 |
platform | Platform to which the message is sent. Possible values: 'webchat', 'whatsapp', 'telegram', 'operator' | Compulsory |
platformid | Platform identifier | Compulsory |
destination | Recipient where the chat message is sent | Compulsory |
message | Message to send via chat | 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 |
CHANNEL_NOT_FOUND | The indicated channel does not exist |
Send a file via chat with Ruby on rails
# Savon library is required
require 'savon'
# We define vars
afilnet_class="chat";
afilnet_method="sendmessage";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
afilnet_destination="3460000000";
afilnet_message="test+message";
# We create the client instance
client = Savon.client(wsdl: 'https://www.afilnet.com/api/soap/index.php?wsdl', ssl_verify_mode: :none)
# We call to the service
res = client.call(:call, message: {
user: afilnet_user,
password: afilnet_password,
class: afilnet_class,
method: afilnet_method,
petition: "{\"platform\":\""+afilnet_platform+"\",\"platformid\":\""+afilnet_platformid+"\",\"destination\":\""+afilnet_destination+"\",\"message\":\""+afilnet_message+"\"}"
})
puts res.body# net/http library is required
require 'net/http'
afilnet_class="chat";
afilnet_method="sendfile";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
afilnet_destination="3460000000";
afilnet_type="image";
afilnet_fileurl="https://www.example.com/image.jpg";
afilnet_thumburl="https://www.example.com/thumb.jpg";
afilnet_message="test+message";
# Create an URL request
sUrl = "https://www.afilnet.com/api/http/?class="+afilnet_class+"&method="+afilnet_method+"&user="+afilnet_user+"&password="+afilnet_password+"&platform="+afilnet_platform+"&platformid="+afilnet_platformid+"&destination="+afilnet_destination+"&type="+afilnet_type+"&fileurl="+afilnet_fileurl+"&thumburl="+afilnet_thumburl+"&message="+afilnet_message;
uri = URI(sUrl)
response = Net::HTTP.get(uri)
# net/http library is required
require 'net/http'
afilnet_class="chat";
afilnet_method="sendfile";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
afilnet_destination="3460000000";
afilnet_type="image";
afilnet_fileurl="https://www.example.com/image.jpg";
afilnet_thumburl="https://www.example.com/thumb.jpg";
afilnet_message="test+message";
# Create an URL request
sUrl = "https://www.afilnet.com/api/http/";
uri = URI(sUrl)
response = Net::HTTP.post_form(uri, "class" => afilnet_class, "method" => afilnet_method, "user" => afilnet_user, "password" => afilnet_password, "platform" => afilnet_platform, "platformid" => afilnet_platformid, "destination" => afilnet_destination, "type" => afilnet_type, "fileurl" => afilnet_fileurl, "thumburl" => afilnet_thumburl, "message" => afilnet_message)
puts response.body
# net/http library is required
require 'net/http'
afilnet_class="chat";
afilnet_method="sendfile";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
afilnet_destination="3460000000";
afilnet_type="image";
afilnet_fileurl="https://www.example.com/image.jpg";
afilnet_thumburl="https://www.example.com/thumb.jpg";
afilnet_message="test+message";
# Create an URL request
sUrl = "https://www.afilnet.com/api/basic/?class="+afilnet_class+"&method="+afilnet_method+"&platform="+afilnet_platform+"&platformid="+afilnet_platformid+"&destination="+afilnet_destination+"&type="+afilnet_type+"&fileurl="+afilnet_fileurl+"&thumburl="+afilnet_thumburl+"&message="+afilnet_message;
uri = URI(sUrl)
req = Net::HTTP::Get.new(uri)
req.basic_auth afilnet_user, afilnet_password
res = Net::HTTP.start(uri.hostname) {|http|
http.request(req)
}
puts res.body
# Savon library is required
require 'savon'
# We define vars
afilnet_class="chat";
afilnet_method="sendfile";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
afilnet_destination="3460000000";
afilnet_type="image";
afilnet_fileurl="https://www.example.com/image.jpg";
afilnet_thumburl="https://www.example.com/thumb.jpg";
afilnet_message="test+message";
# We create the client instance
client = Savon.client(wsdl: 'https://www.afilnet.com/api/soap/index.php?wsdl', ssl_verify_mode: :none)
# We call to the service
res = client.call(:call, message: {
user: afilnet_user,
password: afilnet_password,
class: afilnet_class,
method: afilnet_method,
petition: "{\"platform\":\""+afilnet_platform+"\",\"platformid\":\""+afilnet_platformid+"\",\"destination\":\""+afilnet_destination+"\",\"type\":\""+afilnet_type+"\",\"fileurl\":\""+afilnet_fileurl+"\",\"thumburl\":\""+afilnet_thumburl+"\",\"message\":\""+afilnet_message+"\"}"
})
puts res.body
Parameter | Description | Compulsory / Optional |
---|---|---|
class=chat | Class requested: Class to which the request is made | Compulsory |
method=sendfile | 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 |
platform | Platform to which the message is sent. Possible values: 'webchat', 'whatsapp', 'telegram', 'operator' | Compulsory |
platformid | Platform identifier | Compulsory |
destination | Recipient where the file is sent | Compulsory |
type | Type of file being sent. Possible values: 'image', 'video', 'audio', 'voice', 'document', 'contact' | Compulsory |
fileurl | Url where the file to be sent by chat is located | Compulsory |
thumburl | Url of the thumbnail image that accompanies the file | Optional |
message | Message accompanying the file | Optional |
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 |
CHANNEL_NOT_FOUND | The indicated channel does not exist |
CHAT_NOT_FOUND | The indicated chat does not exist |
INCORRECT_FILETYPE | The file type is wrong, check the possible values |
INCORRECT_FILEURL | The file url is not valid |
INCORRECT_THUMBURL | The url of the thumbnail is invalid |
Get a list of conversations in a chat with Ruby on rails
# Savon library is required
require 'savon'
# We define vars
afilnet_class="chat";
afilnet_method="sendfile";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
afilnet_destination="3460000000";
afilnet_type="image";
afilnet_fileurl="https://www.example.com/image.jpg";
afilnet_thumburl="https://www.example.com/thumb.jpg";
afilnet_message="test+message";
# We create the client instance
client = Savon.client(wsdl: 'https://www.afilnet.com/api/soap/index.php?wsdl', ssl_verify_mode: :none)
# We call to the service
res = client.call(:call, message: {
user: afilnet_user,
password: afilnet_password,
class: afilnet_class,
method: afilnet_method,
petition: "{\"platform\":\""+afilnet_platform+"\",\"platformid\":\""+afilnet_platformid+"\",\"destination\":\""+afilnet_destination+"\",\"type\":\""+afilnet_type+"\",\"fileurl\":\""+afilnet_fileurl+"\",\"thumburl\":\""+afilnet_thumburl+"\",\"message\":\""+afilnet_message+"\"}"
})
puts res.body# net/http library is required
require 'net/http'
afilnet_class="chat";
afilnet_method="getchats";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
# Create an URL request
sUrl = "https://www.afilnet.com/api/http/?class="+afilnet_class+"&method="+afilnet_method+"&user="+afilnet_user+"&password="+afilnet_password+"&platform="+afilnet_platform+"&platformid="+afilnet_platformid;
uri = URI(sUrl)
response = Net::HTTP.get(uri)
# net/http library is required
require 'net/http'
afilnet_class="chat";
afilnet_method="getchats";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
# Create an URL request
sUrl = "https://www.afilnet.com/api/http/";
uri = URI(sUrl)
response = Net::HTTP.post_form(uri, "class" => afilnet_class, "method" => afilnet_method, "user" => afilnet_user, "password" => afilnet_password, "platform" => afilnet_platform, "platformid" => afilnet_platformid)
puts response.body
# net/http library is required
require 'net/http'
afilnet_class="chat";
afilnet_method="getchats";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
# Create an URL request
sUrl = "https://www.afilnet.com/api/basic/?class="+afilnet_class+"&method="+afilnet_method+"&platform="+afilnet_platform+"&platformid="+afilnet_platformid;
uri = URI(sUrl)
req = Net::HTTP::Get.new(uri)
req.basic_auth afilnet_user, afilnet_password
res = Net::HTTP.start(uri.hostname) {|http|
http.request(req)
}
puts res.body
# Savon library is required
require 'savon'
# We define vars
afilnet_class="chat";
afilnet_method="getchats";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
# We create the client instance
client = Savon.client(wsdl: 'https://www.afilnet.com/api/soap/index.php?wsdl', ssl_verify_mode: :none)
# We call to the service
res = client.call(:call, message: {
user: afilnet_user,
password: afilnet_password,
class: afilnet_class,
method: afilnet_method,
petition: "{\"platform\":\""+afilnet_platform+"\",\"platformid\":\""+afilnet_platformid+"\"}"
})
puts res.body
Parameter | Description | Compulsory / Optional |
---|---|---|
class=chat | Class requested: Class to which the request is made | Compulsory |
method=getchats | 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 |
platform | Platform to which the message is sent. Possible values: 'webchat', 'whatsapp', 'telegram', 'operator' | Compulsory |
platformid | Platform identifier | Compulsory |
Answer:
- status
-
result (if status=success), here you will receive the following values:
-
list
- platformid
- platform
- message
- destination
- messageid
- sent
- status
- datetime
-
list
- 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 |
CHANNEL_NOT_FOUND | The indicated channel does not exist |
CHAT_NOT_FOUND | The indicated chat does not exist |
Get list of messages from a chat with Ruby on rails
# Savon library is required
require 'savon'
# We define vars
afilnet_class="chat";
afilnet_method="getchats";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
# We create the client instance
client = Savon.client(wsdl: 'https://www.afilnet.com/api/soap/index.php?wsdl', ssl_verify_mode: :none)
# We call to the service
res = client.call(:call, message: {
user: afilnet_user,
password: afilnet_password,
class: afilnet_class,
method: afilnet_method,
petition: "{\"platform\":\""+afilnet_platform+"\",\"platformid\":\""+afilnet_platformid+"\"}"
})
puts res.body# net/http library is required
require 'net/http'
afilnet_class="chat";
afilnet_method="getmessages";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
afilnet_destination="34600000000";
# Create an URL request
sUrl = "https://www.afilnet.com/api/http/?class="+afilnet_class+"&method="+afilnet_method+"&user="+afilnet_user+"&password="+afilnet_password+"&platform="+afilnet_platform+"&platformid="+afilnet_platformid+"&destination="+afilnet_destination;
uri = URI(sUrl)
response = Net::HTTP.get(uri)
# net/http library is required
require 'net/http'
afilnet_class="chat";
afilnet_method="getmessages";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
afilnet_destination="34600000000";
# Create an URL request
sUrl = "https://www.afilnet.com/api/http/";
uri = URI(sUrl)
response = Net::HTTP.post_form(uri, "class" => afilnet_class, "method" => afilnet_method, "user" => afilnet_user, "password" => afilnet_password, "platform" => afilnet_platform, "platformid" => afilnet_platformid, "destination" => afilnet_destination)
puts response.body
# net/http library is required
require 'net/http'
afilnet_class="chat";
afilnet_method="getmessages";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
afilnet_destination="34600000000";
# Create an URL request
sUrl = "https://www.afilnet.com/api/basic/?class="+afilnet_class+"&method="+afilnet_method+"&platform="+afilnet_platform+"&platformid="+afilnet_platformid+"&destination="+afilnet_destination;
uri = URI(sUrl)
req = Net::HTTP::Get.new(uri)
req.basic_auth afilnet_user, afilnet_password
res = Net::HTTP.start(uri.hostname) {|http|
http.request(req)
}
puts res.body
# Savon library is required
require 'savon'
# We define vars
afilnet_class="chat";
afilnet_method="getmessages";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
afilnet_destination="34600000000";
# We create the client instance
client = Savon.client(wsdl: 'https://www.afilnet.com/api/soap/index.php?wsdl', ssl_verify_mode: :none)
# We call to the service
res = client.call(:call, message: {
user: afilnet_user,
password: afilnet_password,
class: afilnet_class,
method: afilnet_method,
petition: "{\"platform\":\""+afilnet_platform+"\",\"platformid\":\""+afilnet_platformid+"\",\"destination\":\""+afilnet_destination+"\"}"
})
puts res.body
Parameter | Description | Compulsory / Optional |
---|---|---|
class=chat | Class requested: Class to which the request is made | Compulsory |
method=getmessages | 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 |
platform | Platform to which the message is sent. Possible values: 'webchat', 'whatsapp', 'telegram', 'operator' | Compulsory |
platformid | Platform identifier | Compulsory |
destination | Recipient from which you want to obtain the messages | Compulsory |
Answer:
- status
-
result (if status=success), here you will receive the following values:
-
list
- platformid
- platform
- message
- destination
- messageid
- sent
- status
- datetime
-
list
- 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 |
CHANNEL_NOT_FOUND | The indicated channel does not exist |
CHAT_NOT_FOUND | The indicated chat does not exist |
Get a list of unread messages from a chat with Ruby on rails
# Savon library is required
require 'savon'
# We define vars
afilnet_class="chat";
afilnet_method="getmessages";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
afilnet_destination="34600000000";
# We create the client instance
client = Savon.client(wsdl: 'https://www.afilnet.com/api/soap/index.php?wsdl', ssl_verify_mode: :none)
# We call to the service
res = client.call(:call, message: {
user: afilnet_user,
password: afilnet_password,
class: afilnet_class,
method: afilnet_method,
petition: "{\"platform\":\""+afilnet_platform+"\",\"platformid\":\""+afilnet_platformid+"\",\"destination\":\""+afilnet_destination+"\"}"
})
puts res.body# net/http library is required
require 'net/http'
afilnet_class="chat";
afilnet_method="getunreadmessages";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
afilnet_destination="34600000000";
# Create an URL request
sUrl = "https://www.afilnet.com/api/http/?class="+afilnet_class+"&method="+afilnet_method+"&user="+afilnet_user+"&password="+afilnet_password+"&platform="+afilnet_platform+"&platformid="+afilnet_platformid+"&destination="+afilnet_destination;
uri = URI(sUrl)
response = Net::HTTP.get(uri)
# net/http library is required
require 'net/http'
afilnet_class="chat";
afilnet_method="getunreadmessages";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
afilnet_destination="34600000000";
# Create an URL request
sUrl = "https://www.afilnet.com/api/http/";
uri = URI(sUrl)
response = Net::HTTP.post_form(uri, "class" => afilnet_class, "method" => afilnet_method, "user" => afilnet_user, "password" => afilnet_password, "platform" => afilnet_platform, "platformid" => afilnet_platformid, "destination" => afilnet_destination)
puts response.body
# net/http library is required
require 'net/http'
afilnet_class="chat";
afilnet_method="getunreadmessages";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
afilnet_destination="34600000000";
# Create an URL request
sUrl = "https://www.afilnet.com/api/basic/?class="+afilnet_class+"&method="+afilnet_method+"&platform="+afilnet_platform+"&platformid="+afilnet_platformid+"&destination="+afilnet_destination;
uri = URI(sUrl)
req = Net::HTTP::Get.new(uri)
req.basic_auth afilnet_user, afilnet_password
res = Net::HTTP.start(uri.hostname) {|http|
http.request(req)
}
puts res.body
# Savon library is required
require 'savon'
# We define vars
afilnet_class="chat";
afilnet_method="getunreadmessages";
afilnet_user="user";
afilnet_password="password";
afilnet_platform="whatsapp";
afilnet_platformid="100";
afilnet_destination="34600000000";
# We create the client instance
client = Savon.client(wsdl: 'https://www.afilnet.com/api/soap/index.php?wsdl', ssl_verify_mode: :none)
# We call to the service
res = client.call(:call, message: {
user: afilnet_user,
password: afilnet_password,
class: afilnet_class,
method: afilnet_method,
petition: "{\"platform\":\""+afilnet_platform+"\",\"platformid\":\""+afilnet_platformid+"\",\"destination\":\""+afilnet_destination+"\"}"
})
puts res.body
Parameter | Description | Compulsory / Optional |
---|---|---|
class=chat | Class requested: Class to which the request is made | Compulsory |
method=getunreadmessages | 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 |
platform | Platform to which the message is sent. Possible values: 'webchat', 'whatsapp', 'telegram', 'operator' | Compulsory |
platformid | Platform identifier | Compulsory |
destination | Recipient from which you want to obtain the messages | Compulsory |
Answer:
- status
-
result (if status=success), here you will receive the following values:
-
list
- platformid
- platform
- message
- destination
- messageid
- issent
- status
- datetime
-
list
- 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 |
CHANNEL_NOT_FOUND | The indicated channel does not exist |
CHAT_NOT_FOUND | The indicated chat does not exist |
Which API for Ruby on rails should I use?
Discover the advantages and disadvantages of each of our APIs. Find out which API is best for your Software in Ruby on rails.
This API allows you to connect to us from Ruby on rails 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 Ruby on rails 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 Ruby on rails 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 Ruby on rails, 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 Ruby on rails, 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 Ruby on rails with our Chats API
Register as a client
In order to have access to the API you must be an Afilnet client. Registration will take a few minutes.
Request your free trial
Our company will offer you trial balance that will allow you to test with the API you need.
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
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.