Protocol Description


Table of Contents:

»  General Description »  Transaction Types »  Transaction Type Codes »  Detailed Description of Each Transaction Type »  Examples

General Description:

Packetera allows client applications to securely connect directly to the Packetera Application/Web Server and submit transaction data. All requests will be initiated by the client. The client submits the data in one of the two ways Https-Post or Https-Get. The Https Post/Get must consists of a set of fields that are required for each transaction, and a set of fields that are optional.

The Client has the option of sending the configuration of the response on a per-transaction basis or using the default settings. The server responds a Name/Value pairs according to the client configuration. The 'Name' is the field name and indicates what information is being submitted and the 'Value' contains the content of the field.

To implement, a developer would design a script that does the following:

To Get and Post:

  1. Obtains all of the information needed to process a transaction. http://74.208.106.185/testinglivememberapi/cbc_APIs.aspx
  2. Initiates a secure Https Post/Get from their server.
  3. Receives the response from the gateway and processes the response to display the appropriate result to the end user.
Do not forget to contact Packetera Technology Labs to get a web services login account when you are ready for development.
Back to Top

Transaction Types:

This section describes the possible transaction types and details of each request and each response.

Each of the table contains following headings and their significance is as follows:

Following are the data fields that must be submitted to the system with every type of transaction.There are some exceptional API's which does not

need following data fields to be added while calling . In the brief descriptoin of each API it will be mentioned if following data fields are not to be added.

Field Name Required Field Type Description
WebUserName Yes string(20) Unique identifier to each client to access the Web Services. Packetera will provide this identifier to the client.
WebUserPassword Yes string(20) Password for the user_id. Packetera will provide this identifier to the client.
UserEmail Yes string(30) Email id of the end user
UserPassword Yes string (30) Password for validation
Back to Top

Transaction Type Codes:

Code Transaction Type Description
Member Profile API's
1101 AddNewCard This will create new member.
1303 GetMemberProfile This API can be used to get the information for a specific member.
1201 UpdateMemberProfileAPI This API can be used to update member profile.
Account Activation API's
2302 GetActivationLink To get Activation Link.
2304 GetActivationID To retrive activationid for user which will be used by the directory customer.
2203 ActivateMemberAccount To activate user account using activationID
Web Button API's
3307 GetDefaultButtonCode This will be called by the directory customer to get the URL to display teleform
3305 GetDefaultBtnHTMLPublishLink To get HTML publish code for default button.(for directory customer)
3306 GetDefaultBtnJavaScriptPublishLink To get JavaScript publish code for default button.(for directory customer)
3308 GetHtmlPublishLink To get HTML publish code for specified button.
3309 GetJavaScriptPublishLink To get JavaScript publish code for specified button.
3101 AddNewWebButton To add new webbutton.
3202 UpdateWebButton To change button name and associated phone
3210 UpdateWebButtonAttribute To change WebButtonAttribute.
3404 DeleteWebButton To delete webbutton.
PhoneNumber API's
4101 AddNewPhoneNumber To add a new phone number.
4202 UpdatePhone To update phone nnumber.
4404 DeletePhoneNumber To delete a phone number.
Teleform API's
5202 UpdateTeleformAttribute To update teleform attribute.
5202 ChangeTemplate insertcommentUpdateTeleformAttribute
Back to Top

Detailed Description for Each Transaction Code:



1101 AddNewCard

This API can be used for creating a new member with following fields. The phone number provided here will be used as a default phone number.

Input Parameters:

Field Name Required Field Type Description
TransactionType Yes Integer Constant Value = 1101
FirstName Yes String(20) First Name of the end user
LastName Yes String(20) Last Name of the end user
PhoneNumber Yes String (20) At least one phone number is necessary to use the service
Corporate Yes Boolean Type of customer. Yes stands for Corporate , No stands for Individual
CompanyName Yes (if corporate) String(20) Company name
Company_URL Yes (if corporate) String(50) Company url
ReferBy Optional Yes To get the reference from which user found this service
Country Optional String(50) Country of end user
State Optional String(50) State of end user
City Optional String(20) City of end user

