PorticoDocs

Receivers

Generated receivers operations.

GET/v1/receiversManage shared playback for the signed-in profileread
Audience
Clients · Native API
Authorization
API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID
social_get_v1_receivers

Responses

200Successapplication/json

Example
{
  "protocolVersion": "string",
  "receivers": [
    {
      "authorizationRevision": "r12",
      "createdAt": "2026-10-18T19:30:00Z",
      "deviceId": "id_8h2k4q",
      "displayName": "Fargo",
      "grantPolicy": "string",
      "id": "id_8h2k4q",
      "keyFingerprint": "string",
      "kind": "string",
      "lastSeenAt": "2026-10-18T19:30:00Z",
      "platform": "string",
      "presence": "string",
      "state": "string",
      "supportedCommands": [
        "string"
      ]
    }
  ],
  "serverTime": "2026-10-18T19:30:00Z"
}
Schema
  • protocolVersionstringrequired
  • receiversarray of objectrequired
    • authorizationRevisionstringrequired
    • createdAtstringrequired
    • deviceIdstringrequired
    • displayNamestringrequired
    • grantPolicystringrequired
    • idstringrequired
    • keyFingerprintstringrequired
    • kindstringrequired
    • lastSeenAtstringrequired
    • platformstringrequired
    • presencestringrequired
    • statestringrequired
    • supportedCommandsarray of stringrequired
  • serverTimestringrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesunauthorizednot_permittedinternalreceiver_requiredcapacity_reachedcast_access_endedcast_code_consumedcast_code_expiredcast_code_not_foundcast_code_revokedcast_device_expiredcast_device_not_foundcast_device_revokedcast_unavailabledevice_requiredentry_not_foundgrant_not_acceptedgrant_not_pendinggroup_endedgroup_fullhandoff_expiredhandoff_in_progresshandoff_not_readyhandoff_source_conflicthandoff_source_revision_conflicthandoff_state_conflicthost_requiredidempotency_key_reusedinvalid_requestinvite_consumedinvite_expiredinvite_not_foundinvite_revokedinvite_wrong_recipientmedia_no_longer_accessiblemember_not_foundmembership_revokednot_foundparticipant_incompatibleplayback_authority_unavailablequeue_fullrate_limitedreceiver_key_mismatchrevision_conflicttarget_unavailabledatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/receivers" \
  -H "Authorization: Bearer $PORTICO_API_KEY"
POST/v1/receiversManage shared playback for the signed-in profileplayback
Audience
Clients · Native API
Authorization
API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID
social_post_v1_receivers
Max body
256 KiB

Request body application/json · required

Example
{
  "displayName": "Fargo",
  "grantPolicy": "string",
  "keyFingerprint": "string",
  "platform": "string",
  "protocolVersion": "string",
  "publicKey": "string",
  "supportedCommands": [
    "string"
  ]
}
Schema
  • displayNamestringrequired
  • grantPolicystring
  • keyFingerprintstringrequired
  • platformstring
  • protocolVersionstringrequired
  • publicKeystring
  • supportedCommandsarray of string

Responses

201Successapplication/json

