Voice Messages

Voice announcement system for pods.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returns a VoiceMessageCollection

application/json

_totalnumberRequired

get/voice-messages

GET /apis/v2/voice-messages HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Returns a VoiceMessageCollection

{
  "items": [
    {
      "id": "text",
      "displayName": "text",
      "message": "text",
      "url": "text",
      "_links": {
        "self": {
          "href": "text"
        }
      }
    }
  ],
  "_total": 1,
  "_links": {
    "self": {
      "href": "text"
    }
  }
}

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

idstringRead-onlyRequired

displayNamestringRequired

messagestringRequired

urlstringRequired

Responses

201

Returns a VoiceMessage

application/json

idstringRead-onlyRequired

displayNamestringRequired

messagestringRequired

urlstringRequired

post/voice-messages

POST /apis/v2/voice-messages HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "displayName": "text",
  "message": "text",
  "url": "text",
  "_links": {
    "self": {
      "href": "text"
    }
  }
}

201

Returns a VoiceMessage

{
  "id": "text",
  "displayName": "text",
  "message": "text",
  "url": "text",
  "_links": {
    "self": {
      "href": "text"
    }
  }
}

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

Returns a VoiceMessage

application/json

idstringRead-onlyRequired

displayNamestringRequired

messagestringRequired

urlstringRequired

get/voice-messages/{id}

GET /apis/v2/voice-messages/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Returns a VoiceMessage

{
  "id": "text",
  "displayName": "text",
  "message": "text",
  "url": "text",
  "_links": {
    "self": {
      "href": "text"
    }
  }
}