Moxi Works Platform Contact entities represent an agent’s contacts in the Moxi Works Platform. More...

Inheritance diagram for MoxiWorks.Platform.ContactService:

Public Member Functions
	ContactService (IMoxiWorksClient client)

async Task< Response< Contact > >	GetContactAsync (string agentId, AgentIdType agentIdType, string partnerContactId)
	Returns the specified Contact if it exist. More...

async Task< Response< Contact > >	CreateContactAsync (Contact contact)
	Create and returns a new Contact. More...

async Task< Response< Contact > >	UpdateContactAsync (Contact contact)
	Update an existing contact More...

async Task< Response< ContactResults > >	GetContactsAsync (string agentId, AgentIdType agentIdType, string emailAddress=null, string contactName=null, string phoneNumber=null, DateTime? updatedSince=null, int pageNumber=1)
	Gets Contact through the specified ID type. More...

async Task< Response< ContactResults > >	GetContactResultsAgentUuidAsync (string AgentId, string emailAddress=null, string contactName=null, string phoneNumber=null, DateTime? updatedSince=null, int pageNumber=1)
	Gets Contact through the AgentUuid. More...

async Task< Response< ContactResults > >	GetContactResultsMoxiWorksAgentIdAsync (string AgentId, string emailAddress=null, string contactName=null, string phoneNumber=null, DateTime? updatedSince=null, int pageNumber=1)
	Gets Contact through the MoxiWorksAgentId. More...

async Task< Response< ContactResults > >	GetContactsUpdatedSinceAsync (string agentId, AgentIdType agentIdType, string emailAddress=null, string contactName=null, string phoneNumber=null, DateTime? updatedSince=null, int pageNumber=1)
	Gets Contact either through the AgentUuid or MoxiWorksAgentId. More...

Properties
IMoxiWorksClient	Client `[get, set]`

Properties inherited from MoxiWorks.Platform.Interfaces.IContactService
IMoxiWorksClient	Client `[get, set]`

Detailed Description

Moxi Works Platform Contact entities represent an agent’s contacts in the Moxi Works Platform.

Member Function Documentation

◆ CreateContactAsync()

async Task<Response<Contact> > MoxiWorks.Platform.ContactService.CreateContactAsync ( Contact contact )

Create and returns a new Contact.

Parameters

contact Contact to create.

Returns: a Contact Response

Implements MoxiWorks.Platform.Interfaces.IContactService.

◆ GetContactAsync()

async Task<Response<Contact> > MoxiWorks.Platform.ContactService.GetContactAsync	(	string	agentId,
		AgentIdType	agentIdType,
		string	partnerContactId
	)

Returns the specified Contact if it exist.

Parameters

agentId Must include either: AgentUuid This is the Moxi Works Platform ID of the agent which an Contact entry is associated with. This will be an RFC 4122 compliant UUID. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your Contact request to be accepted.

MoxiWorksAgentId This is the Moxi Works Platform ID of the agent which an Contact entry is associated with. This will be a string that may take the form of an email address, or a unique identification string. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your Contact request to be accepted. Agent ID for your Contact request to be accepted.

Parameters

agentIdType	What agentId type you are using.
partnerContactId	This is the unique identifer you use in your system that has been associated with the Contact that you are finding.

Returns: Conact Response empty if contact not found

Implements MoxiWorks.Platform.Interfaces.IContactService.

◆ GetContactResultsAgentUuidAsync()

async Task<Response<ContactResults> > MoxiWorks.Platform.ContactService.GetContactResultsAgentUuidAsync	(	string	AgentId,
		string	emailAddress = `null`,
		string	contactName = `null`,
		string	phoneNumber = `null`,
		DateTime?	updatedSince = `null`,
		int	pageNumber = `1`
	)

Gets Contact through the AgentUuid.

Parameters

agentId	AgentUuid This is the Moxi Works Platform ID of the agent which an ActionLog entry is associated with. This will be an RFC 4122 compliant UUID. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your ActionLog request to be accepted.
emailAddress	An email address associated with the Contact record. May be primary or secondary.
contactName	The full name of the contact which you are trying to find the Contact record for.
phoneNumber	A phone number associated with the Contact record. May be primary or secondary.
updatedSince	Paged responses of all Contact objects updated after this Unix timestamp will be returned in the response.
pageNumber	Page of Contact records to return. Use if total_pages indicates that there is more than one page of data available.

Returns: response of contacts

Implements MoxiWorks.Platform.Interfaces.IContactService.

