Documentation

LogIn

This API is used to send a Text Message (SMS) under the company account.
if the Phone number found under a contact, the info for the contact will be updated not adding a new record.

Method: Get/Post

Base URL : https://hubbucs.com/site/api/send_sms
Mandatory Parameters Sample Description
key 374593457034859 The company account API key, you can get from company settings > API settings
from 3056490655 One of your telephone numbers assigned under the account, if not assigned, will result in error.
message_body string The contents of the text message (must be 2048 characters or less).


Optional Parameters Sample Description
to 9195551212 The phone number the message should be sent to, multiple formats accepted: +19195551212 OR 9195551212 OR 19195551212 OR 0019195551212 OR it can be a list of numbers seperated by comma "," example: 9195551212,9195551213,9195551214
numbers 9195551212,9195551213,9195551214 A list of phone numbers the message should be sent to seperated by comma (,) multiple formats accepted: +19195551212 OR 9195551212 OR 19195551212 OR 0019195551212
contact_id 876566 the contact id, if exists, the data below will be used to update the contact info
email [email protected] email for the new contact, if a contact with the email already exists, the contact will be updated
create_new_contact 1 or 2 1: create new contact if not exists (Default value if not sent)
2: Don't create new contact if not exists
match_with_email Possible Values (1 OR 2) 1: Yes match with email (default value), 2 No: dont match with email
match_with_phone Possible Values (1 OR 2) 1: Yes match with phone , 2 No: dont match with phone (default value)
check_name Possible Values (1 OR 2) if set to 1 : Name will be used to search existing contacts as a unique identifier, if set to 2 or not sent(default value): Name will not be used to check existing contacts as a unique identifier
fullname mike douglas The Full name for the contact (if exists, firstname and lastname parameters will be ignored)
firstname mike The first name for the contact
lastname douglas The last name for the contact
new_company_name company XY A new company for the contact, which will be created and link the contact to it, if the contact wasn't linked to a company before, if the contact was linked to a company, this will be ignored
facebook facebook ULR or Facebook name The Facebook page or name for the contact
twitter twitter ULR or twitter name The twitter account for the contact
skype skype username The skype username account for the contact
linkedin Linkedin username The Linkedin username account for the contact
pinterest pinterest username The pinterest account for the contact
googlePlus googlePlus username The googlePlus account for the contact
instagram instagram username The instagram account for the contact
source campaign1 A Friendly name, you can add to know the source of contact, if not exists in the settings, it will be added automatically
tags new customer, campaign1, call me Tags you want to add to the contact to use it later on, add as many tags , split by ","
remove_tags new customer, campaign1, call me Tags you want to remove from the contact if the contact already exists , split by ","
notifyToEmail [email protected] If exists, An email will be sent to notify when a new contact added via the API
notifyEmailSubject New Contact Added Subject of the notification email for new contacts
contactowner_email [email protected] Email for the user to be assigned as the contact owner on the CRM, it must be a valid email for a valid active user under the company account or will be neglected
contactowner_group group name the user group name to assigned contacts to it in a round robin
If the parameter "contactowner_email" is sent, this parameter will be neglected and "contactowner_email" will override it
email_notify_owner Possible Values (1 OR 2) if set to 1 : a notification email will be sent to the assigned owner, if set to 2(default value): no notification email will be sent to the owner


Error Messages:

Message Description
Not Enough Balance to process this request Charge the account or put a card on file to process charge automatically
Invalid Key or missing parameters Check API call parameters
From Number is not active on this account Sender Number is not registered with HUBB UCS on this account

Example:


				

Example :

https://hubbucs.com/site/api/send_sms?key=12134651Gsuid7349&email=XXXXX[&Optional_parameter1=XXXXX&Optional_parameter2=XXXXX]

Response :

  1. {
  2. "message":"success",
  3. "contact_id":"Contact ID",
  4. "contact_name":"Firstname Lastname",
  5. "company_id":"Company ID if the contact assigned to a company",
  6. "company_name":"Company Name of the contact",
  7. "owner_id":"User ID of the contact owner"
  8. "message_id":"unique ID for the message"
  9. }
  10. ------OR------
  11. {
  12. "error_message":"error message"
  13. }