Example
{
  "protocolVersion": "string",
  "receiver": {
    "authorizationRevision": "r12",
    "createdAt": "2026-10-18T19:30:00Z",
    "deviceId": "id_8h2k4q",
    "displayName": "Fargo",
    "grantPolicy": "string",
    "id": "id_8h2k4q",
    "keyFingerprint": "string",
    "kind": "string",
    "lastSeenAt": "2026-10-18T19:30:00Z",
    "platform": "string",
    "presence": "string",
    "state": "string",
    "supportedCommands": [
      "string"
    ]
  },
  "serverTime": "2026-10-18T19:30:00Z"
}
Schema
  • protocolVersionstringrequired
  • receiverobjectrequired
    • authorizationRevisionstringrequired
    • createdAtstringrequired
    • deviceIdstringrequired
    • displayNamestringrequired
    • grantPolicystringrequired
    • idstringrequired
    • keyFingerprintstringrequired
    • kindstringrequired
    • lastSeenAtstringrequired
    • platformstringrequired
    • presencestringrequired
    • statestringrequired
    • supportedCommandsarray of stringrequired
  • serverTimestringrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesunauthorizednot_permittedinternalreceiver_requiredcapacity_reachedcast_access_endedcast_code_consumedcast_code_expiredcast_code_not_foundcast_code_revokedcast_device_expiredcast_device_not_foundcast_device_revokedcast_unavailabledevice_requiredentry_not_foundgrant_not_acceptedgrant_not_pendinggroup_endedgroup_fullhandoff_expiredhandoff_in_progresshandoff_not_readyhandoff_source_conflicthandoff_source_revision_conflicthandoff_state_conflicthost_requiredidempotency_key_reusedinvalid_requestinvite_consumedinvite_expiredinvite_not_foundinvite_revokedinvite_wrong_recipientmedia_no_longer_accessiblemember_not_foundmembership_revokednot_foundparticipant_incompatibleplayback_authority_unavailablequeue_fullrate_limitedreceiver_key_mismatchrevision_conflicttarget_unavailabledatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/receivers" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "displayName": "Fargo",
  "grantPolicy": "string",
  "keyFingerprint": "string",
  "platform": "string",
  "protocolVersion": "string",
  "publicKey": "string",
  "supportedCommands": [
    "string"
  ]
}'
DELETE/v1/receivers/{id}Manage shared playback for the signed-in profileplayback
Audience
Clients · Native API
Authorization
API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID
social_delete_v1_receivers_id

Parameters

NameInTypeDescription
idrequiredpathstring

Responses

204Success

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesunauthorizednot_permittedinternalreceiver_requiredcapacity_reachedcast_access_endedcast_code_consumedcast_code_expiredcast_code_not_foundcast_code_revokedcast_device_expiredcast_device_not_foundcast_device_revokedcast_unavailabledevice_requiredentry_not_foundgrant_not_acceptedgrant_not_pendinggroup_endedgroup_fullhandoff_expiredhandoff_in_progresshandoff_not_readyhandoff_source_conflicthandoff_source_revision_conflicthandoff_state_conflicthost_requiredidempotency_key_reusedinvalid_requestinvite_consumedinvite_expiredinvite_not_foundinvite_revokedinvite_wrong_recipientmedia_no_longer_accessiblemember_not_foundmembership_revokednot_foundparticipant_incompatibleplayback_authority_unavailablequeue_fullrate_limitedreceiver_key_mismatchrevision_conflicttarget_unavailabledatabase_busywriter_capacity

Example request

curl -X DELETE "http://127.0.0.1:32500/v1/receivers/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"
GET/v1/receivers/{id}/grantsManage shared playback for the signed-in profileread
Audience
Clients · Native API
Authorization
API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID
social_get_v1_receivers_id_grants

Parameters

NameInTypeDescription
idrequiredpathstring

Responses

200Successapplication/json

Example
{
  "grants": [
    {
      "allowedCommands": [
        "string"
      ],
      "authorizationRevision": "r12",
      "controllerDeviceId": "id_8h2k4q",
      "controllerDisplayName": "Fargo",
      "createdAt": "2026-10-18T19:30:00Z",
      "decidedAt": "2026-10-18T19:30:00Z",
      "expiresAt": "2026-10-18T19:30:00Z",
      "id": "id_8h2k4q",
      "receiverId": "id_8h2k4q",
      "receiverKeyFingerprint": "string",
      "state": "string"
    }
  ],
  "protocolVersion": "string",
  "serverTime": "2026-10-18T19:30:00Z"
}
Schema
  • grantsarray of objectrequired
    • allowedCommandsarray of stringrequired
    • authorizationRevisionstringrequired
    • controllerDeviceIdstringrequired
    • controllerDisplayNamestringrequired
    • createdAtstringrequired
    • decidedAtstring | any | nullrequired
    • expiresAtstringrequired
    • idstringrequired
    • receiverIdstringrequired
    • receiverKeyFingerprintstringrequired
    • statestringrequired
  • protocolVersionstringrequired
  • serverTimestringrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesunauthorizednot_permittedinternalreceiver_requiredcapacity_reachedcast_access_endedcast_code_consumedcast_code_expiredcast_code_not_foundcast_code_revokedcast_device_expiredcast_device_not_foundcast_device_revokedcast_unavailabledevice_requiredentry_not_foundgrant_not_acceptedgrant_not_pendinggroup_endedgroup_fullhandoff_expiredhandoff_in_progresshandoff_not_readyhandoff_source_conflicthandoff_source_revision_conflicthandoff_state_conflicthost_requiredidempotency_key_reusedinvalid_requestinvite_consumedinvite_expiredinvite_not_foundinvite_revokedinvite_wrong_recipientmedia_no_longer_accessiblemember_not_foundmembership_revokednot_foundparticipant_incompatibleplayback_authority_unavailablequeue_fullrate_limitedreceiver_key_mismatchrevision_conflicttarget_unavailabledatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/receivers/{id}/grants" \
  -H "Authorization: Bearer $PORTICO_API_KEY"