◆ GetContactResultsMoxiWorksAgentIdAsync()

async Task<Response<ContactResults> > MoxiWorks.Platform.ContactService.GetContactResultsMoxiWorksAgentIdAsync	(	string	AgentId,
		string	emailAddress = `null`,
		string	contactName = `null`,
		string	phoneNumber = `null`,
		DateTime?	updatedSince = `null`,
		int	pageNumber = `1`
	)

Gets Contact through the MoxiWorksAgentId.

Parameters

agentId	MoxiWorksAgentId This is the Moxi Works Platform ID of the agent which an ActionLog entry is associated with. This will be a string that may take the form of an email address, or a unique identification string. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your ActionLog request to be accepted. Agent ID for your ActionLog request to be accepted.
emailAddress	An email address associated with the Contact record. May be primary or secondary.
contactName	The full name of the contact which you are trying to find the Contact record for.
phoneNumber	A phone number associated with the Contact record. May be primary or secondary.
updatedSince	Paged responses of all Contact objects updated after this Unix timestamp will be returned in the response.
pageNumber	Page of Contact records to return. Use if total_pages indicates that there is more than one page of data available.

Returns: response of contacts

Implements MoxiWorks.Platform.Interfaces.IContactService.

◆ GetContactsAsync()

async Task<Response<ContactResults> > MoxiWorks.Platform.ContactService.GetContactsAsync	(	string	agentId,
		AgentIdType	agentIdType,
		string	emailAddress = `null`,
		string	contactName = `null`,
		string	phoneNumber = `null`,
		DateTime?	updatedSince = `null`,
		int	pageNumber = `1`
	)

Gets Contact through the specified ID type.

Parameters

agentId	AgentUuid This is the Moxi Works Platform ID of the agent which an ActionLog entry is associated with. This will be an RFC 4122 compliant UUID. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your ActionLog request to be accepted.
emailAddress	An email address associated with the Contact record. May be primary or secondary.
contactName	The full name of the contact which you are trying to find the Contact record for.
phoneNumber	A phone number associated with the Contact record. May be primary or secondary.
updatedSince	Paged responses of all Contact objects updated after this Unix timestamp will be returned in the response.
pageNumber	Page of Contact records to return. Use if total_pages indicates that there is more than one page of data available.

Returns: response of contacts

Implements MoxiWorks.Platform.Interfaces.IContactService.

◆ GetContactsUpdatedSinceAsync()

async Task<Response<ContactResults> > MoxiWorks.Platform.ContactService.GetContactsUpdatedSinceAsync	(	string	agentId,
		AgentIdType	agentIdType,
		string	emailAddress = `null`,
		string	contactName = `null`,
		string	phoneNumber = `null`,
		DateTime?	updatedSince = `null`,
		int	pageNumber = `1`
	)

Gets Contact either through the AgentUuid or MoxiWorksAgentId.

Parameters

agentId Must include either: AgentUuid This is the Moxi Works Platform ID of the agent which an ActionLog entry is associated with. This will be an RFC 4122 compliant UUID. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your ActionLog request to be accepted.

MoxiWorksAgentId This is the Moxi Works Platform ID of the agent which an ActionLog entry is associated with. This will be a string that may take the form of an email address, or a unique identification string. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your ActionLog request to be accepted. Agent ID for your ActionLog request to be accepted.

Parameters

emailAddress	An email address associated with the Contact record. May be primary or secondary.
contactName	The full name of the contact which you are trying to find the Contact record for.
phoneNumber	A phone number associated with the Contact record. May be primary or secondary.
updatedSince	Paged responses of all Contact objects updated after this Unix timestamp will be returned in the response.
pageNumber	Page of Contact records to return. Use if total_pages indicates that there is more than one page of data available.

Returns: response of contacts

Implements MoxiWorks.Platform.Interfaces.IContactService.

◆ UpdateContactAsync()

async Task<Response<Contact> > MoxiWorks.Platform.ContactService.UpdateContactAsync ( Contact contact )

Update an existing contact

Parameters

contact Contact to update

Returns: a Contact response.

Implements MoxiWorks.Platform.Interfaces.IContactService.

The documentation for this class was generated from the following file:

ContactService.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ CreateContactAsync()

◆ GetContactAsync()

◆ GetContactResultsAgentUuidAsync()

◆ GetContactResultsMoxiWorksAgentIdAsync()

◆ GetContactsAsync()

◆ GetContactsUpdatedSinceAsync()

◆ UpdateContactAsync()