Consultation call
PUT {{httptype}}://{{IP}}/mot/{{miralixAccount}}/agents/{{identificationType}}/{{TypeID}}/call/Consultation?ContactEndpoint=103
Miralix OfficeTeam informs the agent’s client, to put the ongoing call on hold, and make a new call to the destination.
HTTP PUT: /agents/{identificationType}/{identification}/call/Consultation?ContactEndpoint={contactEndpoint}
| Parameter | Value | Description |
|---|---|---|
| identificationType | sipUri, id, email, syncId | Different identification types, that can be used to identify an agent |
| identification | String | The identification value must match the selected identification type. So, if identificationType is set to email, then the identification value must match an agent's email |
| contactEndpoint | String | Telephone number to which the agent must make a consultation call |
Example
https://192.168.1.10/mot/greenbox/agents/id/12/call/consultation?ContactEndpoint=+4583509040 - OfficeTeam service informs the agent with id 12, to put the ongoing call on hold, and make a new call to +4583509040. https://192.168.1.10/mot/greenbox/agents/email/derek.a@company.local/call/consultation?ContactEndpoint=+4583509040 - OfficeTeam service informs the agent with email derek.a@company.local, to put the ongoing call on hold, and make a new call to +4583509040. https://192.168.1.10/mot/greenbox/agents/syncId/f4fd9e5f-017d-4350-adf8-8dd811bc1a2e/call/consultation?ContactEndpoint=+4583509040 - OfficeTeam service informs the agent with syncId f4fd9e5f-017d-4350-adf8-8dd811bc1a2e, to put the ongoing call on hold, and make a new call to +4583509040.
Result
Miralix OfficeTeam informs the agent’s client, to put the ongoing call on hold, and make a new call to the destination. * 200 OK - A request to put the current call on hold, and make a new call, is sent to the agent's client. * 400 Bad Request - One or more parameters are not valid. * 404 Not Found - No agent was found with the specified identification. * 500 Internal Server Error - Internal processing error.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
ContactEndpoint | number | Telephone number to which the agent must make a consultation call |