/
4.1.11 Avatars

4.1.11 Avatars

Owned by Tomasz Kozierowski
Last updated: Jul 23, 2024 by Piotr Mrozek


GET v2/avatar/image

Description

Gets the avatar for the authenticated client.

Parameters

NameLocated inDescriptionRequiredExample
AuthorizationheaderAutoryzacja Basic. Please use your SIP account login and password.yesBasic aHR0cHdhdGNoOmY=
User-AgentheaderDialer identifier in the form custom-name,operating-system,application-versionyesvippie;ios;2.1.9
If-Modified-SinceheaderWhen sending If-Modified-Since, we tell the server to send only the records that have been modified since a given date.noWed, 21 Oct 2016 07:00:00 GMT

Responses

Http Status Code: 200 (OK)

Parameters

NameLocated inDescriptionExample
Content-Typeheaderfile typeimage/jpeg
Content-Lengthheaderfile size145426
Content-Dispositionheadercontains a name of the fileinline;filename=cc21854f5ed6332e54b5ec9d8fae6428dd7d1a4b.jpg
ETagheaderTODO"F945B716AED5A9402BE1F78528FE933A"
Last-ModifiedheaderDate the file was last modified.Wed, 15 Nov 2017 04:58:08 GMT
bodybody

Attachment stream


HTTP status code: 304 (Not Modified)
TODO
HTTP status code: 403 (Forbidden)
Invalid username/password.
HTTP status code: 404 (Not Found)
Avatar not found
HTTP status code: 500 (Internal Server Error)
Internal server error, contact administrator.

POST v2/avatar/image

Description

Uploading an avatar or an avatar with a thumbnail

Parameters

NameLocated inDescriptionRequiredExample
AuthorizationheaderAutoryzacja Basic. Wymagany. Please use your SIP account login and password.yesBasic aHR0cHdhdGNoOmY=
User-AgentheaderDialer identifier in the form custom-name,operating-system,application-versionyesvippie;ios;2.1.9
Content-Typeheadermultipart/form-datayesmultipart/form-data
Content-DispositionbodyAvatar and/or thumbnail file designation. For avatar form-data; name = "datafile", while for the thumbnail form-data; name = "thumbnail"yesform-data; name="datafile"; filename="file-name.jpg"
Content-Typebodyfile typeyesimage/jpeg
Content-Transfer-EncodingbodyA method of representing binary datayesbinary


curl -v -F "filename=man.png" -F "datafile=@man.png" 'https://xxxxxxxxxxx/emcd/v2/avatar/image' \

--header 'User-Agent: vippie;ios;1.2.3' \

--header 'Authorization: Basic cGlvdHIyOndpZWxraXBpb3Ry' 



Curl avatar + thumbnail:


curl -v -F "datafile=@man.png" -F "thumbnail=@man_thumbnail.png" 'https://xxxxxxxxxx/emcd/v2/avatar/image' \
--header 'User-Agent: vippie;ios;1.2.3' \
--header 'Authorization: Basic cGlvdHIyOndpZWxraXBpb3Ry' 

Responses

Http Status Code: 200 (OK)

Parameters

NameLocated inDescriptionExample
Last-ModifiedheaderDate of saving the file/files.Wed, 15 Nov 2017 04:58:08 GMT
HTTP status code: 400 (Bad Request )

The request could not be understood by the server(Incorrect parameters - one of the parameters was not provided).

HTTP status code: 403 (Forbidden)

Invalid username/password.

HTTP status code: 500 (Internal Server Error)
Internal server error, contact administrator.

DELETE v2/avatar/image

Description

deleting avatar

Parameters

NameLocated inDescriptionRequiredExample
AuthorizationheaderAutoryzacja Basic. Please use your SIP account login and password.yesBasic aHR0cHdhdGNoOmY=
User-AgentheaderDialer identifier in the form custom-name,operating-system,application-versionyesvippie;ios;2.1.9

Responses

Http Status Code: 200 (OK)

Parameters

NameLocated inDescriptionExample
Last-ModifiedheaderDate of deleting the file/files (the avatar and thumbnail are deleted).Wed, 15 Nov 2017 04:58:08 GMT
HTTP status code: 403 (Forbidden)

