3.3.2. Method getVoiceRecordStatus

The method getVoiceRecordStatus returns the status of the voice call data object and the call establishment process. Due to the asynchronous nature of the createVoiceRecord method, the getVoiceRecordStatus method has to be used in order to check if the call could be established successfully or not. The method returns whether the call is queued for execution, whether the phone is ringing, whether the callee did not answer, whether the recording of the voice call data object is in progress, was finished successfully or was aborted by the callee. This method is called best within a loop prior to accessing the voice call data object with the getVoiceRecord method.

Table 3.4. Parameter list of method getVoiceRecordStatus

NameDescription

mediaObjRef

Unique reference to a voice call data object.


Table 3.5. Response of method getVoiceRecordStatus

NameDescription

mediaObjStatus

Status of the voice call data object:

  • Queued

    Outbound call is queued for execution.

  • Recording

    Recording of the voice call data object is in progress.

  • Finished

    Recording of the voice call data object has been finished normally.

  • Aborted

    Recording of the voice call data object has been aborted by the callee.

  • Error

    An error occurred during recording of the voice call data object.


Table 3.6. Exceptions of method getVoiceRecordStatus

NameDescription
invalidMediaObjRefThe mediaObjRef is invalid and does not point to a valid voice call data object.
internalErrorInternal system error.


Download API Documentation