MadelineProtoDocs/old_docs/API_docs_v45/methods/photos_uploadProfilePhoto.md

79 lines
1.9 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: photos.uploadProfilePhoto
description: Upload profile photo
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Method: photos.uploadProfilePhoto
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Upload profile photo
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes|
|caption|[string](../types/string.md) | Caption type | Yes|
|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Location | Optional|
|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [photos\_Photo](../types/photos_Photo.md)
### Can bots use this method: **NO**
### MadelineProto Example:
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2018-04-01 13:24:46 +02:00
$photos_Photo = $MadelineProto->photos->uploadProfilePhoto(['file' => InputFile, 'caption' => 'string', 'geo_point' => InputGeoPoint, 'crop' => InputPhotoCrop, ]);
2018-04-01 13:19:25 +02:00
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/photos.uploadProfilePhoto`
Parameters:
file - Json encoded InputFile
2018-04-01 13:24:46 +02:00
caption - Json encoded string
geo_point - Json encoded InputGeoPoint
crop - Json encoded InputPhotoCrop
2018-04-01 13:19:25 +02:00
Or, if you're into Lua:
```
2018-04-01 13:24:46 +02:00
photos_Photo = photos.uploadProfilePhoto({file=InputFile, caption='string', geo_point=InputGeoPoint, crop=InputPhotoCrop, })
2018-04-01 13:19:25 +02:00
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
|FILE_PARTS_INVALID|The number of file parts is invalid|
|IMAGE_PROCESS_FAILED|Failure while processing image|
|PHOTO_CROP_SIZE_SMALL|Photo is too small|
|PHOTO_EXT_INVALID|The extension of the photo is invalid|