C# Class InteractuaMovil.ContactoSms.Api.Contacts

Inheritance: InteractuaMovil.ContactoSms.Api.ApiRequest, interfaces.IContacts

Show file Open project: interactuamovil/im-contactosms-sdk-dotnet

Public Methods

Method	Description
Add ( ContactJson contact ) : ResponseObjects.ApiResponse
Add ( string countryCode, string Msisdn, string FirstName = null, string LastName = null ) : ResponseObjects.ApiResponse	Adds a new contact
Delete ( string msisdn ) : ResponseObjects.ApiResponse	Deletes a contact
GetByMsisdn ( string msisdn ) : ResponseObjects.ApiResponse	Gets a contact by its msisdn
GetGroupList ( string Msisdn ) : ResponseObjects.ApiResponse>	Gets contact's group list
GetList ( List contactStatuses = null, String query = null, int start = -1, int limit = -1, bool shortResults = false ) : ResponseObjects.ApiResponse>	Gets a contact list
Update ( ContactJson contact ) : ResponseObjects.ApiResponse
Update ( string countryCode, string msisdn, string firstName = null, string lastName = null ) : ResponseObjects.ApiResponse	Updates a contact base on its msisdn

Private Methods

Method	Description
Contacts ( string ApiKey, string SecretKey, string ApiUrl ) : System
Contacts ( string ApiKey, string SecretKey, string ApiUrl, string ProxyAddress, string UserName, string Password ) : System

Method Details

Add() public method

public Add ( ContactJson contact ) : ResponseObjects.ApiResponse
contact	ContactJson
return	ResponseObjects.ApiResponse

Add() public method

Adds a new contact

public Add ( string countryCode, string Msisdn, string FirstName = null, string LastName = null ) : ResponseObjects.ApiResponse
countryCode	string
Msisdn	string	country code + phone number
FirstName	string	contacts first name
LastName	string	contacts last name
return	ResponseObjects.ApiResponse

Delete() public method

Deletes a contact

public Delete ( string msisdn ) : ResponseObjects.ApiResponse
msisdn	string
return	ResponseObjects.ApiResponse

GetByMsisdn() public method

Gets a contact by its msisdn

public GetByMsisdn ( string msisdn ) : ResponseObjects.ApiResponse
msisdn	string
return	ResponseObjects.ApiResponse

GetGroupList() public method

Gets contact's group list

public GetGroupList ( string Msisdn ) : ResponseObjects.ApiResponse>
Msisdn	string	Contact's country code + phone number
return	ResponseObjects.ApiResponse>

GetList() public method

Gets a contact list

public GetList ( List contactStatuses = null, String query = null, int start = -1, int limit = -1, bool shortResults = false ) : ResponseObjects.ApiResponse>
contactStatuses	List	a combination of SUSCRIBED, CONFIRMED, CANCELLED, INVITED. Defaults to SUSCRIBED,CONFIRMED
query	String
start	int
limit	int
shortResults	bool	Fetch only msisdn, first and last name
return	ResponseObjects.ApiResponse>

Update() public method

public Update ( ContactJson contact ) : ResponseObjects.ApiResponse
contact	ContactJson
return	ResponseObjects.ApiResponse

Update() public method

Updates a contact base on its msisdn

public Update ( string countryCode, string msisdn, string firstName = null, string lastName = null ) : ResponseObjects.ApiResponse
countryCode	string
msisdn	string
firstName	string
lastName	string
return	ResponseObjects.ApiResponse