Invalid username/password.

HTTP status code: 404 (Not Found)

Avatar not found.

HTTP status code: 500 (Internal Server Error)
Internal server error, contact administrator.

GET v2/avatar/image-thumb

Description

Gets the thumbnail for the avatar.

Parameters

NameLocated inDescriptionRequiredExample
AuthorizationheaderAutoryzacja Basic. Please use your SIP account login and password.yesBasic aHR0cHdhdGNoOmY=
User-AgentheaderDialer identifier in the form custom-name,operating-system,application-versionyesvippie;ios;2.1.9

Responses

Http Status Code: 200 (OK)

Parameters

NameLocated inDescriptionExample
Content-Typeheaderfile typeimage/jpeg
Content-Lengthheaderfile size145426
Content-Dispositionheaderfile nameinline;filename=cc21854f5ed6332e54b5ec9d8fae6428dd7d1a4bthum.jpg
ETagheaderTODO

"F945B716AED5A9402BE1F78528FE933A"

Last-ModifiedheaderDate the file was last modified.Wed, 15 Nov 2017 04:58:08 GMT
bodybody

Attachment stream


HTTP status code: 403 (Forbidden)
Invalid username/password.
HTTP status code: 404 (Not Found)

Thumbnail not found.

HTTP status code: 500 (Internal Server Error)
Internal server error, contact administrator.

GET v2/avatars/image

Description

Downloads the avatar image for the selected user.

Parameters

NameLocated inDescriptionRequiredExample
AuthorizationheaderAutoryzacja Basic. Please use your SIP account login and password.yesBasic aHR0cHdhdGNoOmY=
User-AgentheaderDialer identifier in the form custom-name,operating-system,application-versionyesvippie;ios;2.1.9
lquery stringSIP login of the user for whom we want to download the avatar imageyesl=sipLogin

Responses

Http Status Code: 200 (OK)

Parameters

NameLocated inDescriptionExample
Content-Typeheaderfile typeimage/jpeg
Content-Lengthheaderfile size145426
Content-Dispositionheadercontains the name of the fileinline;filename=cc21854f5ed6332e54b5ec9d8fae6428dd7d1a4b.jpg
ETagheaderTODO

"F945B716AED5A9402BE1F78528FE933A"

Last-ModifiedheaderDate the file was last modified.Wed, 15 Nov 2017 04:58:08 GMT
bodybody

Attachment stream


HTTP status code: 400 (Bad Request)

The request could not be understood by the server. Reason:

  • invalid query string
HTTP status code: 403 (Forbidden)
Invalid username/password.
HTTP status code: 404 (Not Found)

Image not found.

HTTP status code: 500 (Internal Server Error)
Internal server error, contact administrator.

GET v2/avatars/image-thumb

Description

Gets an avatar thumbnail for the selected user.

Parameters

NameLocated inDescriptionRequiredExample
AuthorizationheaderAutoryzacja Basic. Please use your SIP account login and password.yesBasic aHR0cHdhdGNoOmY=
User-AgentheaderDialer identifier in the form custom-name,operating-system,application-versionyesvippie;ios;2.1.9
lquery stringSIP login of the user for whom we want to download the avatar thumbnailyesl=sipLogin

Responses

Http Status Code: 200 (OK)

Parameters

NameLocated inDescriptionExample
Content-Typeheaderfile typeimage/jpeg
Content-Lengthheaderfile size 145426
Content-Dispositionheadercontains the name of the fileinline;filename=cc21854f5ed6332e54b5ec9d8fae6428dd7d1a4bthum.jpg
ETagheaderTODO"F945B716AED5A9402BE1F78528FE933A"
Last-ModifiedheaderDate the file was last modified.Wed, 15 Nov 2017 04:58:08 GMT
bodybodyAttachment stream


>HTTP status code: 400 (Bad Request)
The request could not be understood by the server. Reason:
  • invalid query string
HTTP status code: 403 (Forbidden)
Invalid username/password.
HTTP status code: 404 (Not Found)
Thumbnail not found.
HTTP status code: 500 (Internal Server Error)
Internal server error, contact administrator.

TODO

in preparations:

GET v2/avatar/image-batch



Related content