Real-time Control/Payload Control/PSDK Device

Dispatch PSDK Command

Passthrough-dispatch commands to specified PSDK (Payload SDK) device in project; used to control PSDK business (e.g. speaker playback, third-party payload operations, etc.). device_cmd_method and device_cmd_data determined by specific PSDK device's thing model; server does not perform enum validation; serves as passthrough channel as a whole. ext field used for business tracking (speaker scenario playback parameters are written to server-side command log). Device must belong to current project.

post/openapi/v2.0/manage/api/v1/projects/{uuid}/psdk/commands

Request

  • Base URL
    https://41b04hdzmc.apifox.cn (the document declares no server; this is the origin it was published from)
  • URL
    https://41b04hdzmc.apifox.cn/openapi/v2.0/manage/api/v1/projects/{uuid}/psdk/commands
  • Auth
    none required

Path parameters

uuidstring required

Project UUID

Headers

x-user-tokenstring required

User Login Session Token (client invocation credential for on-premises deployment)

X-Request-Idstring uuid

Client-Generated Request Trace ID (UUID v4 recommended), used for cross-service log correlation and troubleshooting

X-Project-Uuidstring required

Project UUID

Request body

device_snstring required

Target PSDK Device SN (aircraft or dock; must belong to current project)

device_cmd_methodstring required

PSDK Command Method Name. Values determined by specific PSDK device's thing model; server does not perform enum validation; passed through as a whole. Common speaker scenario commands reference: speaker_audio_play_start / speaker_audio_play_stop / speaker_volume_set / speaker_play_mode_set / speaker_tts_play

device_cmd_dataobject

Command Parameters, structure determined by device_cmd_method (passthrough). Omit or pass {} when no additional parameters

need_user_verifyboolean

Whether to Require User Identity Re-Verification (sensitive operation scenarios), default false

Response

Operation Successful

codeinteger required

Business Status Code: 0=Success; non-zero=Error Code (see message for meaning)

messagestring

Error Description Message (Omitted on Success)

dataunknown

Changes

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