POST/v1/receivers/{id}/grantsManage shared playback for the signed-in profileplayback
Audience
Clients · Native API
Authorization
API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID
social_post_v1_receivers_id_grants
Max body
256 KiB

Parameters

NameInTypeDescription
idrequiredpathstring

Request body application/json · required

Example
{
  "controllerDisplayName": "Fargo",
  "keyFingerprint": "string",
  "protocolVersion": "string",
  "requestedCommands": [
    "string"
  ]
}
Schema
  • controllerDisplayNamestring
  • keyFingerprintstring
  • protocolVersionstringrequired
  • requestedCommandsarray of string

Responses

201Successapplication/json

Example
{
  "grant": {
    "allowedCommands": [
      "string"
    ],
    "authorizationRevision": "r12",
    "controllerDeviceId": "id_8h2k4q",
    "controllerDisplayName": "Fargo",
    "createdAt": "2026-10-18T19:30:00Z",
    "decidedAt": "2026-10-18T19:30:00Z",
    "expiresAt": "2026-10-18T19:30:00Z",
    "id": "id_8h2k4q",
    "receiverId": "id_8h2k4q",
    "receiverKeyFingerprint": "string",
    "state": "string"
  },
  "protocolVersion": "string",
  "serverTime": "2026-10-18T19:30:00Z"
}
Schema
  • grantobjectrequired
    • allowedCommandsarray of stringrequired
    • authorizationRevisionstringrequired
    • controllerDeviceIdstringrequired
    • controllerDisplayNamestringrequired
    • createdAtstringrequired
    • decidedAtstring | any | nullrequired
    • expiresAtstringrequired
    • idstringrequired
    • receiverIdstringrequired
    • receiverKeyFingerprintstringrequired
    • statestringrequired
  • protocolVersionstringrequired
  • serverTimestringrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesunauthorizednot_permittedinternalreceiver_requiredcapacity_reachedcast_access_endedcast_code_consumedcast_code_expiredcast_code_not_foundcast_code_revokedcast_device_expiredcast_device_not_foundcast_device_revokedcast_unavailabledevice_requiredentry_not_foundgrant_not_acceptedgrant_not_pendinggroup_endedgroup_fullhandoff_expiredhandoff_in_progresshandoff_not_readyhandoff_source_conflicthandoff_source_revision_conflicthandoff_state_conflicthost_requiredidempotency_key_reusedinvalid_requestinvite_consumedinvite_expiredinvite_not_foundinvite_revokedinvite_wrong_recipientmedia_no_longer_accessiblemember_not_foundmembership_revokednot_foundparticipant_incompatibleplayback_authority_unavailablequeue_fullrate_limitedreceiver_key_mismatchrevision_conflicttarget_unavailabledatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/receivers/{id}/grants" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"controllerDisplayName":"Fargo","keyFingerprint":"string","protocolVersion":"string","requestedCommands":["string"]}'
POST/v1/receivers/{id}/grants/{grantId}/decisionManage shared playback for the signed-in profileplayback
Audience
Clients · Native API
Authorization
API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID
social_post_v1_receivers_id_grants_grantId_decision
Max body
256 KiB

Parameters

NameInTypeDescription
idrequiredpathstring
grantIdrequiredpathstring

Request body application/json · required

Example
{
  "decision": "string",
  "protocolVersion": "string"
}
Schema
  • decisionstringrequired
  • protocolVersionstringrequired

Responses

200Successapplication/json

