Dialog—Get Dialog

This API allows a user to get a copy of a Dialog object.

URI:

http://<FQDN>/finesse/api/Dialog/<dialogId>

Example URI:

http://finesse1.xyz.com/finesse/api/Dialog/12345678

Security Constraints:

Agents and administrators can use this API.

Agents can only get their own Dialog object. Administrators can get any Dialog object.

HTTP Method:

GET

Content Type:

Application/XML

Input/Output Format:

XML

HTTP Request:

HTTP Response:

200: Success

401: Unauthorized

401: Invalid Authorization

404: Not Found

500: Internal Server Error

Example Response:

<Dialog>
   <uri>/finesse/api/Dialog/12345678</uri>
   <mediaType>Voice</mediaType
   <state>ACTIVE</state>
   <fromAddress>2002</fromAddress>
   <toAddress>2000</toAddress>
   <mediaProperties>
      <dialedNumber>2000</dialedNumber
      <callType>AGENT_INSIDE</callType>
      <DNIS>2000</DNIS>
      <wrapUpReason>Another satisfied customer</wrapUpReason>
      <callvariables>
         <CallVariable>
            <name>callVariable1</name>
            <value>Chuck Smith</value>
         </CallVariable>
         <CallVariable>
            <name>callVariable2</name>
            <value>Cisco Systems, Inc</value>
         </CallVariable>
         <CallVariable>
            <name>callVariable3</name>
            <value>chucksmith@cisco.com</value>
         </CallVariable>
         ...Other Call Variables (up to 10)
         <CallVariable>
            <name>ecc.user</name>
            <value>csmith</value>
         </CallVariable>
         <CallVariable>
            <name>ecc.years[0]</name>
            <value>1985</value>
         </CallVariable>
         <CallVariable>
            <name>ecc.years[1]</name>
            <value>1995</value>
         </CallVariable>
   </mediaProperties>
   <participants>
      <Participant>
         <actions>
            <action>HOLD</action>
            <action>DROP</action>
         </actions>
         <mediaAddress>1081001</mediaAddress>
         <mediaAddressType>AGENT_DEVICE<mediaAddressType>
         <startTime>2014-02-04T15:33:16.653Z</startTime>
         <state>ACTIVE</state>
         <stateCause></stateCause>
         <stateChangeTime>2014-02-04T15:33:26.653Z</stateChangeTime>
      </Participant>
      <Participant>
         <actions>
            <action>RETRIEVE</action>
            <action>DROP</action>
         </actions>
         <mediaAddress>1081002</mediaAddress>
         <mediaAddressType>AGENT_DEVICE<mediaAddressType>
         <startTime>2014-02-04T15:33:16.653Z</startTime>
         <state>HELD</state>
         <stateCause></stateCause>
         <stateChangeTime>2014-02-04T15:33:27.584Z</stateChangeTime>
      </Participant> 
   </participants>     
</Dialog  

Example Failure Response:

<ApiErrors>
   <ApiError>
      <ErrorType>Not Found</ErrorType>
      <ErrorMessage>Invalid dialogId specified for dialog/ErrorMessage>
   </ApiError>
</ApiErrors>