Sample input URL :

http://74.208.106.185/testinglivememberapi/cbc_APIs.aspx?TransactionType=1101&WebUserName=jonathan123&WebUserPassword=jonathan123&UserEmail=testuser@packetera.com&UserPassword=testuser& FirstName=testuser&LastName=testuser&PhoneNumber=9867657657&Corporate=NO&ReferBy=ALLUS&Country=canada&State=british columbia&City=vancouver

Output String :

Back to Top

1303 GetMemberProfile

This API can be used to get the information for a specific member. The member information contains profile ,webbutton,teleform,phonenumber information.

Input Parameters:

Field Name Required Field Type Description
TransactionType Yes Integer Constant Value = 1303

Sample input URL:

http://74.208.106.185/testinglivememberapi/cbc_APIs.aspx?TransactionType=1303&WebUserName=jonathan123&WebUserPassword=jonathan123&UserEmail=testuser@packetera.com&UserPassword=testuser

Output String:

Back to Top

1202 UpdateMemberProfile

This API can be used to update the personal information like firstname and last name for member.

Input Parameters:

Field Name Required Field Type Description
TransactionType Yes Integer Constant Value=1202
FirstName Optional String(50) First name end user
LastName Optional String(50) Last name of end user

Sample input URL :

http://74.208.106.185/testinglivememberapi/cbc_APIs.aspx?TransactionType=1202&WebUserName=jonathan123&WebUserPassword=jonathan123&UserEmail=testuser@packetera.com&UserPassword=testuser&FirstName=testuser1&LastName=testuser1

Successful Output String:

Back to Top

2302 GetActivationLink

This API can be used to get the activation link for the end users whose email validation is not complete. After calling AddnewCard, this API will follow. Then output of this link will be send to member's email id. when user will click on this activation link ,member activation will be done.

Input Parameters:

Field Name Required Field Type Description
TransactionType Yes Integer Constant Value = 2302

Sample input URL :

http://74.208.106.185/testinglivememberapi/cbc_APIs.aspx?TransactionType=2302&WebUserName=jonathan123&WebUserPassword=jonathan123&UserEmail=testuser@packetera.com&UserPassword=testuser

Output String:

Back to Top

2304 GetActivationID

This API will be called by directory customer (for the customers whose email id has been already verified ),This APi can be called immediately after AddNewCard then GetActivationID will returned which will be given to ActivateMemberAccount API.

Input Parameters:

Field Name Required Field Type Description
TransactionType Yes Integer Constant Value = 2304

Sample input URL :

http://74.208.106.185/testinglivememberapi/cbc_APIs.aspx?TransactionType=2304&WebUserName=jonathan123&WebUserPassword=jonathan123&UserEmail=testuser@packetera.com&UserPassword=testuser

Output String:

Back to Top

2203 ActivateMemberAccount

This API is used to Activate the end user using ActivationID.

The mandatory fields should not be included in this API, This API will only contain the ActivationId as shown in example.


Input Parameters:

Field Name Required Field Type Description
ActivationId Yes String (40) ActivationId which is returned by GetActivationID API.

Sample input URL :

http://74.208.106.185/testinglivememberapi/cbc_APIs.aspx?ActivationId=3958F16D-A43E-41E5-B5B0-6B4A5EC63B3E

Output String:

Back to Top

3307 GetDefaultButtonCode

This API can be called to get URL to display teleform for directory customer.

Input Parameters:

Field Name Required Field Type Description
TransactionType Yes Integer Constant Value = 3307

Sample input URL :

http://74.208.106.185/testinglivememberapi/cbc_APIs.aspx?TransactionType=3307&WebUserName=jonathan123&WebUserPassword=jonathan123&UserEmail=testuser@packetera.com&UserPassword=testuser

Output String:

3305 GetDefaultBtnHtmlPublishLinkAPI

This API return HTML code , Which can be used to publish webbutton.(Only for directory customer)

Input Parameters:

Field Name Required Field Type Description
TransactionType Yes Integer Constant Value = 3305

