Connectors Reference
E-goi is a Multichannel Marketing Automation Platform, including email marketing services, SMS, Voice Broadcast, Push Notifications, Web Push and Forms to Capture, Automate, Communicate, Analyse and Generate more Sales. The connector allow users to add/update contacts, attach tags and send transactional SMS.
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
Return a list of contacts |
|
|
Return all contacts |
|
|
CreateContact (string idList, CreateContactParameterBody body) |
Create Contact |
|
Attach Tag |
|
|
Get tags |
|
|
UpdateContact (string list_id, string contact_id, [Optional]UpdateContactParameterBody body) |
Update Contact |
|
Send SMS |
|
|
Get Senders |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Return a list of contacts
Description: The API returns the available lists of contacts
Syntax:
E-goi.GetListsContacts ()
Returns:
Summary: Return all contacts
Description: The API returns all contacts from a chosen list
Syntax:
E-goi.GetAllContacs (string idList)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
idList |
string
|
The ID of contact list. |
True |
Returns:
Summary: Create Contact
Description: Create a new contact to a specific list.
Syntax:
E-goi.CreateContact (string idList, CreateContactParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
idList |
string (Contacts list) |
The ID of contact list. |
True |
|
|
body |
|
|
True |
Returns:
Summary: Attach Tag
Description: Attaches a tag of your choosing to an existing contact.
Syntax:
E-goi.AddTag (string list_id, AddTagParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
list_id |
string (Contacts list) |
The ID of contact list. |
True |
|
|
body |
|
|
True |
Returns:
Type:AddTagResponse
Summary: Get tags
Description: Return list of tags
Syntax:
E-goi.GetTag ()
Returns:
Type:GetTagResponse
Summary: Update Contact
Description: Update an existing contact.
Syntax:
E-goi.UpdateContact (string list_id, string contact_id, [Optional]UpdateContactParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
list_id |
string (Contacts list) |
The id of contact lists. |
True |
|
|
contact_id |
string (Contact) |
The Contact Id. |
True |
|
|
body |
|
|
False |
Returns:
Summary: Send SMS
Description: Send an SMS to a contact
Syntax:
E-goi.SendSMS (array )
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
|
array of (SendSMSParameter Item)
|
|
True |
Returns:
Type:SendSMSResponse
Summary: Get Senders
Description: Get SMS senders
Syntax:
E-goi.GetSenders ()
Returns:
Type:GetSendersResponse
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
tag_id |
integer(int32)
|
Tags |
|
contacts |
array of (string)
|
contacts |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
tag_id |
integer(int32)
|
tag_id |
|
success |
array of (string)
|
success |
|
error |
|
error |
Summary:
Description: error
Properties:
|
Name |
Type |
Summary |
|
invalid_contact |
array of (Invalid_contactItem)
|
invalid_contact |
|
has_tag_id |
array of (Has_tag_idItem)
|
has_tag_id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
base |
|
base |
Summary:
Description: base
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
Status of the contact. Values: [active, inactive, removed, unconfirmed] |
|
first_name |
string
|
First name of the contact. |
|
last_name |
string
|
Last name of the contact. |
|
birth_date |
string(date)
|
Birth date of the contact. (format: yyyy-mm-dd) |
|
language |
string
|
Current language. Values: [en, pt, br, es, de, hu, fr] |
|
|
string
|
Email of the contact. |
|
cellphone |
string
|
Cellphone of the contact. (format: ccc-xxxxxxxxx) |
|
phone |
string
|
Phone of the contact. (format: ccc-xxxxxxxxx) |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
contact_id |
string
|
contact_id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
total_items |
integer(int32)
|
total_items |
|
items |
array of (ItemsItem)
|
items |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
base |
|
base |
|
extra |
array of (ExtraItem)
|
extra |
|
tags |
array of (integer(int32))
|
tags |
Summary:
Description: base
Properties:
|
Name |
Type |
Summary |
|
contact_id |
string
|
contact_id |
|
status |
string
|
status |
|
consent |
string
|
consent |
|
consent_date |
string
|
consent_date |
|
subscription_method |
string
|
subscription_method |
|
subscription_date |
string
|
subscription_date |
|
subscription_form |
integer(int32)
|
subscription_form |
|
unsubscription_method |
string
|
unsubscription_method |
|
unsubscription_reason |
string
|
unsubscription_reason |
|
unsubscription_observation |
string
|
unsubscription_observation |
|
unsubscription_date |
string
|
unsubscription_date |
|
change_date |
string
|
change_date |
|
first_name |
string
|
first_name |
|
last_name |
string
|
last_name |
|
birth_date |
string
|
birth_date |
|
language |
string
|
language |
|
|
string
|
|
|
email_status |
string
|
email_status |
|
cellphone |
string
|
cellphone |
|
cellphone_status |
string
|
cellphone_status |
|
phone |
string
|
phone |
|
phone_status |
string
|
phone_status |
|
push_token_android |
array of (Push_token_androidItem)
|
push_token_android |
|
push_token_ios |
array of (Push_token_iosItem)
|
push_token_ios |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
field_id |
integer(int32)
|
field_id |
|
format |
string
|
format |
|
value |
string
|
value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
total_items |
integer(int32)
|
total_items |
|
items |
array of (ItemsItem)
|
items |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
list_id |
integer(int32)
|
list_id |
|
internal_name |
string
|
internal_name |
|
public_name |
string
|
public_name |
|
status |
string
|
status |
|
group_id |
integer(int32)
|
group_id |
|
created |
string
|
created |
|
updated |
string
|
updated |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
phoneNumber |
string
|
phoneNumber |
|
senderStatus |
string
|
senderStatus |
|
name |
string
|
name |
|
id |
string
|
id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
total_items |
integer(int32)
|
total_items |
|
items |
array of (ItemsItem)
|
items |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
tag_id |
integer(int32)
|
tag_id |
|
name |
string
|
name |
|
color |
string
|
color |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
to |
string
|
The contact of the recipient. format should be countryCode-phoneNumber. (ex: 351-911111111) |
|
from |
string
|
The id of the sender. |
|
textBody |
string
|
The content of the message. (ex: Hello!) |
|
encoding |
string
|
The encoding of the message. (ex: unicode) Values: [unicode, gsm0338] |
|
maxCount |
integer(int32)
|
The maximum amount of messages to be sent (if the Text Body is too big for a single message). |
|
priority |
string
|
The priority of the message. Values: [urgent, non-urgent] |
|
customData |
string
|
Extra Data related to the campaign to be re-sent via WebHook. (ex: meta-data) |
|
registered |
boolean
|
Option to register the message. Its an exclusive feature for senders that require it. Values: [, ] |
|
group |
string
|
The group of the message. (ex: welcome) |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
contact_id |
string
|
messageId |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
base |
|
base |
Summary:
Description: base
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
active Values: [active, inactive, removed, unconfirmed] |
|
consent |
string
|
Contact consent. Values: [any, consent, contract, legitimate_interest, none, protect_vital_interests, public_interests, required_by_law, withdrawn] |
|
first_name |
string
|
First name of the contact. |
|
last_name |
string
|
Last name of the contact. |
|
birth_date |
string
|
Birth date of the contact. (format: yyyy-mm-dd) |
|
language |
string
|
Current language. Values: [en, pt, br, es, de, hu, fr] |
|
cellphone |
string
|
Cellphone of the contact. (format: ccc-xxxxxxxxx) |
|
cellphone_status |
string
|
Cellphone channel status. Values: [active, inactive] |
|
phone |
string
|
Phone of the contact. (format: ccc-xxxxxxxxx) |
|
phone_status |
string
|
Phone channel status. Values: [active, inactive] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
contact_id |
string
|
contact_id |