Example
{
  "grant": {
    "allowedCommands": [
      "string"
    ],
    "authorizationRevision": "r12",
    "controllerDeviceId": "id_8h2k4q",
    "controllerDisplayName": "Fargo",
    "createdAt": "2026-10-18T19:30:00Z",
    "decidedAt": "2026-10-18T19:30:00Z",
    "expiresAt": "2026-10-18T19:30:00Z",
    "id": "id_8h2k4q",
    "receiverId": "id_8h2k4q",
    "receiverKeyFingerprint": "string",
    "state": "string"
  },
  "protocolVersion": "string",
  "serverTime": "2026-10-18T19:30:00Z"
}
Schema
  • grantobjectrequired
    • allowedCommandsarray of stringrequired
    • authorizationRevisionstringrequired
    • controllerDeviceIdstringrequired
    • controllerDisplayNamestringrequired
    • createdAtstringrequired
    • decidedAtstring | any | nullrequired
    • expiresAtstringrequired
    • idstringrequired
    • receiverIdstringrequired
    • receiverKeyFingerprintstringrequired
    • statestringrequired
  • protocolVersionstringrequired
  • serverTimestringrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesunauthorizednot_permittedinternalreceiver_requiredcapacity_reachedcast_access_endedcast_code_consumedcast_code_expiredcast_code_not_foundcast_code_revokedcast_device_expiredcast_device_not_foundcast_device_revokedcast_unavailabledevice_requiredentry_not_foundgrant_not_acceptedgrant_not_pendinggroup_endedgroup_fullhandoff_expiredhandoff_in_progresshandoff_not_readyhandoff_source_conflicthandoff_source_revision_conflicthandoff_state_conflicthost_requiredidempotency_key_reusedinvalid_requestinvite_consumedinvite_expiredinvite_not_foundinvite_revokedinvite_wrong_recipientmedia_no_longer_accessiblemember_not_foundmembership_revokednot_foundparticipant_incompatibleplayback_authority_unavailablequeue_fullrate_limitedreceiver_key_mismatchrevision_conflicttarget_unavailabledatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/receivers/{id}/grants/{grantId}/decision" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"decision":"string","protocolVersion":"string"}'
POST/v1/receivers/{id}/heartbeatManage shared playback for the signed-in profileplayback
Audience
Clients · Native API
Authorization
API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID
social_post_v1_receivers_id_heartbeat
Max body
256 KiB

Parameters

NameInTypeDescription
idrequiredpathstring

Request body application/json · required

Example
{
  "keyFingerprint": "string",
  "protocolVersion": "string"
}
Schema
  • keyFingerprintstringrequired
  • protocolVersionstringrequired

Responses

200Successapplication/json

Example
{
  "protocolVersion": "string",
  "receiver": {
    "authorizationRevision": "r12",
    "createdAt": "2026-10-18T19:30:00Z",
    "deviceId": "id_8h2k4q",
    "displayName": "Fargo",
    "grantPolicy": "string",
    "id": "id_8h2k4q",
    "keyFingerprint": "string",
    "kind": "string",
    "lastSeenAt": "2026-10-18T19:30:00Z",
    "platform": "string",
    "presence": "string",
    "state": "string",
    "supportedCommands": [
      "string"
    ]
  },
  "serverTime": "2026-10-18T19:30:00Z"
}
Schema
  • protocolVersionstringrequired
  • receiverobjectrequired
    • authorizationRevisionstringrequired
    • createdAtstringrequired
    • deviceIdstringrequired
    • displayNamestringrequired
    • grantPolicystringrequired
    • idstringrequired
    • keyFingerprintstringrequired
    • kindstringrequired
    • lastSeenAtstringrequired
    • platformstringrequired
    • presencestringrequired
    • statestringrequired
    • supportedCommandsarray of stringrequired
  • serverTimestringrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesunauthorizednot_permittedinternalreceiver_requiredcapacity_reachedcast_access_endedcast_code_consumedcast_code_expiredcast_code_not_foundcast_code_revokedcast_device_expiredcast_device_not_foundcast_device_revokedcast_unavailabledevice_requiredentry_not_foundgrant_not_acceptedgrant_not_pendinggroup_endedgroup_fullhandoff_expiredhandoff_in_progresshandoff_not_readyhandoff_source_conflicthandoff_source_revision_conflicthandoff_state_conflicthost_requiredidempotency_key_reusedinvalid_requestinvite_consumedinvite_expiredinvite_not_foundinvite_revokedinvite_wrong_recipientmedia_no_longer_accessiblemember_not_foundmembership_revokednot_foundparticipant_incompatibleplayback_authority_unavailablequeue_fullrate_limitedreceiver_key_mismatchrevision_conflicttarget_unavailabledatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/receivers/{id}/heartbeat" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"keyFingerprint":"string","protocolVersion":"string"}'
