User Tools

Site Tools


api:pbx:voicemail:transcribeauto

API : PBX : Voicemail Transcribe auto (M2M)

Request

This request is invoked by the PBX servers when a caller has left a new message on an employee's voicemail and the employee's voicemail.transcribe is TRANSCRIBE or TRANSCRIBE_AND_SUMMARIZE (see Employee update). The PBX has stored the message and hung up the caller; it invokes this request before it sends the e-mail about the new message.

  • The message is transcribed, and with TRANSCRIBE_AND_SUMMARIZE also summarized by AI, in the employee's language. This is paid from the customer's AI allowance. A message that is already transcribed is not transcribed again.
  • The transcription and the summary are stored on the message: transcription, transcriptionLanguage and ai, see Get.
  • When the employee receives e-mail on new messages (voicemail.notification.email), the API sends that e-mail: who called and when, the AI summary, its calendar events (each attached as an .ics file), the sensitivity, the transcription and the message as MP3. It is the message template voicemailToEmail, see Message templates, in English for an employee whose language is English and otherwise in Danish. The response then has emailed true, and the PBX sends no e-mail of its own.
  • An allowance that is used up, or a transcription or summary that fails, never holds the e-mail back: it is sent without that part and says why.
  • When the API does not send the e-mail - the employee receives no e-mail, it could not be sent, or the request fails - the PBX sends its own e-mail about the new message, without transcription and summary.
URL https://api.telecomx.dk/pbx/voicemail/VOICEMAIL_ID/transcribe/auto
Method GET
Access level None - may only be invoked from PBX server IP addresses.
Param VOICEMAIL_ID Id Id of the new message (24 hex-char string).

Query examples

https://api.telecomx.dk/pbx/voicemail/12345678901234567890AAAA/transcribe/auto

Response

JSON object
success Boolean True on success.
transcribe String The employee's voicemail.transcribe: DISABLED, TRANSCRIBE or TRANSCRIBE_AND_SUMMARIZE. With DISABLED nothing is done.
emailed Boolean True when the API has sent the e-mail about the new message. False when the PBX shall send its own.

Example

{
  success: true,
  transcribe: 'TRANSCRIBE_AND_SUMMARIZE',
  emailed: true
}

Errors

Error code Message Description
403 access_denied Not invoked from a PBX server
404 not_found Voicemail not found
404 employee Employee not found
422 id Invalid ObjectId
500 internal_error <Unspecified>
api/pbx/voicemail/transcribeauto.txt · Last modified: by Telecom X AI

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki