Yahoo! Messenger Display Image API Definitions

Avatar Image Management

Avatar Image Management Address

<server>/v1/displayImage/avatar/{network}/{userId}

Avatar Image Management API
HTTP Operation Functionality Input URI Input Body Response Headers Response
HEAD Fetch the image URL only. The URL is returned using the 'X-Yahoo-msgr-imageurl' header.

-size (optional)

-format (optional)

 N/A X-Yahoo-msgr-imageurl represents the image location url. N/A
GET Fetch avatar image for userId

-size (optional)

-redirect (optional)

-format (optional)

-height (optional)

-width (optional)

 N/A X-Yahoo-msgr-imageurl represents the image location url. (image data)
Avatar Image Management Data Type Definition

The following table shows the data type definition for the Avatar Image Management API.

Attribute Data Type Description
size string

Standard image size definitions. Acceptable values include:

"medium" (default)

"full"

"small"

format string

Declares the format in which the image is requested. Acceptable values include:

"jpg"

"gif"

"png" (default)
redirect string

true = The server will respond with a HTTP 302 status containing the image URL in the response 'Content-Location' header

default = The server responds with the image data in the response body.

height, width string These two parameters should always be provided together to get image dimensions, and are valid only if the requested format is different than the image format stored on the server.
Avatar Image Management Examples

Example 3.1. 

Request

Response


Custom Image Management

Custom Image Management Address

<server>/v1/displayImage/custom/{network}/{userId}

Custom Image Management API
HTTP Operation Functionality Input URI Input Body Response Headers Response
GET Fetch custom image for userId.

-redirect (optional)

-format (optional)

-height (optional)

-width (optional)

 N/A

X-Yahoo-msgr-imageurl is the image location URL

X-Yahoo-msgr-ichecksum is the image checksum calculated by server 		(image data)
HEAD Fetch the image URL only. The URL is returned using the 'X-Yahoo-msgr-imageurl' header. Note that the target URL does not support height, width, or format changes. N/A N/A X-Yahoo-msgr-imageurl is the image URL N/A
POST Upload a new custom image. The image URL and checksum is returned in the response headers. The maximum upload limit is 50 KB. -c (image data)

X-Yahoo-msgr-imageurl is the image location URL

X-Yahoo-msgr-ichecksum is the image checksum calculated by server 		N/A
Custom Image Management Data Type Definition
Attribute Data Type Description
redirect string

true = The server will respond with a HTTP 302 status containing the image URL in the response 'Content-Location' header

default = The server responds with the image data in the response body.

format string

Declares the format in which the image is requested. Acceptable values include:

"jpg"

"gif"

"png" (default)
height, width string These two parameters should always be provided together to get image dimensions, and are valid only if the requested format is different than the image format stored on the server.
c string The crumb obtained from the Yahoo! Messenger IM SDK.
Custom Image Management Examples

Example 3.2. 

Request

Response


Example 3.3. 

Request

Response


Example 3.4. 

Request

Response


Example 3.5. 

Request

Response


Table of Contents