MadelineProto/old_docs/API_docs_v25/methods/photos_uploadProfilePhoto.md

76 lines
1.9 KiB
Markdown
Raw Normal View History

---
2017-01-19 23:02:27 +01:00
title: photos.uploadProfilePhoto
description: photos.uploadProfilePhoto parameters, return type and example
---
2017-01-19 23:02:27 +01:00
## Method: photos.uploadProfilePhoto
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
|file|[InputFile](../types/InputFile.md) | Yes|
|caption|[string](../types/string.md) | Yes|
|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|
|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|
### Return type: [photos\_Photo](../types/photos_Photo.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **NO**
2017-11-03 17:39:50 +01: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|
2017-08-28 12:44:50 +02:00
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
if (isset($number)) { // Login as a user
2017-12-11 12:12:38 +01:00
$MadelineProto->phone_login($number);
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
$MadelineProto->complete_phone_login($code);
}
2017-07-23 16:33:46 +02:00
$photos_Photo = $MadelineProto->photos->uploadProfilePhoto(['file' => InputFile, 'caption' => 'string', 'geo_point' => InputGeoPoint, 'crop' => InputPhotoCrop, ]);
2017-02-13 04:33:06 +01:00
```
2017-07-24 01:32:29 +02:00
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
2017-07-23 16:11:02 +02:00
2017-07-23 16:34:36 +02:00
2017-07-23 16:11:02 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/photos.uploadProfilePhoto`
Parameters:
file - Json encoded InputFile
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
caption - Json encoded string
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
geo_point - Json encoded InputGeoPoint
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
crop - Json encoded InputPhotoCrop
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
2017-07-23 16:33:46 +02:00
photos_Photo = photos.uploadProfilePhoto({file=InputFile, caption='string', geo_point=InputGeoPoint, crop=InputPhotoCrop, })
```