GET/v1/receivers/{id}/inboxManage shared playback for the signed-in profileread
Audience
Clients · Native API
Authorization
API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID
social_get_v1_receivers_id_inbox

Parameters

NameInTypeDescription
idrequiredpathstring

Responses

200Successapplication/json

Example
{
  "grants": [
    {
      "allowedCommands": [
        "string"
      ],
      "authorizationRevision": "r12",
      "controllerDeviceId": "id_8h2k4q",
      "controllerDisplayName": "Fargo",
      "createdAt": "2026-10-18T19:30:00Z",
      "decidedAt": "2026-10-18T19:30:00Z",
      "expiresAt": "2026-10-18T19:30:00Z",
      "id": "id_8h2k4q",
      "receiverId": "id_8h2k4q",
      "receiverKeyFingerprint": "string",
      "state": "string"
    }
  ],
  "handoffs": [
    {
      "committedPositionUs": "string",
      "createdAt": "2026-10-18T19:30:00Z",
      "expiresAt": "2026-10-18T19:30:00Z",
      "grantId": "id_8h2k4q",
      "id": "id_8h2k4q",
      "itemId": "id_8h2k4q",
      "outcome": "string",
      "readyPositionUs": "string",
      "reason": "string",
      "receiverId": "id_8h2k4q",
      "receiverPlaybackId": "id_8h2k4q",
      "requestId": "id_8h2k4q",
      "requestedPositionUs": "string",
      "revision": "r12",
      "settledAt": "2026-10-18T19:30:00Z",
      "sourcePlaybackId": "id_8h2k4q",
      "sourceRetired": true,
      "state": "string"
    }
  ],
  "protocolVersion": "string",
  "receiverId": "id_8h2k4q",
  "serverTime": "2026-10-18T19:30:00Z"
}
Schema
  • grantsarray of objectrequired
    • allowedCommandsarray of stringrequired
    • authorizationRevisionstringrequired
    • controllerDeviceIdstringrequired
    • controllerDisplayNamestringrequired
    • createdAtstringrequired
    • decidedAtstring | any | nullrequired
    • expiresAtstringrequired
    • idstringrequired
    • receiverIdstringrequired
    • receiverKeyFingerprintstringrequired
    • statestringrequired
  • handoffsarray of objectrequired
    • committedPositionUsstringrequired
    • createdAtstringrequired
    • expiresAtstringrequired
    • grantIdstringrequired
    • idstringrequired
    • itemIdstringrequired
    • outcomestringrequired
    • readyPositionUsstringrequired
    • reasonstringrequired
    • receiverIdstringrequired
    • receiverPlaybackIdstringrequired
    • requestIdstringrequired
    • requestedPositionUsstringrequired
    • revisionstringrequired
    • settledAtstring | any | nullrequired
    • sourcePlaybackIdstringrequired
    • sourceRetiredbooleanrequired
    • statestringrequired
  • protocolVersionstringrequired
  • receiverIdstringrequired
  • serverTimestringrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesunauthorizednot_permittedinternalreceiver_requiredcapacity_reachedcast_access_endedcast_code_consumedcast_code_expiredcast_code_not_foundcast_code_revokedcast_device_expiredcast_device_not_foundcast_device_revokedcast_unavailabledevice_requiredentry_not_foundgrant_not_acceptedgrant_not_pendinggroup_endedgroup_fullhandoff_expiredhandoff_in_progresshandoff_not_readyhandoff_source_conflicthandoff_source_revision_conflicthandoff_state_conflicthost_requiredidempotency_key_reusedinvalid_requestinvite_consumedinvite_expiredinvite_not_foundinvite_revokedinvite_wrong_recipientmedia_no_longer_accessiblemember_not_foundmembership_revokednot_foundparticipant_incompatibleplayback_authority_unavailablequeue_fullrate_limitedreceiver_key_mismatchrevision_conflicttarget_unavailabledatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/receivers/{id}/inbox" \
  -H "Authorization: Bearer $PORTICO_API_KEY"
