call

[BETA] show call image

Shows a jpeg/png as the outgoing camera of the connected video call. The call has to be connected — one that is still ringing has no media channel and answers data.status: error with message: failed to show call image and an explanation. Note: This endpoint is currently in beta and may change without notice.

post/instances/{id}/client/action/show-call-image

Request

Base URL: https://waapi.app/api/v1
URL: https://waapi.app/api/v1/instances/{id}/client/action/show-call-image
Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

Request body

callIdstring

The call to act on. Omit to use the instance's only active call.

imageUrlstring uri required

jpeg or png shown as the outgoing camera, max 25 MB

Example request

{
  "callId": "00E61C7AAD3559F3AFC223D4E3FC1914",
  "imageUrl": "https://example.com/card.png"
}

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: an empty object.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "status": "success",
  "data": {
    "status": "success"
  }
}

Changes

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