ANangelcam
speakers

Update existing speaker

put/speakers/{speaker_id}/

Request

  • Base URL
    https://api.angelcam.com/v1
  • Auth
    • OAuth 2
      Authorization codehttps://my.angelcam.com/oauth/authorize/, token URL https://my.angelcam.com/oauth/token/
      PasswordToken URL https://api.angelcam.com/oauth/token/
      Scopesspeaker_manage
    • or API key in header Authorization
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body

idinteger required

Speaker ID

namestring required

Speaker name

setup'arrow' required

Speaker connection type

protocol'basic' required

Audio protocol

arrow_clientstring uuid nullable

UUID of arrow client client used for speaker connection, required when setup=arrow

arrow_service_idstring nullable

hexadecimal id of arrow service, can contain leading zeros, required when setup=arrow

endpointstring uri required

Endpoint URL for the speaker

usernamestring
passwordstring

Example request

{
  "id": 157,
  "name": "Angelbox Speaker",
  "setup": "arrow",
  "protocol": "basic",
  "arrow_client": "75b62326-eca3-4424-ab68-48e7da47e847",
  "arrow_service_id": "00af",
  "endpoint": "/api/v1/audio/play"
}

Response

Updated speaker object.

idinteger required

Speaker ID

namestring required

Speaker name

setup'arrow' required

Speaker connection type

protocol'basic' required

Audio protocol

arrow_clientstring uuid nullable

UUID of arrow client client used for speaker connection, required when setup=arrow

arrow_service_idstring nullable

hexadecimal id of arrow service, can contain leading zeros, required when setup=arrow

endpointstring uri required

Endpoint URL for the speaker

usernamestring
passwordstring

Example response

{
  "id": 157,
  "name": "Angelbox Speaker",
  "setup": "arrow",
  "protocol": "basic",
  "arrow_client": "75b62326-eca3-4424-ab68-48e7da47e847",
  "arrow_service_id": "00af",
  "endpoint": "/api/v1/audio/play"
}

Changes

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