Sample input URL :

http://74.208.106.185/testinglivememberapi/cbc_APIs.aspx?TransactionType=3305&WebUserName=jonathan123&WebUserPassword=jonathan123&UserEmail=testuser@packetera.com&UserPassword=testuser

Output String:

Back to Top

3306 GetDefaultBtnJavaScriptPublishLink

This API return JavaScript code , Which can be used to publish webbutton.(Only for directory customer)

Input Parameters:

Field Name Required Field Type Description
TransactionType Yes Integer Constant Value = 3306

Sample input URL :

http://74.208.106.185/testinglivememberapi/cbc_APIs.aspx?TransactionType=3306&WebUserName=jonathan123&WebUserPassword=jonathan123&UserEmail=testuser@packetera.com&UserPassword=testuser

Output String:

Back to Top

3308 GetHtmlPublishLink

This API return HTML code , Which can be used to publish webbutton.

Input Parameters:

Field Name Required Field Type Description
TransactionType Yes Integer Constant Value = 3308
ButtonGUID Yes String (40) GUID for the button

Sample input URL :

http://74.208.106.185/testinglivememberapi/cbc_APIs.aspx?TransactionType=3308&WebUserName=jonathan123&WebUserPassword=jonathan123&UserEmail=testuser@packetera.com&UserPassword=testuser&ButtonGUID=EA1453C1-A4B4-4872-B9A9-4BF03124DAB7

Output String:

Back to Top

3309 GetJavaScriptPublishLink

This API return JavaScript code , Which can be used to publish webbutton.

Input Parameters:

Field Name Required Field Type Description
TransactionType Yes Integer Constant Value = 3309
ButtonGUID Yes String (40) GUID for the button

Sample input URL :

http://74.208.106.185/testinglivememberapi/cbc_APIs.aspx?TransactionType=3309&WebUserName=jonathan123&WebUserPassword=jonathan123&UserEmail=testuser@packetera.com&UserPassword=testuser&ButtonGUID=EA1453C1-A4B4-4872-B9A9-4BF03124DAB7

Output String:

Back to Top

3101 AddNewWebButton

To add a new webbutton , which is associated with default phone number

Input Parameters:

Field Name Required Field Type Description
TransactionType Yes Integer Constant Value = 3101

Sample input URL :

http://74.208.106.185/testinglivememberapi/cbc_APIs.aspx?TransactionType=3101&WebUserName=jonathan123&WebUserPassword=jonathan123&UserEmail=testuser@packetera.com&UserPassword=testuser

Output String:

Back to Top

3202 UpdateWebButton

This API is used to update button name and it's associated phone number with existing phonenumber.

Input Parameters:

Field Name Required Field Type Description
TransactionType Yes Integer Constant Value = 3202
ButtonGUID Yes String (40) GUID for the Webbutton
PhoneNumber Optional String (20) Phonenumber to be associated with webbutton
ButtonName Optional String (20) New button name for the webbutton

Sample input URL :

http://74.208.106.185/testinglivememberapi/cbc_APIs.aspx?TransactionType=3202&WebUserName=jonathan123&WebUserPassword=jonathan123&UserEmail=testuser@packetera.com&UserPassword=testuser&ButtonGUID=E633AC9D-B56F-4BE9-9EB6-F703E429C738&ButtonName=newBtnName&PhoneNumber=9867657657

Output String:

Back to Top

3210 UpdateWebButtonAttribute

This API can be called to update button attributes like button image URL , button type etc.

Input Parameters:

Field Name Required Field Type Description
TransactionType Yes Integer Constant Value = 3210
ButtonGUID Yes String (40) GUID for the Webbutton
AttributeName Optional String(20) Refer to the following attribute name and value table
AttributeValue Optional String100) Refer to the following attribute name and value table

Attribute name and value table
Attribute Name Attribute Vlaue
Type 1 = text button 2 = image button
URL Url of button image if type = 2
LinkText Link text if button type = 1
ToolTips Tool tip for button

Sample input URL :

