customer-engagement
conversations
away-audio-messages

Get away audio message

Use this method to retrieve an away audio message by its working hours configuration id.

get/ccaas/voice/2/away-audio-message/{workingHoursConfigId}

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token

Path parameters

workingHoursConfigIdstring required

Id of the working hours configuration whose away audio message needs to be retrieved.

Response

OK

idstring

Unique ID of the away audio message.

workingHoursConfigIdstring

Id of the working hours configuration.

Example response

{
  "id": "id",
  "workingHoursConfigId": "123",
  "audioSource": {
    "enabled": false,
    "audioSourceType": "TTS",
    "ttsAudioSource": {
      "text": "Random message",
      "language": "en",
      "voice": {
        "name": "Joanna",
        "gender": "female"
      },
      "speechRate": 1.1
    },
    "fileAudioSource": {
      "fileDescriptor": "file-descriptor-id-example"
    }
  },
  "collectables": [
    {
      "code": "1",
      "action": "CALLBACK",
      "value": "62a73f05502423205b2630cc"
    }
  ],
  "collectDuration": {
    "unit": "SECONDS",
    "value": 15
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.