GET/v1/receivers/{id}/inbox/waitManage shared playback for the signed-in profileread
Audience
Clients · Native API
Authorization
API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID
social_get_v1_receivers_id_inbox_wait

Parameters

NameInTypeDescription
idrequiredpathstring
waitMsquerystring

Responses

200Successapplication/json

Example
{
  "grants": [
    {
      "allowedCommands": [
        "string"
      ],
      "authorizationRevision": "r12",
      "controllerDeviceId": "id_8h2k4q",
      "controllerDisplayName": "Fargo",
      "createdAt": "2026-10-18T19:30:00Z",
      "decidedAt": "2026-10-18T19:30:00Z",
      "expiresAt": "2026-10-18T19:30:00Z",
      "id": "id_8h2k4q",
      "receiverId": "id_8h2k4q",
      "receiverKeyFingerprint": "string",
      "state": "string"
    }
  ],
  "handoffs": [
    {
      "committedPositionUs": "string",
      "createdAt": "2026-10-18T19:30:00Z",
      "expiresAt": "2026-10-18T19:30:00Z",
      "grantId": "id_8h2k4q",
      "id": "id_8h2k4q",
      "itemId": "id_8h2k4q",
      "outcome": "string",
      "readyPositionUs": "string",
      "reason": "string",
      "receiverId": "id_8h2k4q",
      "receiverPlaybackId": "id_8h2k4q",
      "requestId": "id_8h2k4q",
      "requestedPositionUs": "string",
      "revision": "r12",
      "settledAt": "2026-10-18T19:30:00Z",
      "sourcePlaybackId": "id_8h2k4q",
      "sourceRetired": true,
      "state": "string"
    }
  ],
  "protocolVersion": "string",
  "receiverId": "id_8h2k4q",
  "serverTime": "2026-10-18T19:30:00Z"
}
Schema
  • grantsarray of objectrequired
    • allowedCommandsarray of stringrequired
    • authorizationRevisionstringrequired
    • controllerDeviceIdstringrequired
    • controllerDisplayNamestringrequired
    • createdAtstringrequired
    • decidedAtstring | any | nullrequired
    • expiresAtstringrequired
    • idstringrequired
    • receiverIdstringrequired
    • receiverKeyFingerprintstringrequired
    • statestringrequired
  • handoffsarray of objectrequired
    • committedPositionUsstringrequired
    • createdAtstringrequired
    • expiresAtstringrequired
    • grantIdstringrequired
    • idstringrequired
    • itemIdstringrequired
    • outcomestringrequired
    • readyPositionUsstringrequired
    • reasonstringrequired
    • receiverIdstringrequired
    • receiverPlaybackIdstringrequired
    • requestIdstringrequired
    • requestedPositionUsstringrequired
    • revisionstringrequired
    • settledAtstring | any | nullrequired
    • sourcePlaybackIdstringrequired
    • sourceRetiredbooleanrequired
    • statestringrequired
  • protocolVersionstringrequired
  • receiverIdstringrequired
  • serverTimestringrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesunauthorizednot_permittedinternalreceiver_requiredcapacity_reachedcast_access_endedcast_code_consumedcast_code_expiredcast_code_not_foundcast_code_revokedcast_device_expiredcast_device_not_foundcast_device_revokedcast_unavailabledevice_requiredentry_not_foundgrant_not_acceptedgrant_not_pendinggroup_endedgroup_fullhandoff_expiredhandoff_in_progresshandoff_not_readyhandoff_source_conflicthandoff_source_revision_conflicthandoff_state_conflicthost_requiredidempotency_key_reusedinvalid_requestinvite_consumedinvite_expiredinvite_not_foundinvite_revokedinvite_wrong_recipientmedia_no_longer_accessiblemember_not_foundmembership_revokednot_foundparticipant_incompatibleplayback_authority_unavailablequeue_fullrate_limitedreceiver_key_mismatchrevision_conflicttarget_unavailabledatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/receivers/{id}/inbox/wait" \
  -H "Authorization: Bearer $PORTICO_API_KEY"