http://74.208.106.185/testinglivememberapi/cbc_APIs.aspx?TransactionType=3210&WebUserName=jonathan123&WebUserPassword=jonathan123&UserEmail=testuser@packetera.com&UserPassword=testuser&ButtonGUID=E633AC9D-B56F-4BE9-9EB6-F703E429C738&AttributeName=URL&AttributeValue=http://packeteracbc-com.web21.winsvr.net/24x7/images/but1.gif

Output String:

Back to Top

3404 DeleteWebButton

This API can be called to delete webbutton using button GUID obtained from GetMemberProfile API.

Input Parameters:

Field Name Required Field Type Description
TransactionType Yes Integer Constant Value = 3404
ButtonGUID Yes String (40) GUID for the Webbutton

Sample input URL :

http://74.208.106.185/testinglivememberapi/cbc_APIs.aspx?TransactionType=3404&WebUserName=jonathan123&WebUserPassword=jonathan123&UserEmail=testuser@packetera.com&UserPassword=testuser&ButtonGUID=EA1453C1-A4B4-4872-B9A9-4BF03124DAB7

Output String:

Back to Top

4101 AddNewPhoneNumber

This API can be called to add new phone number which will attach default phone rules with it.

Input Parameters:

Field Name Required Field Type Description
TransactionType Yes Integer Constant Value = 4101
PhoneNumber Yes String (20) Phone number to add
PhoneName Yes String (20) Phone name given to number

Sample input URL :

http://74.208.106.185/testinglivememberapi/cbc_APIs.aspx?TransactionType=4101&WebUserName=jonathan123&WebUserPassword=jonathan123&UserEmail=testuser@packetera.com&UserPassword=testuser&PhoneName=addedPhone&PhoneNumber=9676576532

Output String:

Back to Top

4202 UpdatePhone

This API can be called to update phone number and phone name.

Input Parameters:

Field Name Required Field Type Description
TransactionType Yes Integer Constant Value =4202
PhoneNumber Yes String(20) Existing phone number to update
NewPhoneNumber Optional String(20) New Phone number
NewPhoneName Optional String(20) New Phone name

Sample input URL :

http://74.208.106.185/testinglivememberapi/cbc_APIs.aspx?TransactionType=4202&WebUserName=jonathan123&WebUserPassword=jonathan123&UserEmail=testuser@packetera.com&UserPassword=testuser&PhoneNumber=9676576532&NewPhoneName=myphone&NewPhoneNumber=9866442233

Output String:

Back to Top

4404 DeletePhoneNumber

This API can be called to delete a phone number.

Input Parameters:

Field Name Required Field Type Description
TransactionType Yes Integer Constant Value =4404
PhoneNumber Yes String(20) Phone number to delete

Sample input URL :

http://74.208.106.185/testinglivememberapi/cbc_APIs.aspx?TransactionType=4404&WebUserName=jonathan123&WebUserPassword=jonathan123&UserEmail=testuser@packetera.com&UserPassword=testuser&PhoneNumber=9866442233

Output String:

Back to Top

5202 UpdateTeleformAttribute

This API can be called to update teleform attribute .

Input Parameters:

Field Name Required Field Type Description
TransactionType Yes Integer Constant Value = 5202
ButtonGUID Yes String(40) Button GUID
AttributeName Optional String(20) Refer to the following attribute name and value table
AttributeValue Optional String100) Refer to the following attribute name and value table

Attribute name and value table
Attribute Name Attribute Vlaue
width Width of teleform
height Height of teleform
headerimage Header Image of teleform
backgroundcolour Background colour of teleform
footerimage Footer Image of teleform

Sample input URL :

http://74.208.106.185/testinglivememberapi/cbc_APIs.aspx?TransactionType=5202&WebUserName=jonathan123&WebUserPassword=jonathan123&UserEmail=testuser@packetera.com&UserPassword=testuser&ButtonGUID=E633AC9D-B56F-4BE9-9EB6-F703E429C738&AttributeName=width&AttributeValue=500

Output String:

Back to Top