MoxiWorks.Platform.GroupService Class Reference

Moxi Works Platform Group entities represent groupings of an agent’s contacts. More...

Inheritance diagram for MoxiWorks.Platform.GroupService:

Public Member Functions
	GroupService (IMoxiWorksClient client)
async Task< Response< Group > >	GetGroupAsync (string agentId, AgentIdType agentIdType, string moxiWorksGroupId)
	Get Single Group More...
async Task< Response< ICollection< GroupItem > > >	GetGroupsAsync (string agentId, AgentIdType agentIdType, string name=null)
	When searching for Group objects using the Moxi Works platform API, format your data using the following parameters. More...

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

Detailed Description

Moxi Works Platform Group entities represent groupings of an agent’s contacts.

Member Function Documentation

GetGroupAsync()

async Task<Response<Group> > MoxiWorks.Platform.GroupService.GetGroupAsync	(	string	agentId,
		AgentIdType	agentIdType,
		string	moxiWorksGroupId
	)

Get Single Group

Parameters

agentId

Must include either: AgentUuid This is the Moxi Works Platform ID of the agent which an Group 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 Group request to be accepted.

MoxiWorksAgentId This is the Moxi Works Platform ID of the agent which an Group 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 Group request to be accepted. Agent ID for your Group request to be accepted.

Parameters

agentIdType	What agentId type you are using.
moxiWorksGroupId	This is the name of a Group to be shown

Returns

Implements MoxiWorks.Platform.Interfaces.IGroupService.

GetGroupsAsync()

async Task<Response<ICollection<GroupItem> > > MoxiWorks.Platform.GroupService.GetGroupsAsync	(	string	agentId,
		AgentIdType	agentIdType,
		string	name = null
	)

When searching for Group objects using the Moxi Works platform API, format your data using the following parameters.

Parameters

agentId

Must include either: AgentUuid This is the Moxi Works Platform ID of the agent which an Group 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 Group request to be accepted.

MoxiWorksAgentId This is the Moxi Works Platform ID of the agent which an Group 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 Group request to be accepted. Agent ID for your Group request to be accepted.

Parameters

agentIdType	What agentId type you are using.
name	This is the name of a Group to be searched for.

Returns

Implements MoxiWorks.Platform.Interfaces.IGroupService.

---

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

• GroupService.cs